Class LiveSession.GamSettings.Builder (0.83.0)

public static final class LiveSession.GamSettings.Builder extends GeneratedMessage.Builder<LiveSession.GamSettings.Builder> implements LiveSession.GamSettingsOrBuilder

Defines fields related to Google Ad Manager (GAM).

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

Static Methods

getDescriptor()

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

Methods

build()

public LiveSession.GamSettings build()
Returns
Type Description
LiveSession.GamSettings

buildPartial()

public LiveSession.GamSettings buildPartial()
Returns
Type Description
LiveSession.GamSettings

clear()

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

clearStreamId()

public LiveSession.GamSettings.Builder clearStreamId()

Required. The stream ID generated by Ad Manager. This must be set if GAM is being used for ads and the session uses client-side ad tracking.

string stream_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
LiveSession.GamSettings.Builder

This builder for chaining.

clearTargetingParameters()

public LiveSession.GamSettings.Builder clearTargetingParameters()
Returns
Type Description
LiveSession.GamSettings.Builder

containsTargetingParameters(String key)

public boolean containsTargetingParameters(String key)

Targeting parameters to send to Ad Manager to generate a stream ID. This should only be set if the session uses server-side ad tracking.

map<string, string> targeting_parameters = 4;

Parameter
Name Description
key String
Returns
Type Description
boolean

getDefaultInstanceForType()

public LiveSession.GamSettings getDefaultInstanceForType()
Returns
Type Description
LiveSession.GamSettings

getDescriptorForType()

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

getMutableTargetingParameters() (deprecated)

public Map<String,String> getMutableTargetingParameters()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getStreamId()

public String getStreamId()

Required. The stream ID generated by Ad Manager. This must be set if GAM is being used for ads and the session uses client-side ad tracking.

string stream_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The streamId.

getStreamIdBytes()

public ByteString getStreamIdBytes()

Required. The stream ID generated by Ad Manager. This must be set if GAM is being used for ads and the session uses client-side ad tracking.

string stream_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for streamId.

getTargetingParameters() (deprecated)

public Map<String,String> getTargetingParameters()
Returns
Type Description
Map<String,String>

getTargetingParametersCount()

public int getTargetingParametersCount()

Targeting parameters to send to Ad Manager to generate a stream ID. This should only be set if the session uses server-side ad tracking.

map<string, string> targeting_parameters = 4;

Returns
Type Description
int

getTargetingParametersMap()

public Map<String,String> getTargetingParametersMap()

Targeting parameters to send to Ad Manager to generate a stream ID. This should only be set if the session uses server-side ad tracking.

map<string, string> targeting_parameters = 4;

Returns
Type Description
Map<String,String>

getTargetingParametersOrDefault(String key, String defaultValue)

public String getTargetingParametersOrDefault(String key, String defaultValue)

Targeting parameters to send to Ad Manager to generate a stream ID. This should only be set if the session uses server-side ad tracking.

map<string, string> targeting_parameters = 4;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getTargetingParametersOrThrow(String key)

public String getTargetingParametersOrThrow(String key)

Targeting parameters to send to Ad Manager to generate a stream ID. This should only be set if the session uses server-side ad tracking.

map<string, string> targeting_parameters = 4;

Parameter
Name Description
key String
Returns
Type Description
String

internalGetFieldAccessorTable()

protected GeneratedMessage.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.GeneratedMessage.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.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(LiveSession.GamSettings other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

putAllTargetingParameters(Map<String,String> values)

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

Targeting parameters to send to Ad Manager to generate a stream ID. This should only be set if the session uses server-side ad tracking.

map<string, string> targeting_parameters = 4;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
LiveSession.GamSettings.Builder

putTargetingParameters(String key, String value)

public LiveSession.GamSettings.Builder putTargetingParameters(String key, String value)

Targeting parameters to send to Ad Manager to generate a stream ID. This should only be set if the session uses server-side ad tracking.

map<string, string> targeting_parameters = 4;

Parameters
Name Description
key String
value String
Returns
Type Description
LiveSession.GamSettings.Builder

removeTargetingParameters(String key)

public LiveSession.GamSettings.Builder removeTargetingParameters(String key)

Targeting parameters to send to Ad Manager to generate a stream ID. This should only be set if the session uses server-side ad tracking.

map<string, string> targeting_parameters = 4;

Parameter
Name Description
key String
Returns
Type Description
LiveSession.GamSettings.Builder

setStreamId(String value)

public LiveSession.GamSettings.Builder setStreamId(String value)

Required. The stream ID generated by Ad Manager. This must be set if GAM is being used for ads and the session uses client-side ad tracking.

string stream_id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The streamId to set.

Returns
Type Description
LiveSession.GamSettings.Builder

This builder for chaining.

setStreamIdBytes(ByteString value)

public LiveSession.GamSettings.Builder setStreamIdBytes(ByteString value)

Required. The stream ID generated by Ad Manager. This must be set if GAM is being used for ads and the session uses client-side ad tracking.

string stream_id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for streamId to set.

Returns
Type Description
LiveSession.GamSettings.Builder

This builder for chaining.