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

Class VodSession

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.video.stitcher.v1.VodSession
All Implemented Interfaces:
VodSessionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class VodSession extends com.google.protobuf.GeneratedMessage implements VodSessionOrBuilder
 Metadata for a VOD session. The session expires 4 hours after its creation.
Protobuf type google.cloud.video.stitcher.v1.VodSession
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • INTERSTITIALS_FIELD_NUMBER

      public static final int INTERSTITIALS_FIELD_NUMBER
      See Also:

    • PLAY_URI_FIELD_NUMBER

      public static final int PLAY_URI_FIELD_NUMBER
      See Also:

    • SOURCE_URI_FIELD_NUMBER

      public static final int SOURCE_URI_FIELD_NUMBER
      See Also:

    • AD_TAG_URI_FIELD_NUMBER

      public static final int AD_TAG_URI_FIELD_NUMBER
      See Also:

    • AD_TAG_MACRO_MAP_FIELD_NUMBER

      public static final int AD_TAG_MACRO_MAP_FIELD_NUMBER
      See Also:

    • MANIFEST_OPTIONS_FIELD_NUMBER

      public static final int MANIFEST_OPTIONS_FIELD_NUMBER
      See Also:

    • ASSET_ID_FIELD_NUMBER

      public static final int ASSET_ID_FIELD_NUMBER
      See Also:

    • AD_TRACKING_FIELD_NUMBER

      public static final int AD_TRACKING_FIELD_NUMBER
      See Also:

    • GAM_SETTINGS_FIELD_NUMBER

      public static final int GAM_SETTINGS_FIELD_NUMBER
      See Also:

    • VOD_CONFIG_FIELD_NUMBER

      public static final int VOD_CONFIG_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 VOD session, in the form of
 `projects/{project_number}/locations/{location}/vodSessions/{id}`.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getName in interface VodSessionOrBuilder
      Returns:
      The name.

    • getNameBytes

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

    • hasInterstitials

      public boolean hasInterstitials()
       Output only. Metadata of what was stitched into the content.
      .google.cloud.video.stitcher.v1.Interstitials interstitials = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasInterstitials in interface VodSessionOrBuilder
      Returns:
      Whether the interstitials field is set.

    • getInterstitials

      public Interstitials getInterstitials()
       Output only. Metadata of what was stitched into the content.
      .google.cloud.video.stitcher.v1.Interstitials interstitials = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getInterstitials in interface VodSessionOrBuilder
      Returns:
      The interstitials.

    • getInterstitialsOrBuilder

      public InterstitialsOrBuilder getInterstitialsOrBuilder()
       Output only. Metadata of what was stitched into the content.
      .google.cloud.video.stitcher.v1.Interstitials interstitials = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getInterstitialsOrBuilder in interface VodSessionOrBuilder

    • getPlayUri

      public String getPlayUri()
       Output only. The playback URI of the stitched content.
      string play_uri = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPlayUri in interface VodSessionOrBuilder
      Returns:
      The playUri.

    • getPlayUriBytes

      public com.google.protobuf.ByteString getPlayUriBytes()
       Output only. The playback URI of the stitched content.
      string play_uri = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPlayUriBytes in interface VodSessionOrBuilder
      Returns:
      The bytes for playUri.

    • getSourceUri

      public String getSourceUri()
       URI of the media to stitch. For most use cases, you should create a
 [VodConfig][google.cloud.video.stitcher.v1.VodConfig] with this information
 rather than setting this field directly.
      string source_uri = 5;
      Specified by:
      getSourceUri in interface VodSessionOrBuilder
      Returns:
      The sourceUri.

    • getSourceUriBytes

      public com.google.protobuf.ByteString getSourceUriBytes()
       URI of the media to stitch. For most use cases, you should create a
 [VodConfig][google.cloud.video.stitcher.v1.VodConfig] with this information
 rather than setting this field directly.
      string source_uri = 5;
      Specified by:
      getSourceUriBytes in interface VodSessionOrBuilder
      Returns:
      The bytes for sourceUri.

    • getAdTagUri

      public String getAdTagUri()
       Ad tag URI. For most use cases, you should create a
 [VodConfig][google.cloud.video.stitcher.v1.VodConfig] with this information
 rather than setting this field directly.
      string ad_tag_uri = 6;
      Specified by:
      getAdTagUri in interface VodSessionOrBuilder
      Returns:
      The adTagUri.

    • getAdTagUriBytes

      public com.google.protobuf.ByteString getAdTagUriBytes()
       Ad tag URI. For most use cases, you should create a
 [VodConfig][google.cloud.video.stitcher.v1.VodConfig] with this information
 rather than setting this field directly.
      string ad_tag_uri = 6;
      Specified by:
      getAdTagUriBytes in interface VodSessionOrBuilder
      Returns:
      The bytes for adTagUri.

    • getAdTagMacroMapCount

      public int getAdTagMacroMapCount()
      Description copied from interface: VodSessionOrBuilder
       Key value pairs for ad tag macro replacement, only available for VOD
 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 macro map: `{"geoId": "123"}`

 Fully qualified ad tag:
 `"https://doubleclick.google.com/ad/1?geo_id=123"`
      map<string, string> ad_tag_macro_map = 7;
      Specified by:
      getAdTagMacroMapCount in interface VodSessionOrBuilder

    • containsAdTagMacroMap

      public boolean containsAdTagMacroMap(String key)
       Key value pairs for ad tag macro replacement, only available for VOD
 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 macro map: `{"geoId": "123"}`

 Fully qualified ad tag:
 `"https://doubleclick.google.com/ad/1?geo_id=123"`
      map<string, string> ad_tag_macro_map = 7;
      Specified by:
      containsAdTagMacroMap in interface VodSessionOrBuilder

    • getAdTagMacroMap

      @Deprecated public Map<String,String> getAdTagMacroMap()
      Deprecated.
      Use getAdTagMacroMapMap() instead.
      Specified by:
      getAdTagMacroMap in interface VodSessionOrBuilder

    • getAdTagMacroMapMap

      public Map<String,String> getAdTagMacroMapMap()
       Key value pairs for ad tag macro replacement, only available for VOD
 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 macro map: `{"geoId": "123"}`

 Fully qualified ad tag:
 `"https://doubleclick.google.com/ad/1?geo_id=123"`
      map<string, string> ad_tag_macro_map = 7;
      Specified by:
      getAdTagMacroMapMap in interface VodSessionOrBuilder

    • getAdTagMacroMapOrDefault

      public String getAdTagMacroMapOrDefault(String key, String defaultValue)
       Key value pairs for ad tag macro replacement, only available for VOD
 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 macro map: `{"geoId": "123"}`

 Fully qualified ad tag:
 `"https://doubleclick.google.com/ad/1?geo_id=123"`
      map<string, string> ad_tag_macro_map = 7;
      Specified by:
      getAdTagMacroMapOrDefault in interface VodSessionOrBuilder

    • getAdTagMacroMapOrThrow

      public String getAdTagMacroMapOrThrow(String key)
       Key value pairs for ad tag macro replacement, only available for VOD
 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 macro map: `{"geoId": "123"}`

 Fully qualified ad tag:
 `"https://doubleclick.google.com/ad/1?geo_id=123"`
      map<string, string> ad_tag_macro_map = 7;
      Specified by:
      getAdTagMacroMapOrThrow in interface VodSessionOrBuilder

    • hasManifestOptions

      public boolean hasManifestOptions()
       Additional options that affect the output of the manifest.
      .google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 9;
      Specified by:
      hasManifestOptions in interface VodSessionOrBuilder
      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 = 9;
      Specified by:
      getManifestOptions in interface VodSessionOrBuilder
      Returns:
      The manifestOptions.

    • getManifestOptionsOrBuilder

      public ManifestOptionsOrBuilder getManifestOptionsOrBuilder()
       Additional options that affect the output of the manifest.
      .google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 9;
      Specified by:
      getManifestOptionsOrBuilder in interface VodSessionOrBuilder

    • getAssetId

      public String getAssetId()
       Output only. The generated ID of the VodSession's source media.
      string asset_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAssetId in interface VodSessionOrBuilder
      Returns:
      The assetId.

    • getAssetIdBytes

      public com.google.protobuf.ByteString getAssetIdBytes()
       Output only. The generated ID of the VodSession's source media.
      string asset_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAssetIdBytes in interface VodSessionOrBuilder
      Returns:
      The bytes for assetId.

    • getAdTrackingValue

      public int getAdTrackingValue()
       Required. Determines how the ad should be tracked.
      .google.cloud.video.stitcher.v1.AdTracking ad_tracking = 11 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAdTrackingValue in interface VodSessionOrBuilder
      Returns:
      The enum numeric value on the wire for adTracking.

    • getAdTracking

      public AdTracking getAdTracking()
       Required. Determines how the ad should be tracked.
      .google.cloud.video.stitcher.v1.AdTracking ad_tracking = 11 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAdTracking in interface VodSessionOrBuilder
      Returns:
      The adTracking.

    • hasGamSettings

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

    • getGamSettings

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

    • getGamSettingsOrBuilder

      public VodSession.GamSettingsOrBuilder getGamSettingsOrBuilder()
       This field should be set with appropriate values if GAM is being used for
 ads.
      .google.cloud.video.stitcher.v1.VodSession.GamSettings gam_settings = 13;
      Specified by:
      getGamSettingsOrBuilder in interface VodSessionOrBuilder

    • getVodConfig

      public String getVodConfig()
       The resource name of the VOD config for this session, in the form of
 `projects/{project}/locations/{location}/vodConfigs/{id}`.
      string vod_config = 14 [(.google.api.resource_reference) = { ... }
      Specified by:
      getVodConfig in interface VodSessionOrBuilder
      Returns:
      The vodConfig.

    • getVodConfigBytes

      public com.google.protobuf.ByteString getVodConfigBytes()
       The resource name of the VOD config for this session, in the form of
 `projects/{project}/locations/{location}/vodConfigs/{id}`.
      string vod_config = 14 [(.google.api.resource_reference) = { ... }
      Specified by:
      getVodConfigBytes in interface VodSessionOrBuilder
      Returns:
      The bytes for vodConfig.

    • 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 VodSession parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static VodSession parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static VodSession parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static VodSession parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static VodSession.Builder newBuilder()

    • newBuilder

      public static VodSession.Builder newBuilder(VodSession prototype)

    • toBuilder

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

    • newBuilderForType

      protected VodSession.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static VodSession getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<VodSession> 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 VodSession getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder