Class LiveSession.Builder (0.53.0) 

public static final class LiveSession.Builder extends GeneratedMessageV3.Builder<LiveSession.Builder> implements LiveSessionOrBuilder

Metadata for a live session. The session expires 5 minutes after the client stops fetching the session's playlists.

Protobuf type google.cloud.video.stitcher.v1.LiveSession

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > LiveSession.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public LiveSession.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
LiveSession.Builder
Overrides

build()

public LiveSession build()
Returns
Type Description
LiveSession

buildPartial()

public LiveSession buildPartial()
Returns
Type Description
LiveSession

clear()

public LiveSession.Builder clear()
Returns
Type Description
LiveSession.Builder
Overrides

clearAdTagMacros()

public LiveSession.Builder clearAdTagMacros()
Returns
Type Description
LiveSession.Builder

clearAdTracking()

public LiveSession.Builder clearAdTracking()

Determines how the ad should be tracked. This overrides the value set in the live config for this session.

.google.cloud.video.stitcher.v1.AdTracking ad_tracking = 17;

Returns
Type Description
LiveSession.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public LiveSession.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
LiveSession.Builder
Overrides

clearGamSettings()

public LiveSession.Builder clearGamSettings()

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.Builder

clearLiveConfig()

public LiveSession.Builder clearLiveConfig()

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
LiveSession.Builder

This builder for chaining.

clearManifestOptions()

public LiveSession.Builder clearManifestOptions()

Additional options that affect the output of the manifest.

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

Returns
Type Description
LiveSession.Builder

clearName()

public LiveSession.Builder clearName()

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
LiveSession.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public LiveSession.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
LiveSession.Builder
Overrides

clearPlayUri()

public LiveSession.Builder clearPlayUri()

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
LiveSession.Builder

This builder for chaining.

clone()

public LiveSession.Builder clone()
Returns
Type Description
LiveSession.Builder
Overrides

containsAdTagMacros(String key)

public boolean containsAdTagMacros(String key)

Key value pairs for ad tag macro replacement, only available for live 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 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 Map<String,String> getAdTagMacros()

Use #getAdTagMacrosMap() instead.

Returns
Type Description
Map<String,String>

getAdTagMacrosCount()

public int getAdTagMacrosCount()

Key value pairs for ad tag macro replacement, only available for live 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 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 Map<String,String> getAdTagMacrosMap()

Key value pairs for ad tag macro replacement, only available for live 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 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 String getAdTagMacrosOrDefault(String key, String defaultValue)

Key value pairs for ad tag macro replacement, only available for live 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 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 String getAdTagMacrosOrThrow(String key)

Key value pairs for ad tag macro replacement, only available for live 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 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

getAdTracking()

public AdTracking getAdTracking()

Determines how the ad should be tracked. This overrides the value set in the live config for this session.

.google.cloud.video.stitcher.v1.AdTracking ad_tracking = 17;

Returns
Type Description
AdTracking

The adTracking.

getAdTrackingValue()

public int getAdTrackingValue()

Determines how the ad should be tracked. This overrides the value set in the live config for this session.

.google.cloud.video.stitcher.v1.AdTracking ad_tracking = 17;

Returns
Type Description
int

The enum numeric value on the wire for adTracking.

getDefaultInstanceForType()

public LiveSession getDefaultInstanceForType()
Returns
Type Description
LiveSession

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getGamSettings()

public 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.

getGamSettingsBuilder()

public LiveSession.GamSettings.Builder getGamSettingsBuilder()

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.Builder

getGamSettingsOrBuilder()

public 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 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 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 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.

getManifestOptionsBuilder()

public ManifestOptions.Builder getManifestOptionsBuilder()

Additional options that affect the output of the manifest.

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

Returns
Type Description
ManifestOptions.Builder

getManifestOptionsOrBuilder()

public ManifestOptionsOrBuilder getManifestOptionsOrBuilder()

Additional options that affect the output of the manifest.

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

Returns
Type Description
ManifestOptionsOrBuilder

getMutableAdTagMacros() (deprecated)

public Map<String,String> getMutableAdTagMacros()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public 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 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 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 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(LiveSession other)

public LiveSession.Builder mergeFrom(LiveSession other)
Parameter
Name Description
other LiveSession
Returns
Type Description
LiveSession.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public LiveSession.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LiveSession.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public LiveSession.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
LiveSession.Builder
Overrides

mergeGamSettings(LiveSession.GamSettings value)

