public final class TagKey extends com.google.protobuf.GeneratedMessageV3 implements TagKeyOrBuilder
A TagKey, used to group a set of TagValues.Protobuf type
google.cloud.resourcemanager.v3.TagKey| Modifier and Type | Class and Description |
|---|---|
static class |
TagKey.Builder
A TagKey, used to group a set of TagValues.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
CREATE_TIME_FIELD_NUMBER |
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
ETAG_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
NAMESPACED_NAME_FIELD_NUMBER |
static int |
PARENT_FIELD_NUMBER |
static int |
PURPOSE_DATA_FIELD_NUMBER |
static int |
PURPOSE_FIELD_NUMBER |
static int |
SHORT_NAME_FIELD_NUMBER |
static int |
UPDATE_TIME_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsPurposeData(String key)
Optional.
|
boolean |
equals(Object obj) |
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
static TagKey |
getDefaultInstance() |
TagKey |
getDefaultInstanceForType() |
String |
getDescription()
Optional.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
Optional.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getEtag()
Optional.
|
com.google.protobuf.ByteString |
getEtagBytes()
Optional.
|
String |
getName()
Immutable.
|
com.google.protobuf.ByteString |
getNameBytes()
Immutable.
|
String |
getNamespacedName()
Output only.
|
com.google.protobuf.ByteString |
getNamespacedNameBytes()
Output only.
|
String |
getParent()
Immutable.
|
com.google.protobuf.ByteString |
getParentBytes()
Immutable.
|
com.google.protobuf.Parser<TagKey> |
getParserForType() |
Purpose |
getPurpose()
Optional.
|
Map<String,String> |
getPurposeData()
Deprecated.
|
int |
getPurposeDataCount()
Optional.
|
Map<String,String> |
getPurposeDataMap()
Optional.
|
String |
getPurposeDataOrDefault(String key,
String defaultValue)
Optional.
|
String |
getPurposeDataOrThrow(String key)
Optional.
|
int |
getPurposeValue()
Optional.
|
int |
getSerializedSize() |
String |
getShortName()
Required.
|
com.google.protobuf.ByteString |
getShortNameBytes()
Required.
|
com.google.protobuf.Timestamp |
getUpdateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getUpdateTimeOrBuilder()
Output only.
|
boolean |
hasCreateTime()
Output only.
|
int |
hashCode() |
boolean |
hasUpdateTime()
Output only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapFieldReflectionAccessor |
internalGetMapFieldReflection(int number) |
boolean |
isInitialized() |
static TagKey.Builder |
newBuilder() |
static TagKey.Builder |
newBuilder(TagKey prototype) |
TagKey.Builder |
newBuilderForType() |
protected TagKey.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static TagKey |
parseDelimitedFrom(InputStream input) |
static TagKey |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static TagKey |
parseFrom(byte[] data) |
static TagKey |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static TagKey |
parseFrom(ByteBuffer data) |
static TagKey |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static TagKey |
parseFrom(com.google.protobuf.ByteString data) |
static TagKey |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static TagKey |
parseFrom(com.google.protobuf.CodedInputStream input) |
static TagKey |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static TagKey |
parseFrom(InputStream input) |
static TagKey |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<TagKey> |
parser() |
TagKey.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
public static final int SHORT_NAME_FIELD_NUMBER
public static final int NAMESPACED_NAME_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
public static final int PURPOSE_FIELD_NUMBER
public static final int PURPOSE_DATA_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getName()
Immutable. The resource name for a TagKey. Must be in the format
`tagKeys/{tag_key_id}`, where `tag_key_id` is the generated numeric id for
the TagKey.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];getName in interface TagKeyOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Immutable. The resource name for a TagKey. Must be in the format
`tagKeys/{tag_key_id}`, where `tag_key_id` is the generated numeric id for
the TagKey.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];getNameBytes in interface TagKeyOrBuilderpublic String getParent()
Immutable. The resource name of the TagKey's parent. A TagKey can be
parented by an Organization or a Project. For a TagKey parented by an
Organization, its parent must be in the form `organizations/{org_id}`. For
a TagKey parented by a Project, its parent can be in the form
`projects/{project_id}` or `projects/{project_number}`.
string parent = 2 [(.google.api.field_behavior) = IMMUTABLE];getParent in interface TagKeyOrBuilderpublic com.google.protobuf.ByteString getParentBytes()
Immutable. The resource name of the TagKey's parent. A TagKey can be
parented by an Organization or a Project. For a TagKey parented by an
Organization, its parent must be in the form `organizations/{org_id}`. For
a TagKey parented by a Project, its parent can be in the form
`projects/{project_id}` or `projects/{project_number}`.
string parent = 2 [(.google.api.field_behavior) = IMMUTABLE];getParentBytes in interface TagKeyOrBuilderpublic String getShortName()
Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace. The short name must be 1-63 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.
string short_name = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
getShortName in interface TagKeyOrBuilderpublic com.google.protobuf.ByteString getShortNameBytes()
Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace. The short name must be 1-63 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.
string short_name = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
getShortNameBytes in interface TagKeyOrBuilderpublic String getNamespacedName()
Output only. Immutable. Namespaced name of the TagKey.
string namespaced_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
getNamespacedName in interface TagKeyOrBuilderpublic com.google.protobuf.ByteString getNamespacedNameBytes()
Output only. Immutable. Namespaced name of the TagKey.
string namespaced_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
getNamespacedNameBytes in interface TagKeyOrBuilderpublic String getDescription()
Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write.
string description = 5 [(.google.api.field_behavior) = OPTIONAL];getDescription in interface TagKeyOrBuilderpublic com.google.protobuf.ByteString getDescriptionBytes()
Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write.
string description = 5 [(.google.api.field_behavior) = OPTIONAL];getDescriptionBytes in interface TagKeyOrBuilderpublic boolean hasCreateTime()
Output only. Creation time.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime in interface TagKeyOrBuilderpublic com.google.protobuf.Timestamp getCreateTime()
Output only. Creation time.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTime in interface TagKeyOrBuilderpublic com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Creation time.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder in interface TagKeyOrBuilderpublic boolean hasUpdateTime()
Output only. Update time.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasUpdateTime in interface TagKeyOrBuilderpublic com.google.protobuf.Timestamp getUpdateTime()
Output only. Update time.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTime in interface TagKeyOrBuilderpublic com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Update time.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder in interface TagKeyOrBuilderpublic String getEtag()
Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.
string etag = 8 [(.google.api.field_behavior) = OPTIONAL];getEtag in interface TagKeyOrBuilderpublic com.google.protobuf.ByteString getEtagBytes()
Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.
string etag = 8 [(.google.api.field_behavior) = OPTIONAL];getEtagBytes in interface TagKeyOrBuilderpublic int getPurposeValue()
Optional. A purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. A purpose does not grant a policy engine exclusive rights to the Tag, and it may be referenced by other policy engines. A purpose cannot be changed once set.
.google.cloud.resourcemanager.v3.Purpose purpose = 11 [(.google.api.field_behavior) = OPTIONAL];
getPurposeValue in interface TagKeyOrBuilderpublic Purpose getPurpose()
Optional. A purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. A purpose does not grant a policy engine exclusive rights to the Tag, and it may be referenced by other policy engines. A purpose cannot be changed once set.
.google.cloud.resourcemanager.v3.Purpose purpose = 11 [(.google.api.field_behavior) = OPTIONAL];
getPurpose in interface TagKeyOrBuilderpublic int getPurposeDataCount()
TagKeyOrBuilderOptional. Purpose data corresponds to the policy system that the tag is intended for. See documentation for `Purpose` for formatting of this field. Purpose data cannot be changed once set.
map<string, string> purpose_data = 12 [(.google.api.field_behavior) = OPTIONAL];
getPurposeDataCount in interface TagKeyOrBuilderpublic boolean containsPurposeData(String key)
Optional. Purpose data corresponds to the policy system that the tag is intended for. See documentation for `Purpose` for formatting of this field. Purpose data cannot be changed once set.
map<string, string> purpose_data = 12 [(.google.api.field_behavior) = OPTIONAL];
containsPurposeData in interface TagKeyOrBuilder@Deprecated public Map<String,String> getPurposeData()
getPurposeDataMap() instead.getPurposeData in interface TagKeyOrBuilderpublic Map<String,String> getPurposeDataMap()
Optional. Purpose data corresponds to the policy system that the tag is intended for. See documentation for `Purpose` for formatting of this field. Purpose data cannot be changed once set.
map<string, string> purpose_data = 12 [(.google.api.field_behavior) = OPTIONAL];
getPurposeDataMap in interface TagKeyOrBuilderpublic String getPurposeDataOrDefault(String key, String defaultValue)
Optional. Purpose data corresponds to the policy system that the tag is intended for. See documentation for `Purpose` for formatting of this field. Purpose data cannot be changed once set.
map<string, string> purpose_data = 12 [(.google.api.field_behavior) = OPTIONAL];
getPurposeDataOrDefault in interface TagKeyOrBuilderpublic String getPurposeDataOrThrow(String key)
Optional. Purpose data corresponds to the policy system that the tag is intended for. See documentation for `Purpose` for formatting of this field. Purpose data cannot be changed once set.
map<string, string> purpose_data = 12 [(.google.api.field_behavior) = OPTIONAL];
getPurposeDataOrThrow in interface TagKeyOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static TagKey parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TagKey parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TagKey parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TagKey parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TagKey parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TagKey parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TagKey parseFrom(InputStream input) throws IOException
IOExceptionpublic static TagKey parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static TagKey parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static TagKey parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static TagKey parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static TagKey parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic TagKey.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static TagKey.Builder newBuilder()
public static TagKey.Builder newBuilder(TagKey prototype)
public TagKey.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected TagKey.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static TagKey getDefaultInstance()
public static com.google.protobuf.Parser<TagKey> parser()
public com.google.protobuf.Parser<TagKey> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public TagKey getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2025 Google LLC. All rights reserved.