Class CompanionAds (0.28.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
TypeDescription
int

DISPLAY_REQUIREMENT_FIELD_NUMBER

public static final int DISPLAY_REQUIREMENT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CompanionAds getDefaultInstance()
Returns
TypeDescription
CompanionAds

getDescriptor()

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

newBuilder()

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

newBuilder(CompanionAds prototype)

public static CompanionAds.Builder newBuilder(CompanionAds prototype)
Parameter
NameDescription
prototypeCompanionAds
Returns
TypeDescription
CompanionAds.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCompanions(int index)

public Companion getCompanions(int index)

List of companion ads.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Companion

getCompanionsCount()

public int getCompanionsCount()

List of companion ads.

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

Returns
TypeDescription
int

getCompanionsList()

public List<Companion> getCompanionsList()

List of companion ads.

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

Returns
TypeDescription
List<Companion>

getCompanionsOrBuilder(int index)

public CompanionOrBuilder getCompanionsOrBuilder(int index)

List of companion ads.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
CompanionOrBuilder

getCompanionsOrBuilderList()

public List<? extends CompanionOrBuilder> getCompanionsOrBuilderList()

List of companion ads.

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

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

getDefaultInstanceForType()

public CompanionAds getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for displayRequirement.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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