Class CmsMetadataKey (0.39.0)

public final class CmsMetadataKey extends GeneratedMessageV3 implements CmsMetadataKeyOrBuilder

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

Protobuf type google.ads.admanager.v1.CmsMetadataKey

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

Static Methods

getDefaultInstance()

public static CmsMetadataKey getDefaultInstance()
Returns
Type Description
CmsMetadataKey

getDescriptor()

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

newBuilder()

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

newBuilder(CmsMetadataKey prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public CmsMetadataKey getDefaultInstanceForType()
Returns
Type Description
CmsMetadataKey

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.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CmsMetadataKey.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CmsMetadataKey.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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