Class VodSession.Builder (0.17.0)

public static final class VodSession.Builder extends GeneratedMessageV3.Builder<VodSession.Builder> implements VodSessionOrBuilder

Metadata for a VOD session.

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

Implements

VodSessionOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public VodSession.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
VodSession.Builder
Overrides

build()

public VodSession build()
Returns
TypeDescription
VodSession

buildPartial()

public VodSession buildPartial()
Returns
TypeDescription
VodSession

clear()

public VodSession.Builder clear()
Returns
TypeDescription
VodSession.Builder
Overrides

clearAdTagMacroMap()

public VodSession.Builder clearAdTagMacroMap()
Returns
TypeDescription
VodSession.Builder

clearAdTagUri()

public VodSession.Builder clearAdTagUri()

Required. Ad tag URI.

string ad_tag_uri = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
VodSession.Builder

This builder for chaining.

clearAssetId()

public VodSession.Builder clearAssetId()

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

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

Returns
TypeDescription
VodSession.Builder

This builder for chaining.

clearClientAdTracking()

public VodSession.Builder clearClientAdTracking()

Indicates whether client side ad tracking is enabled. If client side ad tracking is enabled, then the client player is expected to trigger playback and activity events itself. If this is set to false, server side ad tracking is enabled, causing the Video Stitcher service will trigger playback events on behalf of the client player.

bool client_ad_tracking = 8;

Returns
TypeDescription
VodSession.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public VodSession.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
VodSession.Builder
Overrides

clearInterstitials()

public VodSession.Builder clearInterstitials()

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

clearManifestOptions()

public VodSession.Builder clearManifestOptions()

Additional options that affect the output of the manifest.

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

Returns
TypeDescription
VodSession.Builder

clearName()

public VodSession.Builder clearName()

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public VodSession.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
VodSession.Builder
Overrides

clearPlayUri()

public VodSession.Builder clearPlayUri()

Output only. The playback URI of the stitched content.

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

Returns
TypeDescription
VodSession.Builder

This builder for chaining.

clearSourceUri()

public VodSession.Builder clearSourceUri()

Required. URI of the media to stitch.

string source_uri = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
VodSession.Builder

This builder for chaining.

clone()

public VodSession.Builder clone()
Returns
TypeDescription
VodSession.Builder
Overrides

containsAdTagMacroMap(String key)

