Interface VodSessionOrBuilder (0.46.0) 

public interface VodSessionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAdTagMacroMap(String key)

public abstract 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;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAdTagMacroMap() (deprecated)

public abstract Map<String,String> getAdTagMacroMap()

Use #getAdTagMacroMapMap() instead.

Returns
Type Description
Map<String,String>

getAdTagMacroMapCount()

public abstract 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;

Returns
Type Description
int

getAdTagMacroMapMap()

public abstract 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;

Returns
Type Description
Map<String,String>

getAdTagMacroMapOrDefault(String key, String defaultValue)

public abstract 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;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getAdTagMacroMapOrThrow(String key)

public abstract 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;

Parameter
Name Description
key String
Returns
Type Description
String

getAdTagUri()

public abstract String getAdTagUri()

Ad tag URI. For most use cases, you should create a VodConfig with this information rather than setting this field directly.

string ad_tag_uri = 6;

Returns
Type Description
String

The adTagUri.

getAdTagUriBytes()

public abstract ByteString getAdTagUriBytes()

Ad tag URI. For most use cases, you should create a VodConfig with this information rather than setting this field directly.

string ad_tag_uri = 6;

Returns
Type Description
ByteString

The bytes for adTagUri.

getAdTracking()

public abstract 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
Type Description
AdTracking

The adTracking.

getAdTrackingValue()

public abstract 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
Type Description
int

The enum numeric value on the wire for adTracking.

getAssetId()

public abstract String getAssetId()

Output only. The generated ID of the VodSession's source media.

string asset_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The assetId.

getAssetIdBytes()

public abstract ByteString getAssetIdBytes()

Output only. The generated ID of the VodSession's source media.

string asset_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for assetId.

getGamSettings()

public abstract 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
Type Description
VodSession.GamSettings

The gamSettings.

getGamSettingsOrBuilder()

public abstract 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;

Returns
Type Description
VodSession.GamSettingsOrBuilder

getInterstitials()

public abstract 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
Type Description
Interstitials

The interstitials.

getInterstitialsOrBuilder()

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

Returns
Type Description
InterstitialsOrBuilder

getManifestOptions()

public abstract ManifestOptions getManifestOptions()

Additional options that affect the output of the manifest.

.google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 9;

Returns
Type Description
ManifestOptions

The manifestOptions.

getManifestOptionsOrBuilder()

public abstract ManifestOptionsOrBuilder getManifestOptionsOrBuilder()

Additional options that affect the output of the manifest.

.google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 9;

Returns
Type Description
ManifestOptionsOrBuilder

getName()

public abstract 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
Type Description
String

The name.

getNameBytes()

public abstract 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
Type Description
ByteString

The bytes for name.

getPlayUri()

public abstract String getPlayUri()

Output only. The playback URI of the stitched content.

string play_uri = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The playUri.

getPlayUriBytes()

public abstract ByteString getPlayUriBytes()

Output only. The playback URI of the stitched content.

string play_uri = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for playUri.

getSourceUri()

public abstract String getSourceUri()

URI of the media to stitch. For most use cases, you should create a VodConfig with this information rather than setting this field directly.

string source_uri = 5;

Returns
Type Description
String

The sourceUri.

getSourceUriBytes()

public abstract ByteString getSourceUriBytes()

URI of the media to stitch. For most use cases, you should create a VodConfig with this information rather than setting this field directly.

string source_uri = 5;

Returns
Type Description
ByteString

The bytes for sourceUri.

getVodConfig()

public abstract 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
Type Description
String

The vodConfig.

getVodConfigBytes()

public abstract 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
Type Description
ByteString

The bytes for vodConfig.

hasGamSettings()

public abstract 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
Type Description
boolean

Whether the gamSettings field is set.

hasInterstitials()

public abstract 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
Type Description
boolean

Whether the interstitials field is set.

hasManifestOptions()

public abstract boolean hasManifestOptions()

Additional options that affect the output of the manifest.

.google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 9;

Returns
Type Description
boolean

Whether the manifestOptions field is set.