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

Class SingleTenantHsmInstance

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A SingleTenantHsmInstance represents a single-tenant HSM instance. It can be used for creating CryptoKeys with a ProtectionLevel of HSM_SINGLE_TENANT, as well as performing cryptographic operations using keys created within the SingleTenantHsmInstance.

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
SingleTenantHsmInstance()

Method Summary

Modifier and Type	Method and Description
SingleTenantHsmInstance	clone()
String	getCreateTime() Output only.
String	getDeleteTime() Output only.
String	getDisableTime() Output only.
Boolean	getKeyPortabilityEnabled() Optional.
String	getName() Identifier.
QuorumAuth	getQuorumAuth() Required.
String	getState() Output only.
String	getUnrefreshedDurationUntilDisable() Output only.
SingleTenantHsmInstance	set(String fieldName, Object value)
SingleTenantHsmInstance	setCreateTime(String createTime) Output only.
SingleTenantHsmInstance	setDeleteTime(String deleteTime) Output only.
SingleTenantHsmInstance	setDisableTime(String disableTime) Output only.
SingleTenantHsmInstance	setKeyPortabilityEnabled(Boolean keyPortabilityEnabled) Optional.
SingleTenantHsmInstance	setName(String name) Identifier.
SingleTenantHsmInstance	setQuorumAuth(QuorumAuth quorumAuth) Required.
SingleTenantHsmInstance	setState(String state) Output only.
SingleTenantHsmInstance	setUnrefreshedDurationUntilDisable(String unrefreshedDurationUntilDisable) 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

SingleTenantHsmInstance

public SingleTenantHsmInstance()

Method Detail

getCreateTime

public String getCreateTime()

Output only. The time at which the SingleTenantHsmInstance was created.

Returns:

value or null for none

setCreateTime

public SingleTenantHsmInstance setCreateTime(String createTime)

Output only. The time at which the SingleTenantHsmInstance was created.

Parameters:

createTime - createTime or null for none

getDeleteTime

public String getDeleteTime()

Output only. The time at which the SingleTenantHsmInstance was deleted.

Returns:

value or null for none

setDeleteTime

public SingleTenantHsmInstance setDeleteTime(String deleteTime)

Output only. The time at which the SingleTenantHsmInstance was deleted.

Parameters:

deleteTime - deleteTime or null for none

getDisableTime

public String getDisableTime()

Output only. The time at which the instance will be automatically disabled if not refreshed. This field is updated upon creation and after each successful refresh operation and enable. A RefreshSingleTenantHsmInstance operation must be made via a SingleTenantHsmInstanceProposal before this time otherwise the SingleTenantHsmInstance will become disabled.

Returns:

value or null for none

setDisableTime

public SingleTenantHsmInstance setDisableTime(String disableTime)

Output only. The time at which the instance will be automatically disabled if not refreshed. This field is updated upon creation and after each successful refresh operation and enable. A RefreshSingleTenantHsmInstance operation must be made via a SingleTenantHsmInstanceProposal before this time otherwise the SingleTenantHsmInstance will become disabled.

Parameters:

disableTime - disableTime or null for none

getKeyPortabilityEnabled

public Boolean getKeyPortabilityEnabled()

Optional. Immutable. Indicates whether key portability is enabled for the SingleTenantHsmInstance. This can only be set at creation time. Key portability features are disabled by default.

Returns:

value or null for none

setKeyPortabilityEnabled

public SingleTenantHsmInstance setKeyPortabilityEnabled(Boolean keyPortabilityEnabled)

Optional. Immutable. Indicates whether key portability is enabled for the SingleTenantHsmInstance. This can only be set at creation time. Key portability features are disabled by default.

Parameters:

keyPortabilityEnabled - keyPortabilityEnabled or null for none

getName

public String getName()

Identifier. The resource name for this SingleTenantHsmInstance in the format `projects/locations/singleTenantHsmInstances`.

Returns:

value or null for none

setName

public SingleTenantHsmInstance setName(String name)

Identifier. The resource name for this SingleTenantHsmInstance in the format `projects/locations/singleTenantHsmInstances`.

Parameters:

name - name or null for none

getQuorumAuth

public QuorumAuth getQuorumAuth()

Required. The quorum auth configuration for the SingleTenantHsmInstance.

Returns:

value or null for none

setQuorumAuth

public SingleTenantHsmInstance setQuorumAuth(QuorumAuth quorumAuth)

Required. The quorum auth configuration for the SingleTenantHsmInstance.

Parameters:

quorumAuth - quorumAuth or null for none

getState

public String getState()

Output only. The state of the SingleTenantHsmInstance.

Returns:

value or null for none

setState

public SingleTenantHsmInstance setState(String state)

Output only. The state of the SingleTenantHsmInstance.

Parameters:

state - state or null for none

getUnrefreshedDurationUntilDisable

public String getUnrefreshedDurationUntilDisable()

Output only. The system-defined duration that an instance can remain unrefreshed until it is automatically disabled. This will have a value of 730 days.

Returns:

value or null for none

setUnrefreshedDurationUntilDisable

public SingleTenantHsmInstance setUnrefreshedDurationUntilDisable(String unrefreshedDurationUntilDisable)

Output only. The system-defined duration that an instance can remain unrefreshed until it is automatically disabled. This will have a value of 730 days.

Parameters:

unrefreshedDurationUntilDisable - unrefreshedDurationUntilDisable or null for none

set

public SingleTenantHsmInstance set(String fieldName,
                                   Object value)

Overrides:

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

clone

public SingleTenantHsmInstance clone()

Overrides:

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