GoogleApi.CloudResourceManager.V3.Model.TagKey (google_api_cloud_resource_manager v0.44.1)

View Source

A TagKey, used to group a set of TagValues.

Attributes

  • createTime (type: DateTime.t, default: nil) - Output only. Creation time.
  • description (type: String.t, default: nil) - Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write.
  • etag (type: String.t, default: nil) - Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.
  • name (type: String.t, default: nil) - 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.
  • namespacedName (type: String.t, default: nil) - Output only. Immutable. Namespaced name of the TagKey.
  • parent (type: String.t, default: nil) - 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 (type: String.t, default: nil) - 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.
  • purposeData (type: map(), default: nil) - 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.
  • shortName (type: String.t, default: nil) - 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.
  • updateTime (type: DateTime.t, default: nil) - Output only. Update time.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.CloudResourceManager.V3.Model.TagKey{
  createTime: DateTime.t() | nil,
  description: String.t() | nil,
  etag: String.t() | nil,
  name: String.t() | nil,
  namespacedName: String.t() | nil,
  parent: String.t() | nil,
  purpose: String.t() | nil,
  purposeData: map() | nil,
  shortName: String.t() | nil,
  updateTime: DateTime.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.