Class Companion.Builder (0.19.0)

public static final class Companion.Builder extends GeneratedMessageV3.Builder<Companion.Builder> implements CompanionOrBuilder

Metadata for a companion.

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

Implements

CompanionOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllEvents(Iterable<? extends Event> values)

public Companion.Builder addAllEvents(Iterable<? extends Event> values)

The list of tracking events for the companion.

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

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.video.stitcher.v1.Event>
Returns
TypeDescription
Companion.Builder

addEvents(Event value)

public Companion.Builder addEvents(Event value)

The list of tracking events for the companion.

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

Parameter
NameDescription
valueEvent
Returns
TypeDescription
Companion.Builder

addEvents(Event.Builder builderForValue)

public Companion.Builder addEvents(Event.Builder builderForValue)

The list of tracking events for the companion.

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

Parameter
NameDescription
builderForValueEvent.Builder
Returns
TypeDescription
Companion.Builder

addEvents(int index, Event value)

public Companion.Builder addEvents(int index, Event value)

The list of tracking events for the companion.

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

Parameters
NameDescription
indexint
valueEvent
Returns
TypeDescription
Companion.Builder

addEvents(int index, Event.Builder builderForValue)

public Companion.Builder addEvents(int index, Event.Builder builderForValue)

The list of tracking events for the companion.

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

Parameters
NameDescription
indexint
builderForValueEvent.Builder
Returns
TypeDescription
Companion.Builder

addEventsBuilder()

public Event.Builder addEventsBuilder()

The list of tracking events for the companion.

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

Returns
TypeDescription
Event.Builder

addEventsBuilder(int index)

public Event.Builder addEventsBuilder(int index)

The list of tracking events for the companion.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Event.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Companion.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Companion.Builder
Overrides

build()

public Companion build()
Returns
TypeDescription
Companion

buildPartial()

public Companion buildPartial()
Returns
TypeDescription
Companion

clear()

public Companion.Builder clear()
Returns
TypeDescription
Companion.Builder
Overrides

clearAdResource()

public Companion.Builder clearAdResource()
Returns
TypeDescription
Companion.Builder

clearAdSlotId()

public Companion.Builder clearAdSlotId()

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
TypeDescription
Companion.Builder

This builder for chaining.

clearApiFramework()

public Companion.Builder clearApiFramework()

The API necessary to communicate with the creative if available.

string api_framework = 1;

Returns
TypeDescription
Companion.Builder

This builder for chaining.

clearAssetHeightPx()

public Companion.Builder clearAssetHeightPx()

The pixel height of the creative.

int32 asset_height_px = 4;

Returns
TypeDescription
Companion.Builder

This builder for chaining.

clearAssetWidthPx()

public Companion.Builder clearAssetWidthPx()

The pixel width of the creative.

int32 asset_width_px = 6;

Returns
TypeDescription
Companion.Builder

This builder for chaining.

clearEvents()

public Companion.Builder clearEvents()

The list of tracking events for the companion.

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

Returns
TypeDescription
Companion.Builder

clearExpandedHeightPx()

public Companion.Builder clearExpandedHeightPx()

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

int32 expanded_height_px = 5;

Returns
TypeDescription
Companion.Builder

This builder for chaining.

clearExpandedWidthPx()

public Companion.Builder clearExpandedWidthPx()

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

int32 expanded_width_px = 7;

Returns
TypeDescription
Companion.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Companion.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Companion.Builder
Overrides

clearHeightPx()

public Companion.Builder clearHeightPx()

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

int32 height_px = 2;

Returns
TypeDescription
Companion.Builder

This builder for chaining.

clearHtmlAdResource()

public Companion.Builder clearHtmlAdResource()

The HTML ad resource associated with the companion ad.

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

Returns
TypeDescription
Companion.Builder

clearIframeAdResource()

public Companion.Builder clearIframeAdResource()

The IFrame ad resource associated with the companion ad.

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

Returns
TypeDescription
Companion.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Companion.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Companion.Builder
Overrides

clearStaticAdResource()

public Companion.Builder clearStaticAdResource()

The static ad resource associated with the companion ad.

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

Returns
TypeDescription
Companion.Builder

clearWidthPx()

public Companion.Builder clearWidthPx()

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

int32 width_px = 3;

Returns
TypeDescription
Companion.Builder

This builder for chaining.

clone()

public Companion.Builder clone()
Returns
TypeDescription
Companion.Builder
Overrides

getAdResourceCase()

public Companion.AdResourceCase getAdResourceCase()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for adSlotId.

getApiFramework()

public String getApiFramework()

The API necessary to communicate with the creative if available.

string api_framework = 1;

Returns
TypeDescription
String

The apiFramework.

getApiFrameworkBytes()

public ByteString getApiFrameworkBytes()

The API necessary to communicate with the creative if available.

string api_framework = 1;

Returns
TypeDescription
ByteString

The bytes for apiFramework.

getAssetHeightPx()

public int getAssetHeightPx()

The pixel height of the creative.

int32 asset_height_px = 4;

Returns
TypeDescription
int

The assetHeightPx.

getAssetWidthPx()

public int getAssetWidthPx()

The pixel width of the creative.

int32 asset_width_px = 6;

Returns
TypeDescription
int

The assetWidthPx.

getDefaultInstanceForType()

public Companion getDefaultInstanceForType()
Returns
TypeDescription
Companion

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
NameDescription
indexint
Returns
TypeDescription
Event

getEventsBuilder(int index)

public Event.Builder getEventsBuilder(int index)

The list of tracking events for the companion.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Event.Builder

getEventsBuilderList()

public List<Event.Builder> getEventsBuilderList()

The list of tracking events for the companion.

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

Returns
TypeDescription
List<Builder>

getEventsCount()

public int getEventsCount()

The list of tracking events for the companion.

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

Returns
TypeDescription
int

getEventsList()

public List<Event> getEventsList()

The list of tracking events for the companion.

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

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
int

The expandedHeightPx.

getExpandedWidthPx()

public int getExpandedWidthPx()

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

int32 expanded_width_px = 7;

Returns
TypeDescription
int

The expandedWidthPx.

getHeightPx()

public int getHeightPx()

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

int32 height_px = 2;

Returns
TypeDescription
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
TypeDescription
HtmlAdResource

The htmlAdResource.

getHtmlAdResourceBuilder()

public HtmlAdResource.Builder getHtmlAdResourceBuilder()

The HTML ad resource associated with the companion ad.

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

Returns
TypeDescription
HtmlAdResource.Builder

getHtmlAdResourceOrBuilder()

public HtmlAdResourceOrBuilder getHtmlAdResourceOrBuilder()

The HTML ad resource associated with the companion ad.

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

Returns
TypeDescription
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
TypeDescription
IframeAdResource

The iframeAdResource.

getIframeAdResourceBuilder()

public IframeAdResource.Builder getIframeAdResourceBuilder()

The IFrame ad resource associated with the companion ad.

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

Returns
TypeDescription
IframeAdResource.Builder

getIframeAdResourceOrBuilder()

public IframeAdResourceOrBuilder getIframeAdResourceOrBuilder()

The IFrame ad resource associated with the companion ad.

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

Returns
TypeDescription
IframeAdResourceOrBuilder

getStaticAdResource()

public StaticAdResource getStaticAdResource()

The static ad resource associated with the companion ad.

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

Returns
TypeDescription
StaticAdResource

The staticAdResource.

getStaticAdResourceBuilder()

public StaticAdResource.Builder getStaticAdResourceBuilder()

The static ad resource associated with the companion ad.

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

Returns
TypeDescription
StaticAdResource.Builder

getStaticAdResourceOrBuilder()

public StaticAdResourceOrBuilder getStaticAdResourceOrBuilder()

The static ad resource associated with the companion ad.

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

Returns
TypeDescription
StaticAdResourceOrBuilder

getWidthPx()

public int getWidthPx()

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

int32 width_px = 3;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the staticAdResource field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Companion other)

public Companion.Builder mergeFrom(Companion other)
Parameter
NameDescription
otherCompanion
Returns
TypeDescription
Companion.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Companion.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Companion.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Companion.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Companion.Builder
Overrides

mergeHtmlAdResource(HtmlAdResource value)

public Companion.Builder mergeHtmlAdResource(HtmlAdResource value)

The HTML ad resource associated with the companion ad.

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

Parameter
NameDescription
valueHtmlAdResource
Returns
TypeDescription
Companion.Builder

mergeIframeAdResource(IframeAdResource value)

public Companion.Builder mergeIframeAdResource(IframeAdResource value)

The IFrame ad resource associated with the companion ad.

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

Parameter
NameDescription
valueIframeAdResource
Returns
TypeDescription
Companion.Builder

mergeStaticAdResource(StaticAdResource value)

public Companion.Builder mergeStaticAdResource(StaticAdResource value)

The static ad resource associated with the companion ad.

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

Parameter
NameDescription
valueStaticAdResource
Returns
TypeDescription
Companion.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Companion.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Companion.Builder
Overrides

removeEvents(int index)

public Companion.Builder removeEvents(int index)

The list of tracking events for the companion.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Companion.Builder

setAdSlotId(String value)

public Companion.Builder setAdSlotId(String value)

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;

Parameter
NameDescription
valueString

The adSlotId to set.

Returns
TypeDescription
Companion.Builder

This builder for chaining.

setAdSlotIdBytes(ByteString value)

