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

Interface VodSessionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
VodSession, VodSession.Builder
@Generated public interface VodSessionOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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];
      Returns:
      The name.

    • getNameBytes

      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];
      Returns:
      The bytes for name.

    • hasInterstitials

      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];
      Returns:
      Whether the interstitials field is set.

    • getInterstitials

      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];
      Returns:
      The interstitials.

    • getInterstitialsOrBuilder

      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];

    • getPlayUri

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

    • getPlayUriBytes

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

    • getSourceUri

      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;
      Returns:
      The sourceUri.

    • getSourceUriBytes

      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;
      Returns:
      The bytes for sourceUri.

    • getAdTagUri

      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;
      Returns:
      The adTagUri.

    • getAdTagUriBytes

      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;
      Returns:
      The bytes for adTagUri.

    • getAdTagMacroMapCount

      int getAdTagMacroMapCount()
       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;

    • containsAdTagMacroMap

      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;

    • getAdTagMacroMap

      @Deprecated Map<String,String> getAdTagMacroMap()
      Deprecated.
      Use getAdTagMacroMapMap() instead.

    • getAdTagMacroMapMap

      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;

    • getAdTagMacroMapOrDefault

      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;

    • getAdTagMacroMapOrThrow

      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;

    • hasManifestOptions

      boolean hasManifestOptions()
       Additional options that affect the output of the manifest.
      .google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 9;
      Returns:
      Whether the manifestOptions field is set.

    • getManifestOptions

      ManifestOptions getManifestOptions()
       Additional options that affect the output of the manifest.
      .google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 9;
      Returns:
      The manifestOptions.

    • getManifestOptionsOrBuilder

      ManifestOptionsOrBuilder getManifestOptionsOrBuilder()
       Additional options that affect the output of the manifest.
      .google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 9;

    • getAssetId

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

    • getAssetIdBytes

      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];
      Returns:
      The bytes for assetId.

    • getAdTrackingValue

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

    • getAdTracking

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

    • hasGamSettings

      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;
      Returns:
      Whether the gamSettings field is set.

    • getGamSettings

      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;
      Returns:
      The gamSettings.

    • getGamSettingsOrBuilder

      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;

    • getVodConfig

      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) = { ... }
      Returns:
      The vodConfig.

    • getVodConfigBytes

      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) = { ... }
      Returns:
      The bytes for vodConfig.