public sealed class TagKey : IMessage<TagKey>, IEquatable<TagKey>, IDeepCloneable<TagKey>, IBufferMessage, IMessage
Reference documentation and code samples for the Cloud Resource Manager v3 API class TagKey.
A TagKey, used to group a set of TagValues.
Namespace
Google.Cloud.ResourceManager.V3Assembly
Google.Cloud.ResourceManager.V3.dll
Constructors
TagKey()
public TagKey()
TagKey(TagKey)
public TagKey(TagKey other)
Parameter | |
---|---|
Name | Description |
other | TagKey |
Properties
CreateTime
public Timestamp CreateTime { get; set; }
Output only. Creation time.
Property Value | |
---|---|
Type | Description |
Timestamp |
Description
public string Description { get; set; }
Optional. User-assigned description of the TagKey. Must not exceed 256 characters.
Read-write.
Property Value | |
---|---|
Type | Description |
string |
Etag
public string Etag { get; set; }
Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.
Property Value | |
---|---|
Type | Description |
string |
Name
public string Name { get; set; }
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.
Property Value | |
---|---|
Type | Description |
string |
NamespacedName
public string NamespacedName { get; set; }
Output only. Immutable. Namespaced name of the TagKey.
Property Value | |
---|---|
Type | Description |
string |
Parent
public string Parent { get; set; }
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}
.
Property Value | |
---|---|
Type | Description |
string |
Purpose
public Purpose Purpose { get; set; }
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.
Property Value | |
---|---|
Type | Description |
Purpose |
PurposeData
public MapField<string, string> PurposeData { get; }
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.
Property Value | |
---|---|
Type | Description |
MapFieldstringstring |
ShortName
public string ShortName { get; set; }
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.
Property Value | |
---|---|
Type | Description |
string |
TagKeyName
public TagKeyName TagKeyName { get; set; }
TagKeyName-typed view over the Name resource name property.
Property Value | |
---|---|
Type | Description |
TagKeyName |
UpdateTime
public Timestamp UpdateTime { get; set; }
Output only. Update time.
Property Value | |
---|---|
Type | Description |
Timestamp |