Class VodSession (0.29.0)

public final class VodSession extends GeneratedMessageV3 implements VodSessionOrBuilder

Metadata for a VOD session. The session expires 4 hours after its creation.

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

VodSessionOrBuilder
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

Static Fields

AD_TAG_MACRO_MAP_FIELD_NUMBER

public static final int AD_TAG_MACRO_MAP_FIELD_NUMBER
Field Value
TypeDescription
int

AD_TAG_URI_FIELD_NUMBER

public static final int AD_TAG_URI_FIELD_NUMBER
Field Value
TypeDescription
int

AD_TRACKING_FIELD_NUMBER

public static final int AD_TRACKING_FIELD_NUMBER
Field Value
TypeDescription
int

ASSET_ID_FIELD_NUMBER

public static final int ASSET_ID_FIELD_NUMBER
Field Value
TypeDescription
int

GAM_SETTINGS_FIELD_NUMBER

public static final int GAM_SETTINGS_FIELD_NUMBER
Field Value
TypeDescription
int

INTERSTITIALS_FIELD_NUMBER

public static final int INTERSTITIALS_FIELD_NUMBER
Field Value
TypeDescription
int

MANIFEST_OPTIONS_FIELD_NUMBER

public static final int MANIFEST_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PLAY_URI_FIELD_NUMBER

public static final int PLAY_URI_FIELD_NUMBER
Field Value
TypeDescription
int

SOURCE_URI_FIELD_NUMBER

public static final int SOURCE_URI_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static VodSession getDefaultInstance()
Returns
TypeDescription
VodSession

getDescriptor()

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

newBuilder()

public static VodSession.Builder newBuilder()
Returns
TypeDescription
VodSession.Builder

newBuilder(VodSession prototype)

public static VodSession.Builder newBuilder(VodSession prototype)
Parameter
NameDescription
prototypeVodSession
Returns
TypeDescription
VodSession.Builder

parseDelimitedFrom(InputStream input)

public static VodSession parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
VodSession
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VodSession parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VodSession
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static VodSession parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
VodSession
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static VodSession parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VodSession
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static VodSession parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
VodSession
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static VodSession parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VodSession
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static VodSession parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
VodSession
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static VodSession parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VodSession
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static VodSession parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
VodSession
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VodSession parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VodSession
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static VodSession parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
VodSession
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static VodSession parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VodSession
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<VodSession> parser()
Returns
TypeDescription
Parser<VodSession>

Methods

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

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.

getAdTracking()

public AdTracking getAdTracking()

Required. Determines how the ad should be tracked.

.google.cloud.video.stitcher.v1.AdTracking ad_tracking = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
AdTracking

The adTracking.

getAdTrackingValue()

public int getAdTrackingValue()

Required. Determines how the ad should be tracked.

.google.cloud.video.stitcher.v1.AdTracking ad_tracking = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The enum numeric value on the wire for adTracking.

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.

getDefaultInstanceForType()

public VodSession getDefaultInstanceForType()
Returns
TypeDescription
VodSession

getGamSettings()

public VodSession.GamSettings getGamSettings()

This field should be set with appropriate values if GAM is being used for ads.

.google.cloud.video.stitcher.v1.VodSession.GamSettings gam_settings = 13;

Returns
TypeDescription
VodSession.GamSettings

The gamSettings.

getGamSettingsOrBuilder()

public VodSession.GamSettingsOrBuilder getGamSettingsOrBuilder()

This field should be set with appropriate values if GAM is being used for ads.

.google.cloud.video.stitcher.v1.VodSession.GamSettings gam_settings = 13;

Returns
TypeDescription
VodSession.GamSettingsOrBuilder

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.

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.

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

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.

getParserForType()

public Parser<VodSession> getParserForType()
Returns
TypeDescription
Parser<VodSession>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.

hasGamSettings()

public boolean hasGamSettings()

This field should be set with appropriate values if GAM is being used for ads.

.google.cloud.video.stitcher.v1.VodSession.GamSettings gam_settings = 13;

Returns
TypeDescription
boolean

Whether the gamSettings field is set.

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected VodSession.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
VodSession.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException