Class LiveSession

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.video.stitcher.v1.LiveSession
All Implemented Interfaces:
LiveSessionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class LiveSession extends com.google.protobuf.GeneratedMessage 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:
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Metadata for a live session.
    static final class 
    Defines fields related to Google Ad Manager (GAM).
    static interface 
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Key value pairs for ad tag macro replacement, only available for live sessions that do not implement Google Ad manager ad insertion.
    boolean
     
    Deprecated.
    int
    Key value pairs for ad tag macro replacement, only available for live sessions that do not implement Google Ad manager ad insertion.
    Key value pairs for ad tag macro replacement, only available for live sessions that do not implement Google Ad manager ad insertion.
    Key value pairs for ad tag macro replacement, only available for live sessions that do not implement Google Ad manager ad insertion.
    Key value pairs for ad tag macro replacement, only available for live sessions that do not implement Google Ad manager ad insertion.
    Determines how the ad should be tracked.
    int
    Determines how the ad should be tracked.
     
     
    static final com.google.protobuf.Descriptors.Descriptor
     
    This field should be set with appropriate values if GAM is being used for ads.
    This field should be set with appropriate values if GAM is being used for ads.
    Required.
    com.google.protobuf.ByteString
    Required.
    Additional options that affect the output of the manifest.
    Additional options that affect the output of the manifest.
    Output only.
    com.google.protobuf.ByteString
    Output only.
    com.google.protobuf.Parser<LiveSession>
     
    Output only.
    com.google.protobuf.ByteString
    Output only.
    int
     
    boolean
    This field should be set with appropriate values if GAM is being used for ads.
    int
     
    boolean
    Additional options that affect the output of the manifest.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
     
    protected com.google.protobuf.MapFieldReflectionAccessor
     
    final boolean
     
     
     
     
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
     
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(byte[] data)
     
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.ByteString data)
     
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<LiveSession>
     
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:
    • PLAY_URI_FIELD_NUMBER

      public static final int PLAY_URI_FIELD_NUMBER
      See Also:
    • AD_TAG_MACROS_FIELD_NUMBER

      public static final int AD_TAG_MACROS_FIELD_NUMBER
      See Also:
    • MANIFEST_OPTIONS_FIELD_NUMBER

      public static final int MANIFEST_OPTIONS_FIELD_NUMBER
      See Also:
    • GAM_SETTINGS_FIELD_NUMBER

      public static final int GAM_SETTINGS_FIELD_NUMBER
      See Also:
    • LIVE_CONFIG_FIELD_NUMBER

      public static final int LIVE_CONFIG_FIELD_NUMBER
      See Also:
    • AD_TRACKING_FIELD_NUMBER

      public static final int AD_TRACKING_FIELD_NUMBER
      See Also:
  • Method Details

    • getDescriptor

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

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • 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, only available for live
       sessions that do not implement Google Ad manager ad insertion. 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, only available for live
       sessions that do not implement Google Ad manager ad insertion. 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
    • getAdTagMacros

      @Deprecated public Map<String,String> getAdTagMacros()
      Deprecated.
      Use getAdTagMacrosMap() instead.
      Specified by:
      getAdTagMacros in interface LiveSessionOrBuilder
    • getAdTagMacrosMap

      public Map<String,String> getAdTagMacrosMap()
       Key value pairs for ad tag macro replacement, only available for live
       sessions that do not implement Google Ad manager ad insertion. 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, only available for live
       sessions that do not implement Google Ad manager ad insertion. 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, only available for live
       sessions that do not implement Google Ad manager ad insertion. 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.
    • getManifestOptionsOrBuilder

      public ManifestOptionsOrBuilder getManifestOptionsOrBuilder()
       Additional options that affect the output of the manifest.
       
      .google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 10;
      Specified by:
      getManifestOptionsOrBuilder in interface LiveSessionOrBuilder
    • 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.
    • getGamSettingsOrBuilder

      public LiveSession.GamSettingsOrBuilder getGamSettingsOrBuilder()
       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:
      getGamSettingsOrBuilder in interface LiveSessionOrBuilder
    • 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.
    • getAdTrackingValue

      public int getAdTrackingValue()
       Determines how the ad should be tracked. This overrides the value set in
       the live config for this session.
       
      .google.cloud.video.stitcher.v1.AdTracking ad_tracking = 17;
      Specified by:
      getAdTrackingValue in interface LiveSessionOrBuilder
      Returns:
      The enum numeric value on the wire for adTracking.
    • getAdTracking

      public AdTracking getAdTracking()
       Determines how the ad should be tracked. This overrides the value set in
       the live config for this session.
       
      .google.cloud.video.stitcher.v1.AdTracking ad_tracking = 17;
      Specified by:
      getAdTracking in interface LiveSessionOrBuilder
      Returns:
      The adTracking.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • 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.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • 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(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static LiveSession parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static LiveSession parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static LiveSession parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static LiveSession parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • 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
    • newBuilder

      public static LiveSession.Builder newBuilder()
    • newBuilder

      public static LiveSession.Builder newBuilder(LiveSession prototype)
    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • 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.GeneratedMessage
    • getDefaultInstanceForType

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