Package com.google.cloud.video.stitcher.v1

Class LiveSession

  • All Implemented Interfaces:
    LiveSessionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class LiveSession
extends com.google.protobuf.GeneratedMessageV3
implements LiveSessionOrBuilder
     Metadata for a live session. The session expires 5 minutes after the client
 stops fetching the session's playlists.
    Protobuf type google.cloud.video.stitcher.v1.LiveSession
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Output only. The name of the live session, in the form of
 `projects/{project}/locations/{location}/liveSessions/{id}`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface LiveSessionOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The name of the live session, in the form of
 `projects/{project}/locations/{location}/liveSessions/{id}`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface LiveSessionOrBuilder
        Returns:
        The bytes for name.

      • getPlayUri

        public String getPlayUri()
         Output only. The URI to play the live session's ad-stitched stream.
        string play_uri = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPlayUri in interface LiveSessionOrBuilder
        Returns:
        The playUri.

      • getPlayUriBytes

        public com.google.protobuf.ByteString getPlayUriBytes()
         Output only. The URI to play the live session's ad-stitched stream.
        string play_uri = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPlayUriBytes in interface LiveSessionOrBuilder
        Returns:
        The bytes for playUri.

      • getAdTagMacrosCount

        public int getAdTagMacrosCount()
        Description copied from interface: LiveSessionOrBuilder
         Key value pairs for ad tag macro replacement. If the
 specified ad tag URI has macros, this field provides the mapping
 to the value that will replace the macro in the ad tag URI.
 Macros are designated by square brackets.

 For example:

   Ad tag URI: "https://doubleclick.google.com/ad/1?geo_id=[geoId]"

   Ad tag macros: `{"geoId": "123"}`

   Fully qualified ad tag:
   `"https://doubleclick.google.com/ad/1?geo_id=123"`
        map<string, string> ad_tag_macros = 6;
        Specified by:
        getAdTagMacrosCount in interface LiveSessionOrBuilder

      • containsAdTagMacros

        public boolean containsAdTagMacros​(String key)
         Key value pairs for ad tag macro replacement. If the
 specified ad tag URI has macros, this field provides the mapping
 to the value that will replace the macro in the ad tag URI.
 Macros are designated by square brackets.

 For example:

   Ad tag URI: "https://doubleclick.google.com/ad/1?geo_id=[geoId]"

   Ad tag macros: `{"geoId": "123"}`

   Fully qualified ad tag:
   `"https://doubleclick.google.com/ad/1?geo_id=123"`
        map<string, string> ad_tag_macros = 6;
        Specified by:
        containsAdTagMacros in interface LiveSessionOrBuilder

      • getAdTagMacrosMap

        public Map<String,​String> getAdTagMacrosMap()
         Key value pairs for ad tag macro replacement. If the
 specified ad tag URI has macros, this field provides the mapping
 to the value that will replace the macro in the ad tag URI.
 Macros are designated by square brackets.

 For example:

   Ad tag URI: "https://doubleclick.google.com/ad/1?geo_id=[geoId]"

   Ad tag macros: `{"geoId": "123"}`

   Fully qualified ad tag:
   `"https://doubleclick.google.com/ad/1?geo_id=123"`
        map<string, string> ad_tag_macros = 6;
        Specified by:
        getAdTagMacrosMap in interface LiveSessionOrBuilder

      • getAdTagMacrosOrDefault

        public String getAdTagMacrosOrDefault​(String key,
                                      String defaultValue)
         Key value pairs for ad tag macro replacement. If the
 specified ad tag URI has macros, this field provides the mapping
 to the value that will replace the macro in the ad tag URI.
 Macros are designated by square brackets.

 For example:

   Ad tag URI: "https://doubleclick.google.com/ad/1?geo_id=[geoId]"

   Ad tag macros: `{"geoId": "123"}`

   Fully qualified ad tag:
   `"https://doubleclick.google.com/ad/1?geo_id=123"`
        map<string, string> ad_tag_macros = 6;
        Specified by:
        getAdTagMacrosOrDefault in interface LiveSessionOrBuilder

      • getAdTagMacrosOrThrow

        public String getAdTagMacrosOrThrow​(String key)
         Key value pairs for ad tag macro replacement. If the
 specified ad tag URI has macros, this field provides the mapping
 to the value that will replace the macro in the ad tag URI.
 Macros are designated by square brackets.

 For example:

   Ad tag URI: "https://doubleclick.google.com/ad/1?geo_id=[geoId]"

   Ad tag macros: `{"geoId": "123"}`

   Fully qualified ad tag:
   `"https://doubleclick.google.com/ad/1?geo_id=123"`
        map<string, string> ad_tag_macros = 6;
        Specified by:
        getAdTagMacrosOrThrow in interface LiveSessionOrBuilder

      • hasManifestOptions

        public boolean hasManifestOptions()
         Additional options that affect the output of the manifest.
        .google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 10;
        Specified by:
        hasManifestOptions in interface LiveSessionOrBuilder
        Returns:
        Whether the manifestOptions field is set.

      • getManifestOptions

        public ManifestOptions getManifestOptions()
         Additional options that affect the output of the manifest.
        .google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 10;
        Specified by:
        getManifestOptions in interface LiveSessionOrBuilder
        Returns:
        The manifestOptions.

      • hasGamSettings

        public boolean hasGamSettings()
         This field should be set with appropriate values if GAM is being used for
 ads.
        .google.cloud.video.stitcher.v1.LiveSession.GamSettings gam_settings = 15;
        Specified by:
        hasGamSettings in interface LiveSessionOrBuilder
        Returns:
        Whether the gamSettings field is set.

      • getGamSettings

        public LiveSession.GamSettings getGamSettings()
         This field should be set with appropriate values if GAM is being used for
 ads.
        .google.cloud.video.stitcher.v1.LiveSession.GamSettings gam_settings = 15;
        Specified by:
        getGamSettings in interface LiveSessionOrBuilder
        Returns:
        The gamSettings.

      • getLiveConfig

        public String getLiveConfig()
         Required. The resource name of the live config for this session, in the
 form of `projects/{project}/locations/{location}/liveConfigs/{id}`.
        string live_config = 16 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getLiveConfig in interface LiveSessionOrBuilder
        Returns:
        The liveConfig.

      • getLiveConfigBytes

        public com.google.protobuf.ByteString getLiveConfigBytes()
         Required. The resource name of the live config for this session, in the
 form of `projects/{project}/locations/{location}/liveConfigs/{id}`.
        string live_config = 16 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getLiveConfigBytes in interface LiveSessionOrBuilder
        Returns:
        The bytes for liveConfig.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static LiveSession parseFrom​(ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LiveSession parseFrom​(ByteBuffer data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LiveSession parseFrom​(com.google.protobuf.ByteString data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LiveSession parseFrom​(com.google.protobuf.ByteString data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LiveSession parseFrom​(byte[] data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LiveSession parseFrom​(byte[] data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LiveSession parseFrom​(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException
        Throws:
        IOException

      • newBuilderForType

        public LiveSession.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public LiveSession.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected LiveSession.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static LiveSession getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<LiveSession> parser()

      • getParserForType

        public com.google.protobuf.Parser<LiveSession> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public LiveSession getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder