Class: Google::Cloud::ResourceManager::V3::TagKey

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/resourcemanager/v3/tag_keys.rb

Overview

A TagKey, used to group a set of TagValues.

Defined Under Namespace

Classes: PurposeDataEntry

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Creation time.

Returns:



80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'proto_docs/google/cloud/resourcemanager/v3/tag_keys.rb', line 80

class TagKey
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class PurposeDataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#description ⇒ ::String

Returns 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.



80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'proto_docs/google/cloud/resourcemanager/v3/tag_keys.rb', line 80

class TagKey
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class PurposeDataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#etag ⇒ ::String

Returns 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.



80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'proto_docs/google/cloud/resourcemanager/v3/tag_keys.rb', line 80

class TagKey
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class PurposeDataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns 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.



80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'proto_docs/google/cloud/resourcemanager/v3/tag_keys.rb', line 80

class TagKey
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class PurposeDataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#namespaced_name ⇒ ::String (readonly)

Returns Output only. Immutable. Namespaced name of the TagKey.

Returns:

  • (::String) —

    Output only. Immutable. Namespaced name of the TagKey.



80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'proto_docs/google/cloud/resourcemanager/v3/tag_keys.rb', line 80

class TagKey
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class PurposeDataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#parent ⇒ ::String

Returns 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}.



80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'proto_docs/google/cloud/resourcemanager/v3/tag_keys.rb', line 80

class TagKey
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class PurposeDataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#purpose ⇒ ::Google::Cloud::ResourceManager::V3::Purpose

Returns 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.



80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'proto_docs/google/cloud/resourcemanager/v3/tag_keys.rb', line 80

class TagKey
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class PurposeDataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#purpose_data ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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.



80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'proto_docs/google/cloud/resourcemanager/v3/tag_keys.rb', line 80

class TagKey
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class PurposeDataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#short_name ⇒ ::String

Returns 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.



80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'proto_docs/google/cloud/resourcemanager/v3/tag_keys.rb', line 80

class TagKey
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class PurposeDataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Update time.

Returns:



80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'proto_docs/google/cloud/resourcemanager/v3/tag_keys.rb', line 80

class TagKey
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class PurposeDataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end