public final class TagKey extends GeneratedMessageV3 implements TagKeyOrBuilder
A TagKey, used to group a set of TagValues.
Protobuf type google.cloud.resourcemanager.v3.TagKey
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAMESPACED_NAME_FIELD_NUMBER
public static final int NAMESPACED_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PURPOSE_DATA_FIELD_NUMBER
public static final int PURPOSE_DATA_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PURPOSE_FIELD_NUMBER
public static final int PURPOSE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SHORT_NAME_FIELD_NUMBER
public static final int SHORT_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static TagKey getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static TagKey.Builder newBuilder()
newBuilder(TagKey prototype)
public static TagKey.Builder newBuilder(TagKey prototype)
| Parameter |
|---|
| Name | Description |
prototype | TagKey
|
public static TagKey parseDelimitedFrom(InputStream input)
public static TagKey parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static TagKey parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TagKey parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static TagKey parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TagKey parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TagKey parseFrom(CodedInputStream input)
public static TagKey parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static TagKey parseFrom(InputStream input)
public static TagKey parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static TagKey parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TagKey parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<TagKey> parser()
Methods
containsPurposeData(String key)
public 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];
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getCreateTime()
public Timestamp getCreateTime()
Output only. Creation time.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Creation time.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public TagKey getDefaultInstanceForType()
getDescription()
public String getDescription()
Optional. User-assigned description of the TagKey. Must not exceed 256
characters.
Read-write.
string description = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. User-assigned description of the TagKey. Must not exceed 256
characters.
Read-write.
string description = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for description.
|
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];
| Returns |
|---|
| Type | Description |
String | The etag.
|
getEtagBytes()
public 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];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for etag.
|
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];
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public 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];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getNamespacedName()
public 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];
| Returns |
|---|
| Type | Description |
String | The namespacedName.
|
getNamespacedNameBytes()
public 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];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for namespacedName.
|
getParent()
public 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];
| Returns |
|---|
| Type | Description |
String | The parent.
|
getParentBytes()
public 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];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for parent.
|
getParserForType()
public Parser<TagKey> getParserForType()
Overrides
getPurpose()
public 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];
| Returns |
|---|
| Type | Description |
Purpose | The purpose.
|
getPurposeData() (deprecated)
public Map<String,String> getPurposeData()
getPurposeDataCount()
public int getPurposeDataCount()
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];
| Returns |
|---|
| Type | Description |
int | |
getPurposeDataMap()
public 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];
getPurposeDataOrDefault(String key, String defaultValue)
public 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];
getPurposeDataOrThrow(String key)
public 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];
| Parameter |
|---|
| Name | Description |
key | String
|
getPurposeValue()
public 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];
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for purpose.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getShortName()
public 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];
| Returns |
|---|
| Type | Description |
String | The shortName.
|
getShortNameBytes()
public 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];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for shortName.
|
getUpdateTime()
public Timestamp getUpdateTime()
Output only. Update time.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Update time.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public boolean hasCreateTime()
Output only. Creation time.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the createTime field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. Update time.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
| Returns |
|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor | |
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public TagKey.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TagKey.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public TagKey.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
