Class Companion (0.55.0) 

public final class Companion extends GeneratedMessageV3 implements CompanionOrBuilder

Metadata for a companion.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Companion

Implements

CompanionOrBuilder

Static Fields

AD_SLOT_ID_FIELD_NUMBER

public static final int AD_SLOT_ID_FIELD_NUMBER
Field Value
Type Description
int

API_FRAMEWORK_FIELD_NUMBER

public static final int API_FRAMEWORK_FIELD_NUMBER
Field Value
Type Description
int

ASSET_HEIGHT_PX_FIELD_NUMBER

public static final int ASSET_HEIGHT_PX_FIELD_NUMBER
Field Value
Type Description
int

ASSET_WIDTH_PX_FIELD_NUMBER

public static final int ASSET_WIDTH_PX_FIELD_NUMBER
Field Value
Type Description
int

EVENTS_FIELD_NUMBER

public static final int EVENTS_FIELD_NUMBER
Field Value
Type Description
int

EXPANDED_HEIGHT_PX_FIELD_NUMBER

public static final int EXPANDED_HEIGHT_PX_FIELD_NUMBER
Field Value
Type Description
int

EXPANDED_WIDTH_PX_FIELD_NUMBER

public static final int EXPANDED_WIDTH_PX_FIELD_NUMBER
Field Value
Type Description
int

HEIGHT_PX_FIELD_NUMBER

public static final int HEIGHT_PX_FIELD_NUMBER
Field Value
Type Description
int

HTML_AD_RESOURCE_FIELD_NUMBER

public static final int HTML_AD_RESOURCE_FIELD_NUMBER
Field Value
Type Description
int

IFRAME_AD_RESOURCE_FIELD_NUMBER

public static final int IFRAME_AD_RESOURCE_FIELD_NUMBER
Field Value
Type Description
int

STATIC_AD_RESOURCE_FIELD_NUMBER

public static final int STATIC_AD_RESOURCE_FIELD_NUMBER
Field Value
Type Description
int

WIDTH_PX_FIELD_NUMBER

public static final int WIDTH_PX_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Companion getDefaultInstance()
Returns
Type Description
Companion

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Companion.Builder newBuilder()
Returns
Type Description
Companion.Builder

newBuilder(Companion prototype)

public static Companion.Builder newBuilder(Companion prototype)
Parameter
Name Description
prototype Companion
Returns
Type Description
Companion.Builder

parseDelimitedFrom(InputStream input)

public static Companion parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Companion
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Companion parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Companion
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Companion parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Companion
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Companion parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Companion
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Companion parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Companion
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Companion parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Companion
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Companion parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Companion
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Companion parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Companion
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Companion parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Companion
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Companion parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Companion
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Companion parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Companion
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Companion parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Companion
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Companion> parser()
Returns
Type Description
Parser<Companion>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAdResourceCase()

public Companion.AdResourceCase getAdResourceCase()
Returns
Type Description
Companion.AdResourceCase

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;

Returns
Type Description
String

The adSlotId.

getAdSlotIdBytes()

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

Returns
Type Description
ByteString

The bytes for adSlotId.

getApiFramework()

public String getApiFramework()

The API necessary to communicate with the creative if available.

string api_framework = 1;

Returns
Type Description
String

The apiFramework.

getApiFrameworkBytes()

public ByteString getApiFrameworkBytes()

The API necessary to communicate with the creative if available.

string api_framework = 1;

Returns
Type Description
ByteString

The bytes for apiFramework.

getAssetHeightPx()

public int getAssetHeightPx()

The pixel height of the creative.

int32 asset_height_px = 4;

Returns
Type Description
int

The assetHeightPx.

getAssetWidthPx()

public int getAssetWidthPx()

The pixel width of the creative.

int32 asset_width_px = 6;

Returns
Type Description
int

The assetWidthPx.

getDefaultInstanceForType()

public Companion getDefaultInstanceForType()
Returns
Type Description
Companion

getEvents(int index)

public Event getEvents(int index)

The list of tracking events for the companion.

repeated .google.cloud.video.stitcher.v1.Event events = 9;

Parameter
Name Description
index int
Returns
Type Description
Event

getEventsCount()

public int getEventsCount()

The list of tracking events for the companion.

repeated .google.cloud.video.stitcher.v1.Event events = 9;

Returns
Type Description
int

getEventsList()

public List<Event> getEventsList()

The list of tracking events for the companion.

repeated .google.cloud.video.stitcher.v1.Event events = 9;

Returns
Type Description
List<Event>

getEventsOrBuilder(int index)

public EventOrBuilder getEventsOrBuilder(int index)

The list of tracking events for the companion.

repeated .google.cloud.video.stitcher.v1.Event events = 9;

Parameter
Name Description
index int
Returns
Type Description
EventOrBuilder

getEventsOrBuilderList()

public List<? extends EventOrBuilder> getEventsOrBuilderList()

The list of tracking events for the companion.

repeated .google.cloud.video.stitcher.v1.Event events = 9;

Returns
Type Description
List<? extends com.google.cloud.video.stitcher.v1.EventOrBuilder>

getExpandedHeightPx()

public int getExpandedHeightPx()

The maximum pixel height of the creative in its expanded state.

int32 expanded_height_px = 5;

Returns
Type Description
int

The expandedHeightPx.

getExpandedWidthPx()

public int getExpandedWidthPx()

The maximum pixel width of the creative in its expanded state.

int32 expanded_width_px = 7;

Returns
Type Description
int

The expandedWidthPx.

getHeightPx()

public int getHeightPx()

The pixel height of the placement slot for the intended creative.

int32 height_px = 2;

Returns
Type Description
int

The heightPx.

getHtmlAdResource()

public HtmlAdResource getHtmlAdResource()

The HTML ad resource associated with the companion ad.

.google.cloud.video.stitcher.v1.HtmlAdResource html_ad_resource = 12;

Returns
Type Description
HtmlAdResource

The htmlAdResource.

getHtmlAdResourceOrBuilder()

public HtmlAdResourceOrBuilder getHtmlAdResourceOrBuilder()

The HTML ad resource associated with the companion ad.

.google.cloud.video.stitcher.v1.HtmlAdResource html_ad_resource = 12;

Returns
Type Description
HtmlAdResourceOrBuilder

getIframeAdResource()

public IframeAdResource getIframeAdResource()

The IFrame ad resource associated with the companion ad.

.google.cloud.video.stitcher.v1.IframeAdResource iframe_ad_resource = 10;

Returns
Type Description
IframeAdResource

The iframeAdResource.

getIframeAdResourceOrBuilder()

public IframeAdResourceOrBuilder getIframeAdResourceOrBuilder()

The IFrame ad resource associated with the companion ad.

.google.cloud.video.stitcher.v1.IframeAdResource iframe_ad_resource = 10;

Returns
Type Description
IframeAdResourceOrBuilder

getParserForType()

public Parser<Companion> getParserForType()
Returns
Type Description
Parser<Companion>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStaticAdResource()

public StaticAdResource getStaticAdResource()

The static ad resource associated with the companion ad.

.google.cloud.video.stitcher.v1.StaticAdResource static_ad_resource = 11;

Returns
Type Description
StaticAdResource

The staticAdResource.

getStaticAdResourceOrBuilder()

public StaticAdResourceOrBuilder getStaticAdResourceOrBuilder()

The static ad resource associated with the companion ad.

.google.cloud.video.stitcher.v1.StaticAdResource static_ad_resource = 11;

Returns
Type Description
StaticAdResourceOrBuilder

getWidthPx()

public int getWidthPx()

The pixel width of the placement slot for the intended creative.

int32 width_px = 3;

Returns
Type Description
int

The widthPx.

hasHtmlAdResource()

public boolean hasHtmlAdResource()

The HTML ad resource associated with the companion ad.

.google.cloud.video.stitcher.v1.HtmlAdResource html_ad_resource = 12;

Returns
Type Description
boolean

Whether the htmlAdResource field is set.

hasIframeAdResource()

public boolean hasIframeAdResource()

The IFrame ad resource associated with the companion ad.

.google.cloud.video.stitcher.v1.IframeAdResource iframe_ad_resource = 10;

Returns
Type Description
boolean

Whether the iframeAdResource field is set.

hasStaticAdResource()

public boolean hasStaticAdResource()

The static ad resource associated with the companion ad.

.google.cloud.video.stitcher.v1.StaticAdResource static_ad_resource = 11;

Returns
Type Description
boolean

Whether the staticAdResource field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Companion.Builder newBuilderForType()
Returns
Type Description
Companion.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Companion.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Companion.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Companion.Builder toBuilder()
Returns
Type Description
Companion.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException