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

Interface LiveSessionOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

LiveSession, LiveSession.Builder

public interface LiveSessionOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method	Description
boolean	containsAdTagMacros(String key)	Key value pairs for ad tag macro replacement.
Map<String,String>	getAdTagMacros()	Deprecated.
int	getAdTagMacrosCount()	Key value pairs for ad tag macro replacement.
Map<String,String>	getAdTagMacrosMap()	Key value pairs for ad tag macro replacement.
String	getAdTagMacrosOrDefault(String key, String defaultValue)	Key value pairs for ad tag macro replacement.
String	getAdTagMacrosOrThrow(String key)	Key value pairs for ad tag macro replacement.
LiveSession.GamSettings	getGamSettings()	This field should be set with appropriate values if GAM is being used for ads.
LiveSession.GamSettingsOrBuilder	getGamSettingsOrBuilder()	This field should be set with appropriate values if GAM is being used for ads.
String	getLiveConfig()	Required.
com.google.protobuf.ByteString	getLiveConfigBytes()	Required.
ManifestOptions	getManifestOptions()	Additional options that affect the output of the manifest.
ManifestOptionsOrBuilder	getManifestOptionsOrBuilder()	Additional options that affect the output of the manifest.
String	getName()	Output only.
com.google.protobuf.ByteString	getNameBytes()	Output only.
String	getPlayUri()	Output only.
com.google.protobuf.ByteString	getPlayUriBytes()	Output only.
boolean	hasGamSettings()	This field should be set with appropriate values if GAM is being used for ads.
boolean	hasManifestOptions()	Additional options that affect the output of the manifest.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Detail

getName

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:

The name.

getNameBytes

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

Returns:

The bytes for name.

getPlayUri

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:

The playUri.

getPlayUriBytes

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

Returns:

The bytes for playUri.

getAdTagMacrosCount

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;

containsAdTagMacros

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;

getAdTagMacros

@Deprecated
Map<String,String> getAdTagMacros()

Deprecated.

Use getAdTagMacrosMap() instead.

getAdTagMacrosMap

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;

getAdTagMacrosOrDefault

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;

getAdTagMacrosOrThrow

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;

hasManifestOptions

boolean hasManifestOptions()

 Additional options that affect the output of the manifest.
 

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

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

Returns:

The manifestOptions.

getManifestOptionsOrBuilder

ManifestOptionsOrBuilder getManifestOptionsOrBuilder()

 Additional options that affect the output of the manifest.
 

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

hasGamSettings

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:

Whether the gamSettings field is set.

getGamSettings

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:

The gamSettings.

getGamSettingsOrBuilder

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;

getLiveConfig

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:

The liveConfig.

getLiveConfigBytes

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

Returns:

The bytes for liveConfig.