Class Companion (0.5.0)
Note: Some or all of the information on this page might not apply
to Trusted Cloud. For a list of services that are available in
Trusted Cloud, see Services available for
Trusted Cloud .
Version 0.5.0keyboard_arrow_down
public final class Companion extends GeneratedMessageV3 implements CompanionOrBuilder
Metadata for a companion.
Protobuf type google.cloud.video.stitcher.v1.Companion
Static Fields
AD_SLOT_ID_FIELD_NUMBER
public static final int AD_SLOT_ID_FIELD_NUMBER
Field Value
API_FRAMEWORK_FIELD_NUMBER
public static final int API_FRAMEWORK_FIELD_NUMBER
Field Value
ASSET_HEIGHT_PX_FIELD_NUMBER
public static final int ASSET_HEIGHT_PX_FIELD_NUMBER
Field Value
ASSET_WIDTH_PX_FIELD_NUMBER
public static final int ASSET_WIDTH_PX_FIELD_NUMBER
Field Value
EVENTS_FIELD_NUMBER
public static final int EVENTS_FIELD_NUMBER
Field Value
EXPANDED_HEIGHT_PX_FIELD_NUMBER
public static final int EXPANDED_HEIGHT_PX_FIELD_NUMBER
Field Value
EXPANDED_WIDTH_PX_FIELD_NUMBER
public static final int EXPANDED_WIDTH_PX_FIELD_NUMBER
Field Value
HEIGHT_PX_FIELD_NUMBER
public static final int HEIGHT_PX_FIELD_NUMBER
Field Value
HTML_AD_RESOURCE_FIELD_NUMBER
public static final int HTML_AD_RESOURCE_FIELD_NUMBER
Field Value
IFRAME_AD_RESOURCE_FIELD_NUMBER
public static final int IFRAME_AD_RESOURCE_FIELD_NUMBER
Field Value
STATIC_AD_RESOURCE_FIELD_NUMBER
public static final int STATIC_AD_RESOURCE_FIELD_NUMBER
Field Value
WIDTH_PX_FIELD_NUMBER
public static final int WIDTH_PX_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Companion getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static Companion . Builder newBuilder ()
Returns
newBuilder(Companion prototype)
public static Companion . Builder newBuilder ( Companion prototype )
Parameter
Returns
public static Companion parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static Companion parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Companion parseFrom ( byte [] data )
Parameter
Name Description
data byte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Companion parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Companion parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Companion parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Companion parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static Companion parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Companion parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static Companion parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Companion parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Companion parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<Companion> parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getAdResourceCase()
public Companion . AdResourceCase getAdResourceCase ()
Returns
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
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
getEventsCount()
public int getEventsCount ()
The list of tracking events for the companion.
repeated .google.cloud.video.stitcher.v1.Event events = 9;
Returns
getEventsList()
public List<Event> getEventsList ()
The list of tracking events for the companion.
repeated .google.cloud.video.stitcher.v1.Event events = 9;
Returns
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
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()
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
getHtmlAdResourceOrBuilder()
public HtmlAdResourceOrBuilder getHtmlAdResourceOrBuilder ()
The HTML ad resource associated with the companion ad.
.google.cloud.video.stitcher.v1.HtmlAdResource html_ad_resource = 12;
Returns
getIframeAdResource()
public IframeAdResource getIframeAdResource ()
The IFrame ad resource associated with the companion ad.
.google.cloud.video.stitcher.v1.IframeAdResource iframe_ad_resource = 10;
Returns
getIframeAdResourceOrBuilder()
public IframeAdResourceOrBuilder getIframeAdResourceOrBuilder ()
The IFrame ad resource associated with the companion ad.
.google.cloud.video.stitcher.v1.IframeAdResource iframe_ad_resource = 10;
Returns
getParserForType()
public Parser<Companion> getParserForType ()
Returns
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
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
getStaticAdResourceOrBuilder()
public StaticAdResourceOrBuilder getStaticAdResourceOrBuilder ()
The static ad resource associated with the companion ad.
.google.cloud.video.stitcher.v1.StaticAdResource static_ad_resource = 11;
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
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()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public Companion . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Companion . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public Companion . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-16 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-16 UTC."],[],[]]
