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
Inherited Members
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>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
AD_TAG_MACRO_MAP_FIELD_NUMBER
public static final int AD_TAG_MACRO_MAP_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
AD_TAG_URI_FIELD_NUMBER
public static final int AD_TAG_URI_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
AD_TRACKING_FIELD_NUMBER
public static final int AD_TRACKING_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ASSET_ID_FIELD_NUMBER
public static final int ASSET_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
GAM_SETTINGS_FIELD_NUMBER
public static final int GAM_SETTINGS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
INTERSTITIALS_FIELD_NUMBER
public static final int INTERSTITIALS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MANIFEST_OPTIONS_FIELD_NUMBER
public static final int MANIFEST_OPTIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PLAY_URI_FIELD_NUMBER
public static final int PLAY_URI_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SOURCE_URI_FIELD_NUMBER
public static final int SOURCE_URI_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
VOD_CONFIG_FIELD_NUMBER
public static final int VOD_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static VodSession getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static VodSession.Builder newBuilder()
newBuilder(VodSession prototype)
public static VodSession.Builder newBuilder(VodSession prototype)
public static VodSession parseDelimitedFrom(InputStream input)
public static VodSession parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static VodSession parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static VodSession parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static VodSession parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static VodSession parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static VodSession parseFrom(CodedInputStream input)
public static VodSession parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static VodSession parseFrom(InputStream input)
public static VodSession parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static VodSession parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static VodSession parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<VodSession> parser()
Methods
containsAdTagMacroMap(String key)
public boolean containsAdTagMacroMap(String key)
Key value pairs for ad tag macro replacement, only available for VOD
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 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 |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAdTagMacroMap() (deprecated)
public Map<String,String> getAdTagMacroMap()
getAdTagMacroMapCount()
public int getAdTagMacroMapCount()
Key value pairs for ad tag macro replacement, only available for VOD
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 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 |
| Type |
Description |
int |
|
getAdTagMacroMapMap()
public Map<String,String> getAdTagMacroMapMap()
Key value pairs for ad tag macro replacement, only available for VOD
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 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;
getAdTagMacroMapOrDefault(String key, String defaultValue)
public String getAdTagMacroMapOrDefault(String key, String defaultValue)
Key value pairs for ad tag macro replacement, only available for VOD
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 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 |
| Type |
Description |
String |
|
getAdTagMacroMapOrThrow(String key)
public String getAdTagMacroMapOrThrow(String key)
Key value pairs for ad tag macro replacement, only available for VOD
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 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 |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
getAdTagUri()
public String getAdTagUri()
Ad tag URI. For most use cases, you should create a
VodConfig with this information
rather than setting this field directly.
string ad_tag_uri = 6;
| Returns |
| Type |
Description |
String |
The adTagUri.
|
getAdTagUriBytes()
public ByteString getAdTagUriBytes()
Ad tag URI. For most use cases, you should create a
VodConfig with this information
rather than setting this field directly.
string ad_tag_uri = 6;
| Returns |
| Type |
Description |
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 |
| Type |
Description |
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 |
| Type |
Description |
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 |
| Type |
Description |
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 |
| Type |
Description |
ByteString |
The bytes for assetId.
|
getDefaultInstanceForType()
public VodSession getDefaultInstanceForType()
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;
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;
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];
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];
getManifestOptions()
public ManifestOptions getManifestOptions()
Additional options that affect the output of the manifest.
.google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 9;
getManifestOptionsOrBuilder()
public ManifestOptionsOrBuilder getManifestOptionsOrBuilder()
Additional options that affect the output of the manifest.
.google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 9;
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 |
| Type |
Description |
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 |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<VodSession> getParserForType()
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 |
| Type |
Description |
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 |
| Type |
Description |
ByteString |
The bytes for playUri.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSourceUri()
public String getSourceUri()
URI of the media to stitch. For most use cases, you should create a
VodConfig with this information
rather than setting this field directly.
string source_uri = 5;
| Returns |
| Type |
Description |
String |
The sourceUri.
|
getSourceUriBytes()
public ByteString getSourceUriBytes()
URI of the media to stitch. For most use cases, you should create a
VodConfig with this information
rather than setting this field directly.
string source_uri = 5;
| Returns |
| Type |
Description |
ByteString |
The bytes for sourceUri.
|
getVodConfig()
public String getVodConfig()
The resource name of the VOD config for this session, in the form of
projects/{project}/locations/{location}/vodConfigs/{id}.
string vod_config = 14 [(.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The vodConfig.
|
getVodConfigBytes()
public ByteString getVodConfigBytes()
The resource name of the VOD config for this session, in the form of
projects/{project}/locations/{location}/vodConfigs/{id}.
string vod_config = 14 [(.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for vodConfig.
|
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 |
| Type |
Description |
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 |
| Type |
Description |
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 |
| Type |
Description |
boolean |
Whether the manifestOptions field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
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.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public VodSession.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected VodSession.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public VodSession.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
