Class Slate.Builder (0.54.0)

public static final class Slate.Builder extends GeneratedMessage.Builder<Slate.Builder> 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 Methods

getDescriptor()

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

Methods

build()

public Slate build()
Returns
Type Description
Slate

buildPartial()

public Slate buildPartial()
Returns
Type Description
Slate

clear()

public Slate.Builder clear()
Returns
Type Description
Slate.Builder
Overrides

clearDisplayName()

public Slate.Builder clearDisplayName()

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
Slate.Builder

This builder for chaining.

clearName()

public Slate.Builder clearName()

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
Slate.Builder

This builder for chaining.

clearStatus()

public Slate.Builder clearStatus()

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
Slate.Builder

This builder for chaining.

clearTranscodeStatus()

public Slate.Builder clearTranscodeStatus()

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
Slate.Builder

This builder for chaining.

clearUpdateTime()

public Slate.Builder clearUpdateTime()

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
Slate.Builder

clearVideoSourceUrl()

public Slate.Builder clearVideoSourceUrl()

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
Slate.Builder

This builder for chaining.

getDefaultInstanceForType()

public Slate getDefaultInstanceForType()
Returns
Type Description
Slate

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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
Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Slate other)

public Slate.Builder mergeFrom(Slate other)
Parameter
Name Description
other Slate
Returns
Type Description
Slate.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Slate.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Slate.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Slate.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Slate.Builder
Overrides

mergeUpdateTime(Timestamp value)

public Slate.Builder mergeUpdateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Slate.Builder

setDisplayName(String value)

public Slate.Builder setDisplayName(String value)

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];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
Slate.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Slate.Builder setDisplayNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
Slate.Builder

This builder for chaining.

setName(String value)

public Slate.Builder setName(String value)

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

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Slate.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Slate.Builder setNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Slate.Builder

This builder for chaining.

setStatus(SlateStatusEnum.SlateStatus value)

public Slate.Builder setStatus(SlateStatusEnum.SlateStatus value)

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];

Parameter
Name Description
value SlateStatusEnum.SlateStatus

The status to set.

Returns
Type Description
Slate.Builder

This builder for chaining.

setStatusValue(int value)

public Slate.Builder setStatusValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for status to set.

Returns
Type Description
Slate.Builder

This builder for chaining.

setTranscodeStatus(VideoTranscodeStatusEnum.VideoTranscodeStatus value)

public Slate.Builder setTranscodeStatus(VideoTranscodeStatusEnum.VideoTranscodeStatus value)

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];

Parameter
Name Description
value VideoTranscodeStatusEnum.VideoTranscodeStatus

The transcodeStatus to set.

Returns
Type Description
Slate.Builder

This builder for chaining.

setTranscodeStatusValue(int value)

public Slate.Builder setTranscodeStatusValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for transcodeStatus to set.

Returns
Type Description
Slate.Builder

This builder for chaining.

setUpdateTime(Timestamp value)

public Slate.Builder setUpdateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Slate.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Slate.Builder setUpdateTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Slate.Builder

setVideoSourceUrl(String value)

public Slate.Builder setVideoSourceUrl(String value)

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];

Parameter
Name Description
value String

The videoSourceUrl to set.

Returns
Type Description
Slate.Builder

This builder for chaining.

setVideoSourceUrlBytes(ByteString value)

public Slate.Builder setVideoSourceUrlBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for videoSourceUrl to set.

Returns
Type Description
Slate.Builder

This builder for chaining.