Class CmsMetadataKey.Builder (0.44.0)

public static final class CmsMetadataKey.Builder extends GeneratedMessage.Builder<CmsMetadataKey.Builder> implements CmsMetadataKeyOrBuilder

Key associated with a piece of content from a publisher's CMS.

Protobuf type google.ads.admanager.v1.CmsMetadataKey

Static Methods

getDescriptor()

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

Methods

build()

public CmsMetadataKey build()
Returns
Type Description
CmsMetadataKey

buildPartial()

public CmsMetadataKey buildPartial()
Returns
Type Description
CmsMetadataKey

clear()

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

clearDisplayName()

public CmsMetadataKey.Builder clearDisplayName()

Required. The key of a key-value pair.

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

Returns
Type Description
CmsMetadataKey.Builder

This builder for chaining.

clearName()

public CmsMetadataKey.Builder clearName()

Identifier. The resource name of the CmsMetadataKey. Format: networks/{network_code}/cmsMetadataKeys/{cms_metadata_key_id}

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

Returns
Type Description
CmsMetadataKey.Builder

This builder for chaining.

clearStatus()

public CmsMetadataKey.Builder clearStatus()

Output only. The status of this CMS metadata key.

.google.ads.admanager.v1.CmsMetadataKeyStatusEnum.CmsMetadataKeyStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CmsMetadataKey.Builder

This builder for chaining.

getDefaultInstanceForType()

public CmsMetadataKey getDefaultInstanceForType()
Returns
Type Description
CmsMetadataKey

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

Required. The key of a key-value pair.

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The key of a key-value pair.

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

Returns
Type Description
ByteString

The bytes for displayName.

getName()

public String getName()

Identifier. The resource name of the CmsMetadataKey. Format: networks/{network_code}/cmsMetadataKeys/{cms_metadata_key_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 CmsMetadataKey. Format: networks/{network_code}/cmsMetadataKeys/{cms_metadata_key_id}

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

Returns
Type Description
ByteString

The bytes for name.

getStatus()

public CmsMetadataKeyStatusEnum.CmsMetadataKeyStatus getStatus()

Output only. The status of this CMS metadata key.

.google.ads.admanager.v1.CmsMetadataKeyStatusEnum.CmsMetadataKeyStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CmsMetadataKeyStatusEnum.CmsMetadataKeyStatus

The status.

getStatusValue()

public int getStatusValue()

Output only. The status of this CMS metadata key.

.google.ads.admanager.v1.CmsMetadataKeyStatusEnum.CmsMetadataKeyStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for status.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CmsMetadataKey other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setDisplayName(String value)

public CmsMetadataKey.Builder setDisplayName(String value)

Required. The key of a key-value pair.

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

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
CmsMetadataKey.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public CmsMetadataKey.Builder setDisplayNameBytes(ByteString value)

Required. The key of a key-value pair.

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
CmsMetadataKey.Builder

This builder for chaining.

setName(String value)

public CmsMetadataKey.Builder setName(String value)

Identifier. The resource name of the CmsMetadataKey. Format: networks/{network_code}/cmsMetadataKeys/{cms_metadata_key_id}

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
CmsMetadataKey.Builder

This builder for chaining.

setNameBytes(ByteString value)

public CmsMetadataKey.Builder setNameBytes(ByteString value)

Identifier. The resource name of the CmsMetadataKey. Format: networks/{network_code}/cmsMetadataKeys/{cms_metadata_key_id}

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
CmsMetadataKey.Builder

This builder for chaining.

setStatus(CmsMetadataKeyStatusEnum.CmsMetadataKeyStatus value)

public CmsMetadataKey.Builder setStatus(CmsMetadataKeyStatusEnum.CmsMetadataKeyStatus value)

Output only. The status of this CMS metadata key.

.google.ads.admanager.v1.CmsMetadataKeyStatusEnum.CmsMetadataKeyStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value CmsMetadataKeyStatusEnum.CmsMetadataKeyStatus

The status to set.

Returns
Type Description
CmsMetadataKey.Builder

This builder for chaining.

setStatusValue(int value)

public CmsMetadataKey.Builder setStatusValue(int value)

Output only. The status of this CMS metadata key.

.google.ads.admanager.v1.CmsMetadataKeyStatusEnum.CmsMetadataKeyStatus status = 4 [(.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
CmsMetadataKey.Builder

This builder for chaining.