Class Companion

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

    public final class Companion
    extends com.google.protobuf.GeneratedMessageV3
    implements CompanionOrBuilder
     Metadata for a companion.
     
    Protobuf type google.cloud.video.stitcher.v1.Companion
    See Also:
    Serialized Form
    • Field Detail

      • IFRAME_AD_RESOURCE_FIELD_NUMBER

        public static final int IFRAME_AD_RESOURCE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • STATIC_AD_RESOURCE_FIELD_NUMBER

        public static final int STATIC_AD_RESOURCE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • HTML_AD_RESOURCE_FIELD_NUMBER

        public static final int HTML_AD_RESOURCE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • API_FRAMEWORK_FIELD_NUMBER

        public static final int API_FRAMEWORK_FIELD_NUMBER
        See Also:
        Constant Field Values
      • ASSET_HEIGHT_PX_FIELD_NUMBER

        public static final int ASSET_HEIGHT_PX_FIELD_NUMBER
        See Also:
        Constant Field Values
      • EXPANDED_HEIGHT_PX_FIELD_NUMBER

        public static final int EXPANDED_HEIGHT_PX_FIELD_NUMBER
        See Also:
        Constant Field Values
      • ASSET_WIDTH_PX_FIELD_NUMBER

        public static final int ASSET_WIDTH_PX_FIELD_NUMBER
        See Also:
        Constant Field Values
      • EXPANDED_WIDTH_PX_FIELD_NUMBER

        public static final int EXPANDED_WIDTH_PX_FIELD_NUMBER
        See Also:
        Constant Field Values
      • AD_SLOT_ID_FIELD_NUMBER

        public static final int AD_SLOT_ID_FIELD_NUMBER
        See Also:
        Constant Field Values
    • 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()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • hasIframeAdResource

        public boolean hasIframeAdResource()
         The IFrame ad resource associated with the companion ad.
         
        .google.cloud.video.stitcher.v1.IframeAdResource iframe_ad_resource = 10;
        Specified by:
        hasIframeAdResource in interface CompanionOrBuilder
        Returns:
        Whether the iframeAdResource field is set.
      • getIframeAdResource

        public IframeAdResource getIframeAdResource()
         The IFrame ad resource associated with the companion ad.
         
        .google.cloud.video.stitcher.v1.IframeAdResource iframe_ad_resource = 10;
        Specified by:
        getIframeAdResource in interface CompanionOrBuilder
        Returns:
        The iframeAdResource.
      • hasStaticAdResource

        public boolean hasStaticAdResource()
         The static ad resource associated with the companion ad.
         
        .google.cloud.video.stitcher.v1.StaticAdResource static_ad_resource = 11;
        Specified by:
        hasStaticAdResource in interface CompanionOrBuilder
        Returns:
        Whether the staticAdResource field is set.
      • getStaticAdResource

        public StaticAdResource getStaticAdResource()
         The static ad resource associated with the companion ad.
         
        .google.cloud.video.stitcher.v1.StaticAdResource static_ad_resource = 11;
        Specified by:
        getStaticAdResource in interface CompanionOrBuilder
        Returns:
        The staticAdResource.
      • hasHtmlAdResource

        public boolean hasHtmlAdResource()
         The HTML ad resource associated with the companion ad.
         
        .google.cloud.video.stitcher.v1.HtmlAdResource html_ad_resource = 12;
        Specified by:
        hasHtmlAdResource in interface CompanionOrBuilder
        Returns:
        Whether the htmlAdResource field is set.
      • getHtmlAdResource

        public HtmlAdResource getHtmlAdResource()
         The HTML ad resource associated with the companion ad.
         
        .google.cloud.video.stitcher.v1.HtmlAdResource html_ad_resource = 12;
        Specified by:
        getHtmlAdResource in interface CompanionOrBuilder
        Returns:
        The htmlAdResource.
      • getApiFramework

        public String getApiFramework()
         The API necessary to communicate with the creative if available.
         
        string api_framework = 1;
        Specified by:
        getApiFramework in interface CompanionOrBuilder
        Returns:
        The apiFramework.
      • getApiFrameworkBytes

        public com.google.protobuf.ByteString getApiFrameworkBytes()
         The API necessary to communicate with the creative if available.
         
        string api_framework = 1;
        Specified by:
        getApiFrameworkBytes in interface CompanionOrBuilder
        Returns:
        The bytes for apiFramework.
      • getHeightPx

        public int getHeightPx()
         The pixel height of the placement slot for the intended creative.
         
        int32 height_px = 2;
        Specified by:
        getHeightPx in interface CompanionOrBuilder
        Returns:
        The heightPx.
      • getWidthPx

        public int getWidthPx()
         The pixel width of the placement slot for the intended creative.
         
        int32 width_px = 3;
        Specified by:
        getWidthPx in interface CompanionOrBuilder
        Returns:
        The widthPx.
      • getAssetHeightPx

        public int getAssetHeightPx()
         The pixel height of the creative.
         
        int32 asset_height_px = 4;
        Specified by:
        getAssetHeightPx in interface CompanionOrBuilder
        Returns:
        The assetHeightPx.
      • getExpandedHeightPx

        public int getExpandedHeightPx()
         The maximum pixel height of the creative in its expanded state.
         
        int32 expanded_height_px = 5;
        Specified by:
        getExpandedHeightPx in interface CompanionOrBuilder
        Returns:
        The expandedHeightPx.
      • getAssetWidthPx

        public int getAssetWidthPx()
         The pixel width of the creative.
         
        int32 asset_width_px = 6;
        Specified by:
        getAssetWidthPx in interface CompanionOrBuilder
        Returns:
        The assetWidthPx.
      • getExpandedWidthPx

        public int getExpandedWidthPx()
         The maximum pixel width of the creative in its expanded state.
         
        int32 expanded_width_px = 7;
        Specified by:
        getExpandedWidthPx in interface CompanionOrBuilder
        Returns:
        The expandedWidthPx.
      • getAdSlotId

        public String getAdSlotId()
         The ID used to identify the desired placement on a publisher's page.
         Values to be used should be discussed between publishers and
         advertisers.
         
        string ad_slot_id = 8;
        Specified by:
        getAdSlotId in interface CompanionOrBuilder
        Returns:
        The adSlotId.
      • getAdSlotIdBytes

        public com.google.protobuf.ByteString getAdSlotIdBytes()
         The ID used to identify the desired placement on a publisher's page.
         Values to be used should be discussed between publishers and
         advertisers.
         
        string ad_slot_id = 8;
        Specified by:
        getAdSlotIdBytes in interface CompanionOrBuilder
        Returns:
        The bytes for adSlotId.
      • getEventsList

        public List<Event> getEventsList()
         The list of tracking events for the companion.
         
        repeated .google.cloud.video.stitcher.v1.Event events = 9;
        Specified by:
        getEventsList in interface CompanionOrBuilder
      • getEventsCount

        public int getEventsCount()
         The list of tracking events for the companion.
         
        repeated .google.cloud.video.stitcher.v1.Event events = 9;
        Specified by:
        getEventsCount in interface CompanionOrBuilder
      • getEvents

        public Event getEvents​(int index)
         The list of tracking events for the companion.
         
        repeated .google.cloud.video.stitcher.v1.Event events = 9;
        Specified by:
        getEvents in interface CompanionOrBuilder
      • getEventsOrBuilder

        public EventOrBuilder getEventsOrBuilder​(int index)
         The list of tracking events for the companion.
         
        repeated .google.cloud.video.stitcher.v1.Event events = 9;
        Specified by:
        getEventsOrBuilder in interface CompanionOrBuilder
      • 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 Companion parseFrom​(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

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

        public static Companion getDefaultInstance()
      • parser

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

        public com.google.protobuf.Parser<Companion> 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 Companion getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder