Class VodSession

  • All Implemented Interfaces:
    VodSessionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class VodSession
    extends com.google.protobuf.GeneratedMessageV3
    implements VodSessionOrBuilder
     Metadata for a VOD session. The session expires 4 hours after its creation.
     
    Protobuf type google.cloud.video.stitcher.v1.VodSession
    See Also:
    Serialized Form
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • 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];
        Specified by:
        getName in interface VodSessionOrBuilder
        Returns:
        The name.
      • getNameBytes

        public 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];
        Specified by:
        getNameBytes in interface VodSessionOrBuilder
        Returns:
        The bytes for name.
      • 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];
        Specified by:
        hasInterstitials in interface VodSessionOrBuilder
        Returns:
        Whether the interstitials field is set.
      • 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];
        Specified by:
        getInterstitials in interface VodSessionOrBuilder
        Returns:
        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];
        Specified by:
        getInterstitialsOrBuilder in interface VodSessionOrBuilder
      • getPlayUri

        public String getPlayUri()
         Output only. The playback URI of the stitched content.
         
        string play_uri = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPlayUri in interface VodSessionOrBuilder
        Returns:
        The playUri.
      • getPlayUriBytes

        public com.google.protobuf.ByteString getPlayUriBytes()
         Output only. The playback URI of the stitched content.
         
        string play_uri = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPlayUriBytes in interface VodSessionOrBuilder
        Returns:
        The bytes for playUri.
      • getSourceUri

        public String getSourceUri()
         Required. URI of the media to stitch.
         
        string source_uri = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getSourceUri in interface VodSessionOrBuilder
        Returns:
        The sourceUri.
      • getSourceUriBytes

        public com.google.protobuf.ByteString getSourceUriBytes()
         Required. URI of the media to stitch.
         
        string source_uri = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getSourceUriBytes in interface VodSessionOrBuilder
        Returns:
        The bytes for sourceUri.
      • getAdTagUri

        public String getAdTagUri()
         Required. Ad tag URI.
         
        string ad_tag_uri = 6 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getAdTagUri in interface VodSessionOrBuilder
        Returns:
        The adTagUri.
      • getAdTagUriBytes

        public com.google.protobuf.ByteString getAdTagUriBytes()
         Required. Ad tag URI.
         
        string ad_tag_uri = 6 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getAdTagUriBytes in interface VodSessionOrBuilder
        Returns:
        The bytes for adTagUri.
      • getAdTagMacroMapCount

        public int getAdTagMacroMapCount()
        Description copied from interface: VodSessionOrBuilder
         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;
        Specified by:
        getAdTagMacroMapCount in interface VodSessionOrBuilder
      • containsAdTagMacroMap

        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;
        Specified by:
        containsAdTagMacroMap in interface VodSessionOrBuilder
      • 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;
        Specified by:
        getAdTagMacroMapMap in interface VodSessionOrBuilder
      • getAdTagMacroMapOrDefault

        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;
        Specified by:
        getAdTagMacroMapOrDefault in interface VodSessionOrBuilder
      • getAdTagMacroMapOrThrow

        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;
        Specified by:
        getAdTagMacroMapOrThrow in interface VodSessionOrBuilder
      • hasManifestOptions

        public boolean hasManifestOptions()
         Additional options that affect the output of the manifest.
         
        .google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 9;
        Specified by:
        hasManifestOptions in interface VodSessionOrBuilder
        Returns:
        Whether the manifestOptions field is set.
      • getManifestOptions

        public ManifestOptions getManifestOptions()
         Additional options that affect the output of the manifest.
         
        .google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 9;
        Specified by:
        getManifestOptions in interface VodSessionOrBuilder
        Returns:
        The manifestOptions.
      • 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];
        Specified by:
        getAssetId in interface VodSessionOrBuilder
        Returns:
        The assetId.
      • getAssetIdBytes

        public 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];
        Specified by:
        getAssetIdBytes in interface VodSessionOrBuilder
        Returns:
        The bytes for assetId.
      • 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];
        Specified by:
        getAdTrackingValue in interface VodSessionOrBuilder
        Returns:
        The enum numeric value on the wire for adTracking.
      • 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];
        Specified by:
        getAdTracking in interface VodSessionOrBuilder
        Returns:
        The adTracking.
      • 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;
        Specified by:
        hasGamSettings in interface VodSessionOrBuilder
        Returns:
        Whether the gamSettings field is set.
      • 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;
        Specified by:
        getGamSettings in interface VodSessionOrBuilder
        Returns:
        The gamSettings.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static VodSession parseFrom​(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static VodSession parseFrom​(ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static VodSession parseFrom​(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static VodSession parseFrom​(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static VodSession parseFrom​(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static VodSession parseFrom​(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static VodSession parseFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Throws:
        IOException
      • newBuilderForType

        public VodSession.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public VodSession.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected VodSession.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static VodSession getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<VodSession> parser()
      • getParserForType

        public com.google.protobuf.Parser<VodSession> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public VodSession getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder