Class VodSessionAd (0.46.0)

public final class VodSessionAd extends GeneratedMessageV3 implements VodSessionAdOrBuilder

Metadata for an inserted ad in a VOD session.

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

Static Fields

ACTIVITY_EVENTS_FIELD_NUMBER

public static final int ACTIVITY_EVENTS_FIELD_NUMBER
Field Value
Type Description
int

COMPANION_ADS_FIELD_NUMBER

public static final int COMPANION_ADS_FIELD_NUMBER
Field Value
Type Description
int

DURATION_FIELD_NUMBER

public static final int DURATION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static VodSessionAd getDefaultInstance()
Returns
Type Description
VodSessionAd

getDescriptor()

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

newBuilder()

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

newBuilder(VodSessionAd prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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

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.

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

getDuration()

public Duration getDuration()

Duration in seconds of the ad.

.google.protobuf.Duration duration = 1;

Returns
Type Description
Duration

The duration.

getDurationOrBuilder()

public DurationOrBuilder getDurationOrBuilder()

Duration in seconds of the ad.

.google.protobuf.Duration duration = 1;

Returns
Type Description
DurationOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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 VodSessionAd.Builder newBuilderForType()
Returns
Type Description
VodSessionAd.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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