Resource Manager V3 API - Class Google::Cloud::ResourceManager::V3::TagKey (v1.1.0)

Reference documentation and code samples for the Resource Manager V3 API class Google::Cloud::ResourceManager::V3::TagKey.

A TagKey, used to group a set of TagValues.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — Optional. User-assigned description of the TagKey. Must not exceed 256 characters.

    Read-write.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. User-assigned description of the TagKey. Must not exceed 256 characters.

    Read-write.

Returns
  • (::String) — Optional. User-assigned description of the TagKey. Must not exceed 256 characters.

    Read-write.

#etag

def etag() -> ::String
Returns
  • (::String) — Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.
Returns
  • (::String) — Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.

#name

def name() -> ::String
Returns
  • (::String) — 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.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#namespaced_name

def namespaced_name() -> ::String
Returns
  • (::String) — Output only. Immutable. Namespaced name of the TagKey.

#parent

def parent() -> ::String
Returns
  • (::String) — 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}.

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — 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}.
Returns
  • (::String) — 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}.

#purpose

def purpose() -> ::Google::Cloud::ResourceManager::V3::Purpose
Returns
  • (::Google::Cloud::ResourceManager::V3::Purpose) — 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.

#purpose=

def purpose=(value) -> ::Google::Cloud::ResourceManager::V3::Purpose
Parameter
  • value (::Google::Cloud::ResourceManager::V3::Purpose) — 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.

Returns
  • (::Google::Cloud::ResourceManager::V3::Purpose) — 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.

#purpose_data

def purpose_data() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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.

#purpose_data=

def purpose_data=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — 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.

Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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.

#short_name

def short_name() -> ::String
Returns
  • (::String) — 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.

#short_name=

def short_name=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns