com.google.api.services.cloudkms.v1.model

Class AutokeyConfig

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.cloudkms.v1.model.AutokeyConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class AutokeyConfig
extends com.google.api.client.json.GenericJson

Cloud KMS Autokey configuration for a folder.

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 Key Management Service (KMS) 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
AutokeyConfig()

Method Summary

Modifier and Type	Method and Description
AutokeyConfig	clone()
String	getEtag() Optional.
String	getKeyProject() Optional.
String	getKeyProjectResolutionMode() Optional.
String	getName() Identifier.
String	getState() Output only.
AutokeyConfig	set(String fieldName, Object value)
AutokeyConfig	setEtag(String etag) Optional.
AutokeyConfig	setKeyProject(String keyProject) Optional.
AutokeyConfig	setKeyProjectResolutionMode(String keyProjectResolutionMode) Optional.
AutokeyConfig	setName(String name) Identifier.
AutokeyConfig	setState(String state) 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

AutokeyConfig

public AutokeyConfig()

Method Detail

getEtag

public String getEtag()

Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag.

Returns:

value or null for none

setEtag

public AutokeyConfig setEtag(String etag)

Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag.

Parameters:

etag - etag or null for none

getKeyProject

public String getKeyProject()

Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration.

Returns:

value or null for none

setKeyProject

public AutokeyConfig setKeyProject(String keyProject)

Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration.

Parameters:

keyProject - keyProject or null for none

getKeyProjectResolutionMode

public String getKeyProjectResolutionMode()

Optional. KeyProjectResolutionMode for the AutokeyConfig. Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or `DISABLED`.

Returns:

value or null for none

setKeyProjectResolutionMode

public AutokeyConfig setKeyProjectResolutionMode(String keyProjectResolutionMode)

Optional. KeyProjectResolutionMode for the AutokeyConfig. Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or `DISABLED`.

Parameters:

keyProjectResolutionMode - keyProjectResolutionMode or null for none

getName

public String getName()

Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`, `projects/{PROJECT_NUMBER}/autokeyConfig`, or `projects/{PROJECT_ID}/autokeyConfig`.

Returns:

value or null for none

setName

public AutokeyConfig setName(String name)

Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`, `projects/{PROJECT_NUMBER}/autokeyConfig`, or `projects/{PROJECT_ID}/autokeyConfig`.

Parameters:

name - name or null for none

getState

public String getState()

Output only. The state for the AutokeyConfig.

Returns:

value or null for none

setState

public AutokeyConfig setState(String state)

Output only. The state for the AutokeyConfig.

Parameters:

state - state or null for none

set

public AutokeyConfig set(String fieldName,
                         Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public AutokeyConfig clone()

Overrides:

clone in class com.google.api.client.json.GenericJson