Interface TagKeyOrBuilder (1.55.0)

Version 1.55.0

• 1.56.0 (latest)
• 1.55.0
• 1.54.0
• 1.53.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.6
• 1.4.0
• 1.3.2
• 1.2.12

public interface TagKeyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsPurposeData(String key)

public abstract 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

Returns
Type	Description
boolean

getCreateTime()

public abstract 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 abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Creation time.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getDescription()

public abstract 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 abstract 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()

public abstract 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];

Returns
Type	Description
String	The etag.

getEtagBytes()

public abstract 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()

public abstract 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];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getPurpose()

public abstract 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 abstract Map<String,String> getPurposeData()

Use #getPurposeDataMap() instead.

Returns
Type	Description
Map<String,String>

getPurposeDataCount()

public abstract 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 abstract 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];

Returns
Type	Description
Map<String,String>

getPurposeDataOrDefault(String key, String defaultValue)

public abstract 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];

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getPurposeDataOrThrow(String key)

public abstract 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

Returns
Type	Description
String

getPurposeValue()

public abstract 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.

getShortName()

public abstract 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 abstract 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 abstract 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 abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Update time.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

hasCreateTime()

public abstract 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 abstract 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.