public LiveSession.Builder mergeGamSettings(LiveSession.GamSettings value)

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;

Parameter
Name Description
value LiveSession.GamSettings
Returns
Type Description
LiveSession.Builder

mergeManifestOptions(ManifestOptions value)

public LiveSession.Builder mergeManifestOptions(ManifestOptions value)

Additional options that affect the output of the manifest.

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

Parameter
Name Description
value ManifestOptions
Returns
Type Description
LiveSession.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final LiveSession.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
LiveSession.Builder
Overrides

putAdTagMacros(String key, String value)

public LiveSession.Builder putAdTagMacros(String key, String value)

Key value pairs for ad tag macro replacement, only available for live 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 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
value String
Returns
Type Description
LiveSession.Builder

putAllAdTagMacros(Map<String,String> values)

public LiveSession.Builder putAllAdTagMacros(Map<String,String> values)

Key value pairs for ad tag macro replacement, only available for live 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 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
values Map<String,String>
Returns
Type Description
LiveSession.Builder

removeAdTagMacros(String key)

public LiveSession.Builder removeAdTagMacros(String key)

Key value pairs for ad tag macro replacement, only available for live 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 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
LiveSession.Builder

setAdTracking(AdTracking value)

public LiveSession.Builder setAdTracking(AdTracking value)

Determines how the ad should be tracked. This overrides the value set in the live config for this session.

.google.cloud.video.stitcher.v1.AdTracking ad_tracking = 17;

Parameter
Name Description
value AdTracking

The adTracking to set.
Returns
Type Description
LiveSession.Builder

This builder for chaining.

setAdTrackingValue(int value)

public LiveSession.Builder setAdTrackingValue(int value)

Determines how the ad should be tracked. This overrides the value set in the live config for this session.

.google.cloud.video.stitcher.v1.AdTracking ad_tracking = 17;

Parameter
Name Description
value int

The enum numeric value on the wire for adTracking to set.
Returns
Type Description
LiveSession.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public LiveSession.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
LiveSession.Builder
Overrides

setGamSettings(LiveSession.GamSettings value)

public LiveSession.Builder setGamSettings(LiveSession.GamSettings value)

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;

Parameter
Name Description
value LiveSession.GamSettings
Returns
Type Description
LiveSession.Builder

setGamSettings(LiveSession.GamSettings.Builder builderForValue)

public LiveSession.Builder setGamSettings(LiveSession.GamSettings.Builder builderForValue)

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;

Parameter
Name Description
builderForValue LiveSession.GamSettings.Builder
Returns
Type Description
LiveSession.Builder

setLiveConfig(String value)

public LiveSession.Builder setLiveConfig(String value)

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

Parameter
Name Description
value String

The liveConfig to set.
Returns
Type Description
LiveSession.Builder

This builder for chaining.

setLiveConfigBytes(ByteString value)

public LiveSession.Builder setLiveConfigBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for liveConfig to set.
Returns
Type Description
LiveSession.Builder

This builder for chaining.

setManifestOptions(ManifestOptions value)

public LiveSession.Builder setManifestOptions(ManifestOptions value)

Additional options that affect the output of the manifest.

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

Parameter
Name Description
value ManifestOptions
Returns
Type Description
LiveSession.Builder

setManifestOptions(ManifestOptions.Builder builderForValue)

public LiveSession.Builder setManifestOptions(ManifestOptions.Builder builderForValue)

Additional options that affect the output of the manifest.

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

Parameter
Name Description
builderForValue ManifestOptions.Builder
Returns
Type Description
LiveSession.Builder

setName(String value)

public LiveSession.Builder setName(String value)

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
LiveSession.Builder

This builder for chaining.

setNameBytes(ByteString value)

public LiveSession.Builder setNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
LiveSession.Builder

This builder for chaining.

setPlayUri(String value)

public LiveSession.Builder setPlayUri(String value)

Output only. The URI to play the live session's ad-stitched stream.

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

Parameter
Name Description
value String

The playUri to set.
Returns
Type Description
LiveSession.Builder

This builder for chaining.

setPlayUriBytes(ByteString value)

public LiveSession.Builder setPlayUriBytes(ByteString value)

Output only. The URI to play the live session's ad-stitched stream.

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

Parameter
Name Description
value ByteString

The bytes for playUri to set.
Returns
Type Description
LiveSession.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public LiveSession.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
LiveSession.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final LiveSession.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
LiveSession.Builder
Overrides