Class VodSessionAd (0.29.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
TypeDescription
int

COMPANION_ADS_FIELD_NUMBER

public static final int COMPANION_ADS_FIELD_NUMBER
Field Value
TypeDescription
int

DURATION_FIELD_NUMBER

public static final int DURATION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static VodSessionAd getDefaultInstance()
Returns
TypeDescription
VodSessionAd

getDescriptor()

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

newBuilder()

public static VodSessionAd.Builder newBuilder()
Returns
TypeDescription
VodSessionAd.Builder

newBuilder(VodSessionAd prototype)

public static VodSessionAd.Builder newBuilder(VodSessionAd prototype)
Parameter
NameDescription
prototypeVodSessionAd
Returns
TypeDescription
VodSessionAd.Builder

parseDelimitedFrom(InputStream input)

public static VodSessionAd parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
VodSessionAd
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VodSessionAd parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VodSessionAd
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static VodSessionAd parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
VodSessionAd
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static VodSessionAd parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VodSessionAd
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static VodSessionAd parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
VodSessionAd
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static VodSessionAd parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VodSessionAd
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static VodSessionAd parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
VodSessionAd
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static VodSessionAd parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VodSessionAd
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static VodSessionAd parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
VodSessionAd
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VodSessionAd parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VodSessionAd
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static VodSessionAd parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
VodSessionAd
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static VodSessionAd parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VodSessionAd
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<VodSessionAd> parser()
Returns
TypeDescription
Parser<VodSessionAd>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
CompanionAdsOrBuilder

getDefaultInstanceForType()

public VodSessionAd getDefaultInstanceForType()
Returns
TypeDescription
VodSessionAd

getDuration()

public Duration getDuration()

Duration in seconds of the ad.

.google.protobuf.Duration duration = 1;

Returns
TypeDescription
Duration

The duration.

getDurationOrBuilder()

public DurationOrBuilder getDurationOrBuilder()

Duration in seconds of the ad.

.google.protobuf.Duration duration = 1;

Returns
TypeDescription
DurationOrBuilder

getParserForType()

public Parser<VodSessionAd> getParserForType()
Returns
TypeDescription
Parser<VodSessionAd>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasCompanionAds()

public boolean hasCompanionAds()

Metadata of companion ads associated with the ad.

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

Returns
TypeDescription
boolean

Whether the companionAds field is set.

hasDuration()

public boolean hasDuration()

Duration in seconds of the ad.

.google.protobuf.Duration duration = 1;

Returns
TypeDescription
boolean

Whether the duration field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public VodSessionAd.Builder newBuilderForType()
Returns
TypeDescription
VodSessionAd.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected VodSessionAd.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
VodSessionAd.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public VodSessionAd.Builder toBuilder()
Returns
TypeDescription
VodSessionAd.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException