Package com.google.cloud.video.stitcher.v1

Interface VodSessionOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

VodSession, VodSession.Builder

public interface VodSessionOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method	Description
boolean	containsAdTagMacroMap(String key)	Key value pairs for ad tag macro replacement.
Map<String,String>	getAdTagMacroMap()	Deprecated.
int	getAdTagMacroMapCount()	Key value pairs for ad tag macro replacement.
Map<String,String>	getAdTagMacroMapMap()	Key value pairs for ad tag macro replacement.
String	getAdTagMacroMapOrDefault(String key, String defaultValue)	Key value pairs for ad tag macro replacement.
String	getAdTagMacroMapOrThrow(String key)	Key value pairs for ad tag macro replacement.
String	getAdTagUri()	Required.
com.google.protobuf.ByteString	getAdTagUriBytes()	Required.
AdTracking	getAdTracking()	Required.
int	getAdTrackingValue()	Required.
String	getAssetId()	Output only.
com.google.protobuf.ByteString	getAssetIdBytes()	Output only.
VodSession.GamSettings	getGamSettings()	This field should be set with appropriate values if GAM is being used for ads.
VodSession.GamSettingsOrBuilder	getGamSettingsOrBuilder()	This field should be set with appropriate values if GAM is being used for ads.
Interstitials	getInterstitials()	Output only.
InterstitialsOrBuilder	getInterstitialsOrBuilder()	Output only.
ManifestOptions	getManifestOptions()	Additional options that affect the output of the manifest.
ManifestOptionsOrBuilder	getManifestOptionsOrBuilder()	Additional options that affect the output of the manifest.
String	getName()	Output only.
com.google.protobuf.ByteString	getNameBytes()	Output only.
String	getPlayUri()	Output only.
com.google.protobuf.ByteString	getPlayUriBytes()	Output only.
String	getSourceUri()	Required.
com.google.protobuf.ByteString	getSourceUriBytes()	Required.
boolean	hasGamSettings()	This field should be set with appropriate values if GAM is being used for ads.
boolean	hasInterstitials()	Output only.
boolean	hasManifestOptions()	Additional options that affect the output of the manifest.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Detail

getName

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:

The name.

getNameBytes

com.google.protobuf.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:

The bytes for name.

hasInterstitials

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:

Whether the interstitials field is set.

getInterstitials

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:

The interstitials.

getInterstitialsOrBuilder

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

getPlayUri

String getPlayUri()

 Output only. The playback URI of the stitched content.
 

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

Returns:

The playUri.

getPlayUriBytes

com.google.protobuf.ByteString getPlayUriBytes()

 Output only. The playback URI of the stitched content.
 

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

Returns:

The bytes for playUri.

getSourceUri

String getSourceUri()

 Required. URI of the media to stitch.
 

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

Returns:

The sourceUri.

getSourceUriBytes

com.google.protobuf.ByteString getSourceUriBytes()

 Required. URI of the media to stitch.
 

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

Returns:

The bytes for sourceUri.

getAdTagUri

String getAdTagUri()

 Required. Ad tag URI.
 

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

Returns:

The adTagUri.

getAdTagUriBytes

com.google.protobuf.ByteString getAdTagUriBytes()

 Required. Ad tag URI.
 

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

Returns:

The bytes for adTagUri.

getAdTagMacroMapCount

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;

containsAdTagMacroMap

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;

getAdTagMacroMap

@Deprecated
Map<String,String> getAdTagMacroMap()

Deprecated.

Use getAdTagMacroMapMap() instead.

getAdTagMacroMapMap

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;

getAdTagMacroMapOrDefault

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;

getAdTagMacroMapOrThrow

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;

hasManifestOptions

boolean hasManifestOptions()

 Additional options that affect the output of the manifest.
 

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

Returns:

Whether the manifestOptions field is set.

getManifestOptions

ManifestOptions getManifestOptions()

 Additional options that affect the output of the manifest.
 

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

Returns:

The manifestOptions.

getManifestOptionsOrBuilder

ManifestOptionsOrBuilder getManifestOptionsOrBuilder()

 Additional options that affect the output of the manifest.
 

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

getAssetId

String getAssetId()

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

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

Returns:

The assetId.

getAssetIdBytes

com.google.protobuf.ByteString getAssetIdBytes()

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

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

Returns:

The bytes for assetId.

getAdTrackingValue

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:

The enum numeric value on the wire for adTracking.

getAdTracking

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:

The adTracking.

hasGamSettings

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:

Whether the gamSettings field is set.

getGamSettings

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:

The gamSettings.

getGamSettingsOrBuilder

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;