public boolean containsAdTagMacroMap(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 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
NameDescription
keyString
Returns
TypeDescription
boolean

getAdTagMacroMap()

public Map<String,String> getAdTagMacroMap()
Returns
TypeDescription
Map<String,String>

getAdTagMacroMapCount()

public int getAdTagMacroMapCount()

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 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
TypeDescription
int

getAdTagMacroMapMap()

public Map<String,String> getAdTagMacroMapMap()

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 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
TypeDescription
Map<String,String>

getAdTagMacroMapOrDefault(String key, String defaultValue)

public String getAdTagMacroMapOrDefault(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 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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getAdTagMacroMapOrThrow(String key)

public String getAdTagMacroMapOrThrow(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 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
NameDescription
keyString
Returns
TypeDescription
String

getAdTagUri()

public String getAdTagUri()

Required. Ad tag URI.

string ad_tag_uri = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The adTagUri.

getAdTagUriBytes()

public ByteString getAdTagUriBytes()

Required. Ad tag URI.

string ad_tag_uri = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for adTagUri.

getAssetId()

public String getAssetId()

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

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

Returns
TypeDescription
String

The assetId.

getAssetIdBytes()

public ByteString getAssetIdBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for assetId.

getClientAdTracking()

public boolean getClientAdTracking()

Indicates whether client side ad tracking is enabled. If client side ad tracking is enabled, then the client player is expected to trigger playback and activity events itself. If this is set to false, server side ad tracking is enabled, causing the Video Stitcher service will trigger playback events on behalf of the client player.

bool client_ad_tracking = 8;

Returns
TypeDescription
boolean

The clientAdTracking.

getDefaultInstanceForType()

public VodSession getDefaultInstanceForType()
Returns
TypeDescription
VodSession

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getInterstitials()

public 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
TypeDescription
Interstitials

The interstitials.

getInterstitialsBuilder()

public Interstitials.Builder getInterstitialsBuilder()

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

getInterstitialsOrBuilder()

public 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
TypeDescription
InterstitialsOrBuilder

getManifestOptions()

public ManifestOptions getManifestOptions()

Additional options that affect the output of the manifest.

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

Returns
TypeDescription
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 = 9;

Returns
TypeDescription
ManifestOptions.Builder

getManifestOptionsOrBuilder()

public ManifestOptionsOrBuilder getManifestOptionsOrBuilder()

Additional options that affect the output of the manifest.

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

Returns
TypeDescription
ManifestOptionsOrBuilder

getMutableAdTagMacroMap()

public Map<String,String> getMutableAdTagMacroMap()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getName()

public 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
TypeDescription
String

The name.

getNameBytes()

public 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
TypeDescription
ByteString

The bytes for name.

getPlayUri()

public String getPlayUri()

Output only. The playback URI of the stitched content.

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

Returns
TypeDescription
String

The playUri.

getPlayUriBytes()

public ByteString getPlayUriBytes()

Output only. The playback URI of the stitched content.

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

Returns
TypeDescription
ByteString

The bytes for playUri.

getSourceUri()

public String getSourceUri()

Required. URI of the media to stitch.

string source_uri = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The sourceUri.

getSourceUriBytes()

public ByteString getSourceUriBytes()

Required. URI of the media to stitch.

string source_uri = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for sourceUri.

hasInterstitials()

public 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
TypeDescription
boolean

Whether the interstitials field is set.

hasManifestOptions()

public boolean hasManifestOptions()

Additional options that affect the output of the manifest.

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

Returns
TypeDescription
boolean

Whether the manifestOptions field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(VodSession other)

public VodSession.Builder mergeFrom(VodSession other)
Parameter
NameDescription
otherVodSession
Returns
TypeDescription
VodSession.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public VodSession.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VodSession.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public VodSession.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
VodSession.Builder
Overrides

mergeInterstitials(Interstitials value)

public VodSession.Builder mergeInterstitials(Interstitials value)

Output only. Metadata of what was stitched into the content.

.google.cloud.video.stitcher.v1.Interstitials interstitials = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueInterstitials
Returns
TypeDescription
VodSession.Builder

mergeManifestOptions(ManifestOptions value)

public VodSession.Builder mergeManifestOptions(ManifestOptions value)

Additional options that affect the output of the manifest.

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

Parameter
NameDescription
valueManifestOptions
Returns
TypeDescription
VodSession.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final VodSession.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
VodSession.Builder
Overrides

putAdTagMacroMap(String key, String value)

public VodSession.Builder putAdTagMacroMap(String key, String value)

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 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
NameDescription
keyString
valueString
Returns
TypeDescription
VodSession.Builder

putAllAdTagMacroMap(Map<String,String> values)

public VodSession.Builder putAllAdTagMacroMap(Map<String,String> values)

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 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
NameDescription
valuesMap<String,String>
Returns
TypeDescription
VodSession.Builder

removeAdTagMacroMap(String key)

public VodSession.Builder removeAdTagMacroMap(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 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
NameDescription
keyString
Returns
TypeDescription
VodSession.Builder

setAdTagUri(String value)

public VodSession.Builder setAdTagUri(String value)

Required. Ad tag URI.

string ad_tag_uri = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueString

The adTagUri to set.

Returns
TypeDescription
VodSession.Builder

This builder for chaining.

setAdTagUriBytes(ByteString value)

public VodSession.Builder setAdTagUriBytes(ByteString value)

Required. Ad tag URI.

string ad_tag_uri = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueByteString

The bytes for adTagUri to set.

Returns
TypeDescription
VodSession.Builder

This builder for chaining.

setAssetId(String value)

public VodSession.Builder setAssetId(String value)

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

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

Parameter
NameDescription
valueString

The assetId to set.

Returns
TypeDescription
VodSession.Builder

This builder for chaining.

setAssetIdBytes(ByteString value)

public VodSession.Builder setAssetIdBytes(ByteString value)

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

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

Parameter
NameDescription
valueByteString

The bytes for assetId to set.

Returns
TypeDescription
VodSession.Builder

This builder for chaining.

setClientAdTracking(boolean value)

public VodSession.Builder setClientAdTracking(boolean value)

Indicates whether client side ad tracking is enabled. If client side ad tracking is enabled, then the client player is expected to trigger playback and activity events itself. If this is set to false, server side ad tracking is enabled, causing the Video Stitcher service will trigger playback events on behalf of the client player.

bool client_ad_tracking = 8;

Parameter
NameDescription
valueboolean

The clientAdTracking to set.

Returns
TypeDescription
VodSession.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public VodSession.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
VodSession.Builder
Overrides

setInterstitials(Interstitials value)

public VodSession.Builder setInterstitials(Interstitials value)

Output only. Metadata of what was stitched into the content.

.google.cloud.video.stitcher.v1.Interstitials interstitials = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueInterstitials
Returns
TypeDescription
VodSession.Builder

setInterstitials(Interstitials.Builder builderForValue)

public VodSession.Builder setInterstitials(Interstitials.Builder builderForValue)

Output only. Metadata of what was stitched into the content.

.google.cloud.video.stitcher.v1.Interstitials interstitials = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueInterstitials.Builder
Returns
TypeDescription
VodSession.Builder

setManifestOptions(ManifestOptions value)

public VodSession.Builder setManifestOptions(ManifestOptions value)

Additional options that affect the output of the manifest.

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

Parameter
NameDescription
valueManifestOptions
Returns
TypeDescription
VodSession.Builder

setManifestOptions(ManifestOptions.Builder builderForValue)

public VodSession.Builder setManifestOptions(ManifestOptions.Builder builderForValue)

Additional options that affect the output of the manifest.

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

Parameter
NameDescription
builderForValueManifestOptions.Builder
Returns
TypeDescription
VodSession.Builder

setName(String value)

public VodSession.Builder setName(String value)

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

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
VodSession.Builder

This builder for chaining.

setNameBytes(ByteString value)

public VodSession.Builder setNameBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
VodSession.Builder

This builder for chaining.

setPlayUri(String value)

public VodSession.Builder setPlayUri(String value)

Output only. The playback URI of the stitched content.

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

Parameter
NameDescription
valueString

The playUri to set.

Returns
TypeDescription
VodSession.Builder

This builder for chaining.

setPlayUriBytes(ByteString value)

public VodSession.Builder setPlayUriBytes(ByteString value)

Output only. The playback URI of the stitched content.

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

Parameter
NameDescription
valueByteString

The bytes for playUri to set.

Returns
TypeDescription
VodSession.Builder

This builder for chaining.

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

public VodSession.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
VodSession.Builder
Overrides

setSourceUri(String value)

public VodSession.Builder setSourceUri(String value)

Required. URI of the media to stitch.

string source_uri = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueString

The sourceUri to set.

Returns
TypeDescription
VodSession.Builder

This builder for chaining.

setSourceUriBytes(ByteString value)

public VodSession.Builder setSourceUriBytes(ByteString value)

Required. URI of the media to stitch.

string source_uri = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueByteString

The bytes for sourceUri to set.

Returns
TypeDescription
VodSession.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final VodSession.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
VodSession.Builder
Overrides