public static final class CmsMetadataValue.Builder extends GeneratedMessageV3.Builder<CmsMetadataValue.Builder> implements CmsMetadataValueOrBuilderKey value pair associated with a piece of content from a publisher's CMS.
Protobuf type google.ads.admanager.v1.CmsMetadataValue
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CmsMetadataValue.BuilderImplements
CmsMetadataValueOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CmsMetadataValue.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CmsMetadataValue.Builder |
|
build()
public CmsMetadataValue build()| Returns | |
|---|---|
| Type | Description |
CmsMetadataValue |
|
buildPartial()
public CmsMetadataValue buildPartial()| Returns | |
|---|---|
| Type | Description |
CmsMetadataValue |
|
clear()
public CmsMetadataValue.Builder clear()| Returns | |
|---|---|
| Type | Description |
CmsMetadataValue.Builder |
|
clearDisplayName()
public CmsMetadataValue.Builder clearDisplayName()The value of this key-value pair.
string display_name = 3;
| Returns | |
|---|---|
| Type | Description |
CmsMetadataValue.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public CmsMetadataValue.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
CmsMetadataValue.Builder |
|
clearKey()
public CmsMetadataValue.Builder clearKey()Required. Immutable. The resource name of the CmsMetadataKey. Format: "networks/{network_code}/cmsMetadataKey/{cms_metadata_key_id}"
string key = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
CmsMetadataValue.Builder |
This builder for chaining. |
clearName()
public CmsMetadataValue.Builder clearName() Identifier. The resource name of the CmsMetadataValue.
Format:
networks/{network_code}/cmsMetadataValues/{cms_metadata_value_id}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
CmsMetadataValue.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public CmsMetadataValue.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
CmsMetadataValue.Builder |
|
clearStatus()
public CmsMetadataValue.Builder clearStatus()Output only. The status of this CMS metadata value.
.google.ads.admanager.v1.CmsMetadataValueStatusEnum.CmsMetadataValueStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
CmsMetadataValue.Builder |
This builder for chaining. |
clone()
public CmsMetadataValue.Builder clone()| Returns | |
|---|---|
| Type | Description |
CmsMetadataValue.Builder |
|
getDefaultInstanceForType()
public CmsMetadataValue getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
CmsMetadataValue |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDisplayName()
public String getDisplayName()The value of this key-value pair.
string display_name = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()The value of this key-value pair.
string display_name = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getKey()
public String getKey()Required. Immutable. The resource name of the CmsMetadataKey. Format: "networks/{network_code}/cmsMetadataKey/{cms_metadata_key_id}"
string key = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The key. |
getKeyBytes()
public ByteString getKeyBytes()Required. Immutable. The resource name of the CmsMetadataKey. Format: "networks/{network_code}/cmsMetadataKey/{cms_metadata_key_id}"
string key = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for key. |
getName()
public String getName() Identifier. The resource name of the CmsMetadataValue.
Format:
networks/{network_code}/cmsMetadataValues/{cms_metadata_value_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 CmsMetadataValue.
Format:
networks/{network_code}/cmsMetadataValues/{cms_metadata_value_id}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getStatus()
public CmsMetadataValueStatusEnum.CmsMetadataValueStatus getStatus()Output only. The status of this CMS metadata value.
.google.ads.admanager.v1.CmsMetadataValueStatusEnum.CmsMetadataValueStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
CmsMetadataValueStatusEnum.CmsMetadataValueStatus |
The status. |
getStatusValue()
public int getStatusValue()Output only. The status of this CMS metadata value.
.google.ads.admanager.v1.CmsMetadataValueStatusEnum.CmsMetadataValueStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for status. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(CmsMetadataValue other)
public CmsMetadataValue.Builder mergeFrom(CmsMetadataValue other)| Parameter | |
|---|---|
| Name | Description |
other |
CmsMetadataValue |
| Returns | |
|---|---|
| Type | Description |
CmsMetadataValue.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CmsMetadataValue.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CmsMetadataValue.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public CmsMetadataValue.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
CmsMetadataValue.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CmsMetadataValue.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CmsMetadataValue.Builder |
|
setDisplayName(String value)
public CmsMetadataValue.Builder setDisplayName(String value)The value of this key-value pair.
string display_name = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
CmsMetadataValue.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public CmsMetadataValue.Builder setDisplayNameBytes(ByteString value)The value of this key-value pair.
string display_name = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
CmsMetadataValue.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public CmsMetadataValue.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CmsMetadataValue.Builder |
|
setKey(String value)
public CmsMetadataValue.Builder setKey(String value)Required. Immutable. The resource name of the CmsMetadataKey. Format: "networks/{network_code}/cmsMetadataKey/{cms_metadata_key_id}"
string key = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe key to set. |
| Returns | |
|---|---|
| Type | Description |
CmsMetadataValue.Builder |
This builder for chaining. |
setKeyBytes(ByteString value)
public CmsMetadataValue.Builder setKeyBytes(ByteString value)Required. Immutable. The resource name of the CmsMetadataKey. Format: "networks/{network_code}/cmsMetadataKey/{cms_metadata_key_id}"
string key = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for key to set. |
| Returns | |
|---|---|
| Type | Description |
CmsMetadataValue.Builder |
This builder for chaining. |
setName(String value)
public CmsMetadataValue.Builder setName(String value) Identifier. The resource name of the CmsMetadataValue.
Format:
networks/{network_code}/cmsMetadataValues/{cms_metadata_value_id}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
CmsMetadataValue.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public CmsMetadataValue.Builder setNameBytes(ByteString value) Identifier. The resource name of the CmsMetadataValue.
Format:
networks/{network_code}/cmsMetadataValues/{cms_metadata_value_id}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
CmsMetadataValue.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CmsMetadataValue.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CmsMetadataValue.Builder |
|
setStatus(CmsMetadataValueStatusEnum.CmsMetadataValueStatus value)
public CmsMetadataValue.Builder setStatus(CmsMetadataValueStatusEnum.CmsMetadataValueStatus value)Output only. The status of this CMS metadata value.
.google.ads.admanager.v1.CmsMetadataValueStatusEnum.CmsMetadataValueStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
CmsMetadataValueStatusEnum.CmsMetadataValueStatusThe status to set. |
| Returns | |
|---|---|
| Type | Description |
CmsMetadataValue.Builder |
This builder for chaining. |
setStatusValue(int value)
public CmsMetadataValue.Builder setStatusValue(int value)Output only. The status of this CMS metadata value.
.google.ads.admanager.v1.CmsMetadataValueStatusEnum.CmsMetadataValueStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for status to set. |
| Returns | |
|---|---|
| Type | Description |
CmsMetadataValue.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final CmsMetadataValue.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CmsMetadataValue.Builder |
|