Class Slate (0.54.0)

public final class Slate extends GeneratedMessage implements SlateOrBuilder

A Slate encapsulates all the information necessary to represent a Slate entity, the video creative used by Dynamic Ad Insertion to fill vacant ad slots.

Protobuf type google.ads.admanager.v1.Slate

Implements

SlateOrBuilder

Static Fields

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

TRANSCODE_STATUS_FIELD_NUMBER

public static final int TRANSCODE_STATUS_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

VIDEO_SOURCE_URL_FIELD_NUMBER

public static final int VIDEO_SOURCE_URL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Slate getDefaultInstance()
Returns
Type Description
Slate

getDescriptor()

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

newBuilder()

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

newBuilder(Slate prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Slate getDefaultInstanceForType()
Returns
Type Description
Slate

getDisplayName()

public String getDisplayName()

Required. The display name of the Slate. It has a maximum length of 255 characters.

optional string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The display name of the Slate. It has a maximum length of 255 characters.

optional string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getName()

public String getName()

Identifier. The resource name of the Slate. Format: networks/{network_code}/slates/{slate_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the Slate. Format: networks/{network_code}/slates/{slate_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStatus()

public SlateStatusEnum.SlateStatus getStatus()

Output only. The status of this Slate. Slates are created in the [SlateStatus.ACTIVE][] state.

optional .google.ads.admanager.v1.SlateStatusEnum.SlateStatus status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SlateStatusEnum.SlateStatus

The status.

getStatusValue()

public int getStatusValue()

Output only. The status of this Slate. Slates are created in the [SlateStatus.ACTIVE][] state.

optional .google.ads.admanager.v1.SlateStatusEnum.SlateStatus status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for status.

getTranscodeStatus()

public VideoTranscodeStatusEnum.VideoTranscodeStatus getTranscodeStatus()

Output only. Server side transcoding status of the current slate.

optional .google.ads.admanager.v1.VideoTranscodeStatusEnum.VideoTranscodeStatus transcode_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
VideoTranscodeStatusEnum.VideoTranscodeStatus

The transcodeStatus.

getTranscodeStatusValue()

public int getTranscodeStatusValue()

Output only. Server side transcoding status of the current slate.

optional .google.ads.admanager.v1.VideoTranscodeStatusEnum.VideoTranscodeStatus transcode_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for transcodeStatus.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The date and time this slate was last modified.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The date and time this slate was last modified.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getVideoSourceUrl()

public String getVideoSourceUrl()

Optional. The location of the original asset if publisher provided and slate is externally hosted.

optional string video_source_url = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The videoSourceUrl.

getVideoSourceUrlBytes()

public ByteString getVideoSourceUrlBytes()

Optional. The location of the original asset if publisher provided and slate is externally hosted.

optional string video_source_url = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for videoSourceUrl.

hasDisplayName()

public boolean hasDisplayName()

Required. The display name of the Slate. It has a maximum length of 255 characters.

optional string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the displayName field is set.

hasStatus()

public boolean hasStatus()

Output only. The status of this Slate. Slates are created in the [SlateStatus.ACTIVE][] state.

optional .google.ads.admanager.v1.SlateStatusEnum.SlateStatus status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the status field is set.

hasTranscodeStatus()

public boolean hasTranscodeStatus()

Output only. Server side transcoding status of the current slate.

optional .google.ads.admanager.v1.VideoTranscodeStatusEnum.VideoTranscodeStatus transcode_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the transcodeStatus field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The date and time this slate was last modified.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hasVideoSourceUrl()

public boolean hasVideoSourceUrl()

Optional. The location of the original asset if publisher provided and slate is externally hosted.

optional string video_source_url = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the videoSourceUrl field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Slate.Builder newBuilderForType()
Returns
Type Description
Slate.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Slate.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Slate.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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