Interface LiveSessionOrBuilder (0.43.0) 

public interface LiveSessionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAdTagMacros(String key)

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

Parameter
Name Description
key String
Returns
Type Description
boolean

getAdTagMacros() (deprecated)

public abstract Map<String,String> getAdTagMacros()

Use #getAdTagMacrosMap() instead.

Returns
Type Description
Map<String,String>

getAdTagMacrosCount()

public abstract int getAdTagMacrosCount()

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;

Returns
Type Description
int

getAdTagMacrosMap()

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

Returns
Type Description
Map<String,String>

getAdTagMacrosOrDefault(String key, String defaultValue)

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

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getAdTagMacrosOrThrow(String key)

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

Parameter
Name Description
key String
Returns
Type Description
String

getGamSettings()

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

Returns
Type Description
LiveSession.GamSettings

The gamSettings.

getGamSettingsOrBuilder()

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

Returns
Type Description
LiveSession.GamSettingsOrBuilder

getLiveConfig()

public abstract 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) = { ... }

Returns
Type Description
String

The liveConfig.

getLiveConfigBytes()

public abstract 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) = { ... }

Returns
Type Description
ByteString

The bytes for liveConfig.

getManifestOptions()

public abstract ManifestOptions getManifestOptions()

Additional options that affect the output of the manifest.

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

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 = 10;

Returns
Type Description
ManifestOptionsOrBuilder

getName()

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

Returns
Type Description
String

The name.

getNameBytes()

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

Returns
Type Description
ByteString

The bytes for name.

getPlayUri()

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

Returns
Type Description
String

The playUri.

getPlayUriBytes()

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

Returns
Type Description
ByteString

The bytes for playUri.

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.LiveSession.GamSettings gam_settings = 15;

Returns
Type Description
boolean

Whether the gamSettings 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 = 10;

Returns
Type Description
boolean

Whether the manifestOptions field is set.