TagKey (Cloud Resource Manager API v3-rev20230219-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.cloudresourcemanager.v3.model.TagKey

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class TagKey
extends com.google.api.client.json.GenericJson
```
A TagKey, used to group a set of TagValues.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Resource Manager API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

TagKey()

Constructors
Constructor and Description
`TagKey()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TagKey`	`clone()`
`String`	`getCreateTime()` Output only.
`String`	`getDescription()` Optional.
`String`	`getEtag()` Optional.
`String`	`getName()` Immutable.
`String`	`getNamespacedName()` Output only.
`String`	`getParent()` Immutable.
`String`	`getPurpose()` Optional.
`Map<String,String>`	`getPurposeData()` Optional.
`String`	`getShortName()` Required.
`String`	`getUpdateTime()` Output only.
`TagKey`	`set(String fieldName, Object value)`
`TagKey`	`setCreateTime(String createTime)` Output only.
`TagKey`	`setDescription(String description)` Optional.
`TagKey`	`setEtag(String etag)` Optional.
`TagKey`	`setName(String name)` Immutable.
`TagKey`	`setNamespacedName(String namespacedName)` Output only.
`TagKey`	`setParent(String parent)` Immutable.
`TagKey`	`setPurpose(String purpose)` Optional.
`TagKey`	`setPurposeData(Map<String,String> purposeData)` Optional.
`TagKey`	`setShortName(String shortName)` Required.
`TagKey`	`setUpdateTime(String updateTime)` Output only.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - TagKey
```
public TagKey()
```
- Method Detail
  - getCreateTime
```
public String getCreateTime()
```
    Output only. Creation time.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public TagKey setCreateTime(String createTime)
```
    Output only. Creation time.
    
    Parameters:
    
    createTime - createTime or null for none
  - getDescription
```
public String getDescription()
```
    Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write.
    
    Returns:
    
    value or null for none
  - setDescription
```
public TagKey setDescription(String description)
```
    Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write.
    
    Parameters:
    
    description - description or null for none
  - getEtag
```
public String getEtag()
```
    Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.
    
    Returns:
    
    value or null for none
  - setEtag
```
public TagKey setEtag(String etag)
```
    Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.
    
    Parameters:
    
    etag - etag or null for none
  - getName
```
public String getName()
```
    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:
    
    value or null for none
  - setName
```
public TagKey setName(String 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.
    
    Parameters:
    
    name - name or null for none
  - getNamespacedName
```
public String getNamespacedName()
```
    Output only. Immutable. Namespaced name of the TagKey.
    
    Returns:
    
    value or null for none
  - setNamespacedName
```
public TagKey setNamespacedName(String namespacedName)
```
    Output only. Immutable. Namespaced name of the TagKey.
    
    Parameters:
    
    namespacedName - namespacedName or null for none
  - getParent
```
public String getParent()
```
    Immutable. The resource name of the new TagKey's parent. Must be of the form `organizations/{org_id}`.
    
    Returns:
    
    value or null for none
  - setParent
```
public TagKey setParent(String parent)
```
    Immutable. The resource name of the new TagKey's parent. Must be of the form `organizations/{org_id}`.
    
    Parameters:
    
    parent - parent or null for none
  - getPurpose
```
public String getPurpose()
```
    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:
    
    value or null for none
  - setPurpose
```
public TagKey setPurpose(String 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.
    
    Parameters:
    
    purpose - purpose or null for none
  - getPurposeData
```
public Map<String,String> getPurposeData()
```
    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:
    
    value or null for none
  - setPurposeData
```
public TagKey setPurposeData(Map<String,String> 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.
    
    Parameters:
    
    purposeData - purposeData or null for none
  - getShortName
```
public String getShortName()
```
    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:
    
    value or null for none
  - setShortName
```
public TagKey setShortName(String shortName)
```
    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.
    
    Parameters:
    
    shortName - shortName or null for none
  - getUpdateTime
```
public String getUpdateTime()
```
    Output only. Update time.
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public TagKey setUpdateTime(String updateTime)
```
    Output only. Update time.
    
    Parameters:
    
    updateTime - updateTime or null for none
  - set
```
public TagKey set(String fieldName,
                  Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public TagKey clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class TagKey

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

TagKey

Method Detail

getCreateTime

setCreateTime

getDescription

setDescription

getEtag

setEtag

getName

setName

getNamespacedName

setNamespacedName

getParent

setParent

getPurpose

setPurpose

getPurposeData

setPurposeData

getShortName

setShortName

getUpdateTime

setUpdateTime

set

clone