TagKeyArgs class

The set of arguments for TagKey. The set of arguments for TagKey.

Constructors

TagKeyArgs({Input<String>? description, Input<String>? etag, Input<String>? name, Input<String>? parent, Input<TagKeyPurpose>? purpose, Input<Map<String, String>>? purposeData, required Input<String> shortName})
Creates a new TagKeyArgs. description Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write. etag Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details. name 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. parent 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 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 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 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.
const
TagKeyArgs.fromMap(Map<String, dynamic> map)
factory

Properties

description → Input<String>?
Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write.
final
etag → Input<String>?
Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.
final
hashCode → int
The hash code for this object.
no setterinherited
name → Input<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.
final
parent → Input<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}.
final
purpose → Input<TagKeyPurpose>?
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.
final
purposeData → Input<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.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shortName → Input<String>
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.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited