Class CompanionAds (0.42.0)

public final class CompanionAds extends GeneratedMessageV3 implements CompanionAdsOrBuilder

Metadata for companion ads.

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

Static Fields

COMPANIONS_FIELD_NUMBER

public static final int COMPANIONS_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_REQUIREMENT_FIELD_NUMBER

public static final int DISPLAY_REQUIREMENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CompanionAds getDefaultInstance()
Returns
Type Description
CompanionAds

getDescriptor()

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

newBuilder()

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

newBuilder(CompanionAds prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCompanions(int index)

public Companion getCompanions(int index)

List of companion ads.

repeated .google.cloud.video.stitcher.v1.Companion companions = 2;

Parameter
Name Description
index int
Returns
Type Description
Companion

getCompanionsCount()

public int getCompanionsCount()

List of companion ads.

repeated .google.cloud.video.stitcher.v1.Companion companions = 2;

Returns
Type Description
int

getCompanionsList()

public List<Companion> getCompanionsList()

List of companion ads.

repeated .google.cloud.video.stitcher.v1.Companion companions = 2;

Returns
Type Description
List<Companion>

getCompanionsOrBuilder(int index)

public CompanionOrBuilder getCompanionsOrBuilder(int index)

List of companion ads.

repeated .google.cloud.video.stitcher.v1.Companion companions = 2;

Parameter
Name Description
index int
Returns
Type Description
CompanionOrBuilder

getCompanionsOrBuilderList()

public List<? extends CompanionOrBuilder> getCompanionsOrBuilderList()

List of companion ads.

repeated .google.cloud.video.stitcher.v1.Companion companions = 2;

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

getDefaultInstanceForType()

public CompanionAds getDefaultInstanceForType()
Returns
Type Description
CompanionAds

getDisplayRequirement()

public CompanionAds.DisplayRequirement getDisplayRequirement()

Indicates how many of the companions should be displayed with the ad.

.google.cloud.video.stitcher.v1.CompanionAds.DisplayRequirement display_requirement = 1;

Returns
Type Description
CompanionAds.DisplayRequirement

The displayRequirement.

getDisplayRequirementValue()

public int getDisplayRequirementValue()

Indicates how many of the companions should be displayed with the ad.

.google.cloud.video.stitcher.v1.CompanionAds.DisplayRequirement display_requirement = 1;

Returns
Type Description
int

The enum numeric value on the wire for displayRequirement.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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