public Companion.Builder setAdSlotIdBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for adSlotId to set.

Returns
TypeDescription
Companion.Builder

This builder for chaining.

setApiFramework(String value)

public Companion.Builder setApiFramework(String value)

The API necessary to communicate with the creative if available.

string api_framework = 1;

Parameter
NameDescription
valueString

The apiFramework to set.

Returns
TypeDescription
Companion.Builder

This builder for chaining.

setApiFrameworkBytes(ByteString value)

public Companion.Builder setApiFrameworkBytes(ByteString value)

The API necessary to communicate with the creative if available.

string api_framework = 1;

Parameter
NameDescription
valueByteString

The bytes for apiFramework to set.

Returns
TypeDescription
Companion.Builder

This builder for chaining.

setAssetHeightPx(int value)

public Companion.Builder setAssetHeightPx(int value)

The pixel height of the creative.

int32 asset_height_px = 4;

Parameter
NameDescription
valueint

The assetHeightPx to set.

Returns
TypeDescription
Companion.Builder

This builder for chaining.

setAssetWidthPx(int value)

public Companion.Builder setAssetWidthPx(int value)

The pixel width of the creative.

int32 asset_width_px = 6;

Parameter
NameDescription
valueint

The assetWidthPx to set.

Returns
TypeDescription
Companion.Builder

This builder for chaining.

setEvents(int index, Event value)

public Companion.Builder setEvents(int index, Event value)

The list of tracking events for the companion.

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

Parameters
NameDescription
indexint
valueEvent
Returns
TypeDescription
Companion.Builder

setEvents(int index, Event.Builder builderForValue)

public Companion.Builder setEvents(int index, Event.Builder builderForValue)

The list of tracking events for the companion.

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

Parameters
NameDescription
indexint
builderForValueEvent.Builder
Returns
TypeDescription
Companion.Builder

setExpandedHeightPx(int value)

public Companion.Builder setExpandedHeightPx(int value)

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

int32 expanded_height_px = 5;

Parameter
NameDescription
valueint

The expandedHeightPx to set.

Returns
TypeDescription
Companion.Builder

This builder for chaining.

setExpandedWidthPx(int value)

public Companion.Builder setExpandedWidthPx(int value)

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

int32 expanded_width_px = 7;

Parameter
NameDescription
valueint

The expandedWidthPx to set.

Returns
TypeDescription
Companion.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Companion.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Companion.Builder
Overrides

setHeightPx(int value)

public Companion.Builder setHeightPx(int value)

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

int32 height_px = 2;

Parameter
NameDescription
valueint

The heightPx to set.

Returns
TypeDescription
Companion.Builder

This builder for chaining.

setHtmlAdResource(HtmlAdResource value)

public Companion.Builder setHtmlAdResource(HtmlAdResource value)

The HTML ad resource associated with the companion ad.

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

Parameter
NameDescription
valueHtmlAdResource
Returns
TypeDescription
Companion.Builder

setHtmlAdResource(HtmlAdResource.Builder builderForValue)

public Companion.Builder setHtmlAdResource(HtmlAdResource.Builder builderForValue)

The HTML ad resource associated with the companion ad.

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

Parameter
NameDescription
builderForValueHtmlAdResource.Builder
Returns
TypeDescription
Companion.Builder

setIframeAdResource(IframeAdResource value)

public Companion.Builder setIframeAdResource(IframeAdResource value)

The IFrame ad resource associated with the companion ad.

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

Parameter
NameDescription
valueIframeAdResource
Returns
TypeDescription
Companion.Builder

setIframeAdResource(IframeAdResource.Builder builderForValue)

public Companion.Builder setIframeAdResource(IframeAdResource.Builder builderForValue)

The IFrame ad resource associated with the companion ad.

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

Parameter
NameDescription
builderForValueIframeAdResource.Builder
Returns
TypeDescription
Companion.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Companion.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Companion.Builder
Overrides

setStaticAdResource(StaticAdResource value)

public Companion.Builder setStaticAdResource(StaticAdResource value)

The static ad resource associated with the companion ad.

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

Parameter
NameDescription
valueStaticAdResource
Returns
TypeDescription
Companion.Builder

setStaticAdResource(StaticAdResource.Builder builderForValue)

public Companion.Builder setStaticAdResource(StaticAdResource.Builder builderForValue)

The static ad resource associated with the companion ad.

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

Parameter
NameDescription
builderForValueStaticAdResource.Builder
Returns
TypeDescription
Companion.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Companion.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Companion.Builder
Overrides

setWidthPx(int value)

public Companion.Builder setWidthPx(int value)

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

int32 width_px = 3;

Parameter
NameDescription
valueint

The widthPx to set.

Returns
TypeDescription
Companion.Builder

This builder for chaining.