Class VodSessionAd.Builder (0.43.0)

public static final class VodSessionAd.Builder extends GeneratedMessageV3.Builder<VodSessionAd.Builder> implements VodSessionAdOrBuilder

Metadata for an inserted ad in a VOD session.

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

Static Methods

getDescriptor()

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

Methods

addActivityEvents(Event value)

public VodSessionAd.Builder addActivityEvents(Event value)

The list of progress tracking events for the ad break. These can be of the following IAB types: MUTE, UNMUTE, PAUSE, CLICK, CLICK_THROUGH, REWIND, RESUME, ERROR, FULLSCREEN, EXIT_FULLSCREEN, EXPAND, COLLAPSE, ACCEPT_INVITATION_LINEAR, CLOSE_LINEAR, SKIP.

repeated .google.cloud.video.stitcher.v1.Event activity_events = 3;

Parameter
Name Description
value Event
Returns
Type Description
VodSessionAd.Builder

addActivityEvents(Event.Builder builderForValue)

public VodSessionAd.Builder addActivityEvents(Event.Builder builderForValue)

The list of progress tracking events for the ad break. These can be of the following IAB types: MUTE, UNMUTE, PAUSE, CLICK, CLICK_THROUGH, REWIND, RESUME, ERROR, FULLSCREEN, EXIT_FULLSCREEN, EXPAND, COLLAPSE, ACCEPT_INVITATION_LINEAR, CLOSE_LINEAR, SKIP.

repeated .google.cloud.video.stitcher.v1.Event activity_events = 3;

Parameter
Name Description
builderForValue Event.Builder
Returns
Type Description
VodSessionAd.Builder

addActivityEvents(int index, Event value)

public VodSessionAd.Builder addActivityEvents(int index, Event value)

The list of progress tracking events for the ad break. These can be of the following IAB types: MUTE, UNMUTE, PAUSE, CLICK, CLICK_THROUGH, REWIND, RESUME, ERROR, FULLSCREEN, EXIT_FULLSCREEN, EXPAND, COLLAPSE, ACCEPT_INVITATION_LINEAR, CLOSE_LINEAR, SKIP.

repeated .google.cloud.video.stitcher.v1.Event activity_events = 3;

Parameters
Name Description
index int
value Event
Returns
Type Description
VodSessionAd.Builder

addActivityEvents(int index, Event.Builder builderForValue)

public VodSessionAd.Builder addActivityEvents(int index, Event.Builder builderForValue)

The list of progress tracking events for the ad break. These can be of the following IAB types: MUTE, UNMUTE, PAUSE, CLICK, CLICK_THROUGH, REWIND, RESUME, ERROR, FULLSCREEN, EXIT_FULLSCREEN, EXPAND, COLLAPSE, ACCEPT_INVITATION_LINEAR, CLOSE_LINEAR, SKIP.

repeated .google.cloud.video.stitcher.v1.Event activity_events = 3;

Parameters
Name Description
index int
builderForValue Event.Builder
Returns
Type Description
VodSessionAd.Builder

addActivityEventsBuilder()

public Event.Builder addActivityEventsBuilder()

The list of progress tracking events for the ad break. These can be of the following IAB types: MUTE, UNMUTE, PAUSE, CLICK, CLICK_THROUGH, REWIND, RESUME, ERROR, FULLSCREEN, EXIT_FULLSCREEN, EXPAND, COLLAPSE, ACCEPT_INVITATION_LINEAR, CLOSE_LINEAR, SKIP.

repeated .google.cloud.video.stitcher.v1.Event activity_events = 3;

Returns
Type Description
Event.Builder

addActivityEventsBuilder(int index)

public Event.Builder addActivityEventsBuilder(int index)

The list of progress tracking events for the ad break. These can be of the following IAB types: MUTE, UNMUTE, PAUSE, CLICK, CLICK_THROUGH, REWIND, RESUME, ERROR, FULLSCREEN, EXIT_FULLSCREEN, EXPAND, COLLAPSE, ACCEPT_INVITATION_LINEAR, CLOSE_LINEAR, SKIP.

repeated .google.cloud.video.stitcher.v1.Event activity_events = 3;

Parameter
Name Description
index int
Returns
Type Description
Event.Builder

addAllActivityEvents(Iterable<? extends Event> values)

public VodSessionAd.Builder addAllActivityEvents(Iterable<? extends Event> values)

The list of progress tracking events for the ad break. These can be of the following IAB types: MUTE, UNMUTE, PAUSE, CLICK, CLICK_THROUGH, REWIND, RESUME, ERROR, FULLSCREEN, EXIT_FULLSCREEN, EXPAND, COLLAPSE, ACCEPT_INVITATION_LINEAR, CLOSE_LINEAR, SKIP.

repeated .google.cloud.video.stitcher.v1.Event activity_events = 3;

Parameter
Name Description
values Iterable<? extends com.google.cloud.video.stitcher.v1.Event>
Returns
Type Description
VodSessionAd.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public VodSessionAd.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
VodSessionAd.Builder
Overrides

build()

public VodSessionAd build()
Returns
Type Description
VodSessionAd

buildPartial()

public VodSessionAd buildPartial()
Returns
Type Description
VodSessionAd

clear()

public VodSessionAd.Builder clear()
Returns
Type Description
VodSessionAd.Builder
Overrides

clearActivityEvents()

public VodSessionAd.Builder clearActivityEvents()

The list of progress tracking events for the ad break. These can be of the following IAB types: MUTE, UNMUTE, PAUSE, CLICK, CLICK_THROUGH, REWIND, RESUME, ERROR, FULLSCREEN, EXIT_FULLSCREEN, EXPAND, COLLAPSE, ACCEPT_INVITATION_LINEAR, CLOSE_LINEAR, SKIP.

repeated .google.cloud.video.stitcher.v1.Event activity_events = 3;

Returns
Type Description
VodSessionAd.Builder

clearCompanionAds()

public VodSessionAd.Builder clearCompanionAds()

Metadata of companion ads associated with the ad.

.google.cloud.video.stitcher.v1.CompanionAds companion_ads = 2;

Returns
Type Description
VodSessionAd.Builder

clearDuration()

public VodSessionAd.Builder clearDuration()

Duration in seconds of the ad.

.google.protobuf.Duration duration = 1;

Returns
Type Description
VodSessionAd.Builder

clearField(Descriptors.FieldDescriptor field)

public VodSessionAd.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
VodSessionAd.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public VodSessionAd.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
VodSessionAd.Builder
Overrides

clone()

public VodSessionAd.Builder clone()
Returns
Type Description
VodSessionAd.Builder
Overrides

getActivityEvents(int index)

public Event getActivityEvents(int index)

The list of progress tracking events for the ad break. These can be of the following IAB types: MUTE, UNMUTE, PAUSE, CLICK, CLICK_THROUGH, REWIND, RESUME, ERROR, FULLSCREEN, EXIT_FULLSCREEN, EXPAND, COLLAPSE, ACCEPT_INVITATION_LINEAR, CLOSE_LINEAR, SKIP.

repeated .google.cloud.video.stitcher.v1.Event activity_events = 3;

Parameter
Name Description
index int
Returns
Type Description
Event

getActivityEventsBuilder(int index)

public Event.Builder getActivityEventsBuilder(int index)

The list of progress tracking events for the ad break. These can be of the following IAB types: MUTE, UNMUTE, PAUSE, CLICK, CLICK_THROUGH, REWIND, RESUME, ERROR, FULLSCREEN, EXIT_FULLSCREEN, EXPAND, COLLAPSE, ACCEPT_INVITATION_LINEAR, CLOSE_LINEAR, SKIP.

repeated .google.cloud.video.stitcher.v1.Event activity_events = 3;

Parameter
Name Description
index int
Returns
Type Description
Event.Builder

getActivityEventsBuilderList()

public List<Event.Builder> getActivityEventsBuilderList()

The list of progress tracking events for the ad break. These can be of the following IAB types: MUTE, UNMUTE, PAUSE, CLICK, CLICK_THROUGH, REWIND, RESUME, ERROR, FULLSCREEN, EXIT_FULLSCREEN, EXPAND, COLLAPSE, ACCEPT_INVITATION_LINEAR, CLOSE_LINEAR, SKIP.

repeated .google.cloud.video.stitcher.v1.Event activity_events = 3;

Returns
Type Description
List<Builder>

getActivityEventsCount()

public int getActivityEventsCount()

The list of progress tracking events for the ad break. These can be of the following IAB types: MUTE, UNMUTE, PAUSE, CLICK, CLICK_THROUGH, REWIND, RESUME, ERROR, FULLSCREEN, EXIT_FULLSCREEN, EXPAND, COLLAPSE, ACCEPT_INVITATION_LINEAR, CLOSE_LINEAR, SKIP.

repeated .google.cloud.video.stitcher.v1.Event activity_events = 3;

Returns
Type Description
int

getActivityEventsList()

public List<Event> getActivityEventsList()

The list of progress tracking events for the ad break. These can be of the following IAB types: MUTE, UNMUTE, PAUSE, CLICK, CLICK_THROUGH, REWIND, RESUME, ERROR, FULLSCREEN, EXIT_FULLSCREEN, EXPAND, COLLAPSE, ACCEPT_INVITATION_LINEAR, CLOSE_LINEAR, SKIP.

repeated .google.cloud.video.stitcher.v1.Event activity_events = 3;

Returns
Type Description
List<Event>

getActivityEventsOrBuilder(int index)

public EventOrBuilder getActivityEventsOrBuilder(int index)

The list of progress tracking events for the ad break. These can be of the following IAB types: MUTE, UNMUTE, PAUSE, CLICK, CLICK_THROUGH, REWIND, RESUME, ERROR, FULLSCREEN, EXIT_FULLSCREEN, EXPAND, COLLAPSE, ACCEPT_INVITATION_LINEAR, CLOSE_LINEAR, SKIP.

repeated .google.cloud.video.stitcher.v1.Event activity_events = 3;

Parameter
Name Description
index int
Returns
Type Description
EventOrBuilder

getActivityEventsOrBuilderList()

public List<? extends EventOrBuilder> getActivityEventsOrBuilderList()

The list of progress tracking events for the ad break. These can be of the following IAB types: MUTE, UNMUTE, PAUSE, CLICK, CLICK_THROUGH, REWIND, RESUME, ERROR, FULLSCREEN, EXIT_FULLSCREEN, EXPAND, COLLAPSE, ACCEPT_INVITATION_LINEAR, CLOSE_LINEAR, SKIP.

repeated .google.cloud.video.stitcher.v1.Event activity_events = 3;

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

getCompanionAds()

public CompanionAds getCompanionAds()

Metadata of companion ads associated with the ad.

.google.cloud.video.stitcher.v1.CompanionAds companion_ads = 2;

Returns
Type Description
CompanionAds

The companionAds.

getCompanionAdsBuilder()

public CompanionAds.Builder getCompanionAdsBuilder()

Metadata of companion ads associated with the ad.

.google.cloud.video.stitcher.v1.CompanionAds companion_ads = 2;

Returns
Type Description
CompanionAds.Builder

getCompanionAdsOrBuilder()

public CompanionAdsOrBuilder getCompanionAdsOrBuilder()

Metadata of companion ads associated with the ad.

.google.cloud.video.stitcher.v1.CompanionAds companion_ads = 2;

Returns
Type Description
CompanionAdsOrBuilder

getDefaultInstanceForType()

public VodSessionAd getDefaultInstanceForType()
Returns
Type Description
VodSessionAd

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDuration()

public Duration getDuration()

Duration in seconds of the ad.

.google.protobuf.Duration duration = 1;

Returns
Type Description
Duration

The duration.

getDurationBuilder()

public Duration.Builder getDurationBuilder()

Duration in seconds of the ad.

.google.protobuf.Duration duration = 1;

Returns
Type Description
Builder

getDurationOrBuilder()

public DurationOrBuilder getDurationOrBuilder()

Duration in seconds of the ad.

.google.protobuf.Duration duration = 1;

Returns
Type Description
DurationOrBuilder

hasCompanionAds()

public boolean hasCompanionAds()

Metadata of companion ads associated with the ad.

.google.cloud.video.stitcher.v1.CompanionAds companion_ads = 2;

Returns
Type Description
boolean

Whether the companionAds field is set.

hasDuration()

public boolean hasDuration()

Duration in seconds of the ad.

.google.protobuf.Duration duration = 1;

Returns
Type Description
boolean

Whether the duration field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCompanionAds(CompanionAds value)

public VodSessionAd.Builder mergeCompanionAds(CompanionAds value)

Metadata of companion ads associated with the ad.

.google.cloud.video.stitcher.v1.CompanionAds companion_ads = 2;

Parameter
Name Description
value CompanionAds
Returns
Type Description
VodSessionAd.Builder

mergeDuration(Duration value)

public VodSessionAd.Builder mergeDuration(Duration value)

Duration in seconds of the ad.

.google.protobuf.Duration duration = 1;

Parameter
Name Description
value Duration
Returns
Type Description
VodSessionAd.Builder

mergeFrom(VodSessionAd other)

public VodSessionAd.Builder mergeFrom(VodSessionAd other)
Parameter
Name Description
other VodSessionAd
Returns
Type Description
VodSessionAd.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public VodSessionAd.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VodSessionAd.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public VodSessionAd.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
VodSessionAd.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final VodSessionAd.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
VodSessionAd.Builder
Overrides

removeActivityEvents(int index)

public VodSessionAd.Builder removeActivityEvents(int index)

The list of progress tracking events for the ad break. These can be of the following IAB types: MUTE, UNMUTE, PAUSE, CLICK, CLICK_THROUGH, REWIND, RESUME, ERROR, FULLSCREEN, EXIT_FULLSCREEN, EXPAND, COLLAPSE, ACCEPT_INVITATION_LINEAR, CLOSE_LINEAR, SKIP.

repeated .google.cloud.video.stitcher.v1.Event activity_events = 3;

Parameter
Name Description
index int
Returns
Type Description
VodSessionAd.Builder

setActivityEvents(int index, Event value)

public VodSessionAd.Builder setActivityEvents(int index, Event value)

The list of progress tracking events for the ad break. These can be of the following IAB types: MUTE, UNMUTE, PAUSE, CLICK, CLICK_THROUGH, REWIND, RESUME, ERROR, FULLSCREEN, EXIT_FULLSCREEN, EXPAND, COLLAPSE, ACCEPT_INVITATION_LINEAR, CLOSE_LINEAR, SKIP.

repeated .google.cloud.video.stitcher.v1.Event activity_events = 3;

Parameters
Name Description
index int
value Event
Returns
Type Description
VodSessionAd.Builder

setActivityEvents(int index, Event.Builder builderForValue)

public VodSessionAd.Builder setActivityEvents(int index, Event.Builder builderForValue)

The list of progress tracking events for the ad break. These can be of the following IAB types: MUTE, UNMUTE, PAUSE, CLICK, CLICK_THROUGH, REWIND, RESUME, ERROR, FULLSCREEN, EXIT_FULLSCREEN, EXPAND, COLLAPSE, ACCEPT_INVITATION_LINEAR, CLOSE_LINEAR, SKIP.

repeated .google.cloud.video.stitcher.v1.Event activity_events = 3;

Parameters
Name Description
index int
builderForValue Event.Builder
Returns
Type Description
VodSessionAd.Builder

setCompanionAds(CompanionAds value)

public VodSessionAd.Builder setCompanionAds(CompanionAds value)

Metadata of companion ads associated with the ad.

.google.cloud.video.stitcher.v1.CompanionAds companion_ads = 2;

Parameter
Name Description
value CompanionAds
Returns
Type Description
VodSessionAd.Builder

setCompanionAds(CompanionAds.Builder builderForValue)

public VodSessionAd.Builder setCompanionAds(CompanionAds.Builder builderForValue)

Metadata of companion ads associated with the ad.

.google.cloud.video.stitcher.v1.CompanionAds companion_ads = 2;

Parameter
Name Description
builderForValue CompanionAds.Builder
Returns
Type Description
VodSessionAd.Builder

setDuration(Duration value)

public VodSessionAd.Builder setDuration(Duration value)

Duration in seconds of the ad.

.google.protobuf.Duration duration = 1;

Parameter
Name Description
value Duration
Returns
Type Description
VodSessionAd.Builder

setDuration(Duration.Builder builderForValue)

public VodSessionAd.Builder setDuration(Duration.Builder builderForValue)

Duration in seconds of the ad.

.google.protobuf.Duration duration = 1;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
VodSessionAd.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public VodSessionAd.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
VodSessionAd.Builder
Overrides

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

public VodSessionAd.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
VodSessionAd.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final VodSessionAd.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
VodSessionAd.Builder
Overrides