SingleTenantHsmInstanceProposal (Cloud Key Management Service (KMS) API v1-rev20260806-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.cloudkms.v1.model.SingleTenantHsmInstanceProposal

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class SingleTenantHsmInstanceProposal
extends com.google.api.client.json.GenericJson
```
A SingleTenantHsmInstanceProposal represents a proposal to perform an operation on a 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

SingleTenantHsmInstanceProposal()

Constructors
Constructor and Description
`SingleTenantHsmInstanceProposal()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SingleTenantHsmInstanceProposal`	`clone()`
`AddQuorumMember`	`getAddQuorumMember()` Add a quorum member to the SingleTenantHsmInstance.
`String`	`getCreateTime()` Output only.
`DeleteSingleTenantHsmInstance`	`getDeleteSingleTenantHsmInstance()` Delete the SingleTenantHsmInstance.
`String`	`getDeleteTime()` Output only.
`DisableSingleTenantHsmInstance`	`getDisableSingleTenantHsmInstance()` Disable the SingleTenantHsmInstance.
`EnableSingleTenantHsmInstance`	`getEnableSingleTenantHsmInstance()` Enable the SingleTenantHsmInstance.
`String`	`getExpireTime()` The time at which the SingleTenantHsmInstanceProposal will expire if not approved and executed.
`String`	`getFailureReason()` Output only.
`String`	`getName()` Identifier.
`String`	`getPurgeTime()` Output only.
`QuorumParameters`	`getQuorumParameters()` Output only.
`RefreshSingleTenantHsmInstance`	`getRefreshSingleTenantHsmInstance()` Refreshes the SingleTenantHsmInstance.
`RegisterTwoFactorAuthKeys`	`getRegisterTwoFactorAuthKeys()` Register 2FA keys for the SingleTenantHsmInstance.
`RemoveQuorumMember`	`getRemoveQuorumMember()` Remove a quorum member from the SingleTenantHsmInstance.
`RequiredActionQuorumParameters`	`getRequiredActionQuorumParameters()` Output only.
`String`	`getState()` Output only.
`String`	`getTtl()` Input only.
`UpgradeKeyTrust`	`getUpgradeKeyTrust()` Promotes a key with the AES_WRAPPING purpose to a trusted wrapping key.
`SingleTenantHsmInstanceProposal`	`set(String fieldName, Object value)`
`SingleTenantHsmInstanceProposal`	`setAddQuorumMember(AddQuorumMember addQuorumMember)` Add a quorum member to the SingleTenantHsmInstance.
`SingleTenantHsmInstanceProposal`	`setCreateTime(String createTime)` Output only.
`SingleTenantHsmInstanceProposal`	`setDeleteSingleTenantHsmInstance(DeleteSingleTenantHsmInstance deleteSingleTenantHsmInstance)` Delete the SingleTenantHsmInstance.
`SingleTenantHsmInstanceProposal`	`setDeleteTime(String deleteTime)` Output only.
`SingleTenantHsmInstanceProposal`	`setDisableSingleTenantHsmInstance(DisableSingleTenantHsmInstance disableSingleTenantHsmInstance)` Disable the SingleTenantHsmInstance.
`SingleTenantHsmInstanceProposal`	`setEnableSingleTenantHsmInstance(EnableSingleTenantHsmInstance enableSingleTenantHsmInstance)` Enable the SingleTenantHsmInstance.
`SingleTenantHsmInstanceProposal`	`setExpireTime(String expireTime)` The time at which the SingleTenantHsmInstanceProposal will expire if not approved and executed.
`SingleTenantHsmInstanceProposal`	`setFailureReason(String failureReason)` Output only.
`SingleTenantHsmInstanceProposal`	`setName(String name)` Identifier.
`SingleTenantHsmInstanceProposal`	`setPurgeTime(String purgeTime)` Output only.
`SingleTenantHsmInstanceProposal`	`setQuorumParameters(QuorumParameters quorumParameters)` Output only.
`SingleTenantHsmInstanceProposal`	`setRefreshSingleTenantHsmInstance(RefreshSingleTenantHsmInstance refreshSingleTenantHsmInstance)` Refreshes the SingleTenantHsmInstance.
`SingleTenantHsmInstanceProposal`	`setRegisterTwoFactorAuthKeys(RegisterTwoFactorAuthKeys registerTwoFactorAuthKeys)` Register 2FA keys for the SingleTenantHsmInstance.
`SingleTenantHsmInstanceProposal`	`setRemoveQuorumMember(RemoveQuorumMember removeQuorumMember)` Remove a quorum member from the SingleTenantHsmInstance.
`SingleTenantHsmInstanceProposal`	`setRequiredActionQuorumParameters(RequiredActionQuorumParameters requiredActionQuorumParameters)` Output only.
`SingleTenantHsmInstanceProposal`	`setState(String state)` Output only.
`SingleTenantHsmInstanceProposal`	`setTtl(String ttl)` Input only.
`SingleTenantHsmInstanceProposal`	`setUpgradeKeyTrust(UpgradeKeyTrust upgradeKeyTrust)` Promotes a key with the AES_WRAPPING purpose to a trusted wrapping key.

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
  - SingleTenantHsmInstanceProposal
```
public SingleTenantHsmInstanceProposal()
```
- Method Detail
  - getAddQuorumMember
```
public AddQuorumMember getAddQuorumMember()
```
    Add a quorum member to the SingleTenantHsmInstance. This will increase the total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.
    
    Returns:
    
    value or null for none
  - setAddQuorumMember
```
public SingleTenantHsmInstanceProposal setAddQuorumMember(AddQuorumMember addQuorumMember)
```
    Add a quorum member to the SingleTenantHsmInstance. This will increase the total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.
    
    Parameters:
    
    addQuorumMember - addQuorumMember or null for none
  - getCreateTime
```
public String getCreateTime()
```
    Output only. The time at which the SingleTenantHsmInstanceProposal was created.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public SingleTenantHsmInstanceProposal setCreateTime(String createTime)
```
    Output only. The time at which the SingleTenantHsmInstanceProposal was created.
    
    Parameters:
    
    createTime - createTime or null for none
  - getDeleteSingleTenantHsmInstance
```
public DeleteSingleTenantHsmInstance getDeleteSingleTenantHsmInstance()
```
    Delete the SingleTenantHsmInstance. Deleting a SingleTenantHsmInstance will make all CryptoKeys attached to the SingleTenantHsmInstance unusable. The SingleTenantHsmInstance must be in the DISABLED or PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation.
    
    Returns:
    
    value or null for none
  - setDeleteSingleTenantHsmInstance
```
public SingleTenantHsmInstanceProposal setDeleteSingleTenantHsmInstance(DeleteSingleTenantHsmInstance deleteSingleTenantHsmInstance)
```
    Delete the SingleTenantHsmInstance. Deleting a SingleTenantHsmInstance will make all CryptoKeys attached to the SingleTenantHsmInstance unusable. The SingleTenantHsmInstance must be in the DISABLED or PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation.
    
    Parameters:
    
    deleteSingleTenantHsmInstance - deleteSingleTenantHsmInstance or null for none
  - getDeleteTime
```
public String getDeleteTime()
```
    Output only. The time at which the SingleTenantHsmInstanceProposal was deleted.
    
    Returns:
    
    value or null for none
  - setDeleteTime
```
public SingleTenantHsmInstanceProposal setDeleteTime(String deleteTime)
```
    Output only. The time at which the SingleTenantHsmInstanceProposal was deleted.
    
    Parameters:
    
    deleteTime - deleteTime or null for none
  - getDisableSingleTenantHsmInstance
```
public DisableSingleTenantHsmInstance getDisableSingleTenantHsmInstance()
```
    Disable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.
    
    Returns:
    
    value or null for none
  - setDisableSingleTenantHsmInstance
```
public SingleTenantHsmInstanceProposal setDisableSingleTenantHsmInstance(DisableSingleTenantHsmInstance disableSingleTenantHsmInstance)
```
    Disable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.
    
    Parameters:
    
    disableSingleTenantHsmInstance - disableSingleTenantHsmInstance or null for none
  - getEnableSingleTenantHsmInstance
```
public EnableSingleTenantHsmInstance getEnableSingleTenantHsmInstance()
```
    Enable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the DISABLED state to perform this operation.
    
    Returns:
    
    value or null for none
  - setEnableSingleTenantHsmInstance
```
public SingleTenantHsmInstanceProposal setEnableSingleTenantHsmInstance(EnableSingleTenantHsmInstance enableSingleTenantHsmInstance)
```
    Enable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the DISABLED state to perform this operation.
    
    Parameters:
    
    enableSingleTenantHsmInstance - enableSingleTenantHsmInstance or null for none
  - getExpireTime
```
public String getExpireTime()
```
    The time at which the SingleTenantHsmInstanceProposal will expire if not approved and executed.
    
    Returns:
    
    value or null for none
  - setExpireTime
```
public SingleTenantHsmInstanceProposal setExpireTime(String expireTime)
```
    The time at which the SingleTenantHsmInstanceProposal will expire if not approved and executed.
    
    Parameters:
    
    expireTime - expireTime or null for none
  - getFailureReason
```
public String getFailureReason()
```
    Output only. The root cause of the most recent failure. Only present if state is FAILED.
    
    Returns:
    
    value or null for none
  - setFailureReason
```
public SingleTenantHsmInstanceProposal setFailureReason(String failureReason)
```
    Output only. The root cause of the most recent failure. Only present if state is FAILED.
    
    Parameters:
    
    failureReason - failureReason or null for none
  - getName
```
public String getName()
```
    Identifier. The resource name for this SingleTenantHsmInstance in the format `projects/locations/singleTenantHsmInstances/proposals`.
    
    Returns:
    
    value or null for none
  - setName
```
public SingleTenantHsmInstanceProposal setName(String name)
```
    Identifier. The resource name for this SingleTenantHsmInstance in the format `projects/locations/singleTenantHsmInstances/proposals`.
    
    Parameters:
    
    name - name or null for none
  - getPurgeTime
```
public String getPurgeTime()
```
    Output only. The time at which the soft-deleted SingleTenantHsmInstanceProposal will be permanently purged. This field is only populated when the state is DELETED and will be set a time after expiration of the proposal, i.e. >= expire_time or (create_time + ttl).
    
    Returns:
    
    value or null for none
  - setPurgeTime
```
public SingleTenantHsmInstanceProposal setPurgeTime(String purgeTime)
```
    Output only. The time at which the soft-deleted SingleTenantHsmInstanceProposal will be permanently purged. This field is only populated when the state is DELETED and will be set a time after expiration of the proposal, i.e. >= expire_time or (create_time + ttl).
    
    Parameters:
    
    purgeTime - purgeTime or null for none
  - getQuorumParameters
```
public QuorumParameters getQuorumParameters()
```
    Output only. The quorum approval parameters for the SingleTenantHsmInstanceProposal.
    
    Returns:
    
    value or null for none
  - setQuorumParameters
```
public SingleTenantHsmInstanceProposal setQuorumParameters(QuorumParameters quorumParameters)
```
    Output only. The quorum approval parameters for the SingleTenantHsmInstanceProposal.
    
    Parameters:
    
    quorumParameters - quorumParameters or null for none
  - getRefreshSingleTenantHsmInstance
```
public RefreshSingleTenantHsmInstance getRefreshSingleTenantHsmInstance()
```
    Refreshes the SingleTenantHsmInstance. This operation must be performed periodically to keep the SingleTenantHsmInstance active. This operation must be performed before unrefreshed_duration_until_disable has passed. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.
    
    Returns:
    
    value or null for none
  - setRefreshSingleTenantHsmInstance
```
public SingleTenantHsmInstanceProposal setRefreshSingleTenantHsmInstance(RefreshSingleTenantHsmInstance refreshSingleTenantHsmInstance)
```
    Refreshes the SingleTenantHsmInstance. This operation must be performed periodically to keep the SingleTenantHsmInstance active. This operation must be performed before unrefreshed_duration_until_disable has passed. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.
    
    Parameters:
    
    refreshSingleTenantHsmInstance - refreshSingleTenantHsmInstance or null for none
  - getRegisterTwoFactorAuthKeys
```
public RegisterTwoFactorAuthKeys getRegisterTwoFactorAuthKeys()
```
    Register 2FA keys for the SingleTenantHsmInstance. This operation requires all N Challenges to be signed by 2FA keys. The SingleTenantHsmInstance must be in the PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation.
    
    Returns:
    
    value or null for none
  - setRegisterTwoFactorAuthKeys
```
public SingleTenantHsmInstanceProposal setRegisterTwoFactorAuthKeys(RegisterTwoFactorAuthKeys registerTwoFactorAuthKeys)
```
    Register 2FA keys for the SingleTenantHsmInstance. This operation requires all N Challenges to be signed by 2FA keys. The SingleTenantHsmInstance must be in the PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation.
    
    Parameters:
    
    registerTwoFactorAuthKeys - registerTwoFactorAuthKeys or null for none
  - getRemoveQuorumMember
```
public RemoveQuorumMember getRemoveQuorumMember()
```
    Remove a quorum member from the SingleTenantHsmInstance. This will reduce total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.
    
    Returns:
    
    value or null for none
  - setRemoveQuorumMember
```
public SingleTenantHsmInstanceProposal setRemoveQuorumMember(RemoveQuorumMember removeQuorumMember)
```
    Remove a quorum member from the SingleTenantHsmInstance. This will reduce total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.
    
    Parameters:
    
    removeQuorumMember - removeQuorumMember or null for none
  - getRequiredActionQuorumParameters
```
public RequiredActionQuorumParameters getRequiredActionQuorumParameters()
```
    Output only. Parameters for an approval of a SingleTenantHsmInstanceProposal that has both required challenges and a quorum.
    
    Returns:
    
    value or null for none
  - setRequiredActionQuorumParameters
```
public SingleTenantHsmInstanceProposal setRequiredActionQuorumParameters(RequiredActionQuorumParameters requiredActionQuorumParameters)
```
    Output only. Parameters for an approval of a SingleTenantHsmInstanceProposal that has both required challenges and a quorum.
    
    Parameters:
    
    requiredActionQuorumParameters - requiredActionQuorumParameters or null for none
  - getState
```
public String getState()
```
    Output only. The state of the SingleTenantHsmInstanceProposal.
    
    Returns:
    
    value or null for none
  - setState
```
public SingleTenantHsmInstanceProposal setState(String state)
```
    Output only. The state of the SingleTenantHsmInstanceProposal.
    
    Parameters:
    
    state - state or null for none
  - getTtl
```
public String getTtl()
```
    Input only. The TTL for the SingleTenantHsmInstanceProposal. Proposals will expire after this duration.
    
    Returns:
    
    value or null for none
  - setTtl
```
public SingleTenantHsmInstanceProposal setTtl(String ttl)
```
    Input only. The TTL for the SingleTenantHsmInstanceProposal. Proposals will expire after this duration.
    
    Parameters:
    
    ttl - ttl or null for none
  - getUpgradeKeyTrust
```
public UpgradeKeyTrust getUpgradeKeyTrust()
```
    Promotes a key with the AES_WRAPPING purpose to a trusted wrapping key. The key must be in the ACTIVE state to perform this operation.
    
    Returns:
    
    value or null for none
  - setUpgradeKeyTrust
```
public SingleTenantHsmInstanceProposal setUpgradeKeyTrust(UpgradeKeyTrust upgradeKeyTrust)
```
    Promotes a key with the AES_WRAPPING purpose to a trusted wrapping key. The key must be in the ACTIVE state to perform this operation.
    
    Parameters:
    
    upgradeKeyTrust - upgradeKeyTrust or null for none
  - set
```
public SingleTenantHsmInstanceProposal set(String fieldName,
                                           Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public SingleTenantHsmInstanceProposal clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class SingleTenantHsmInstanceProposal

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

SingleTenantHsmInstanceProposal

Method Detail

getAddQuorumMember

setAddQuorumMember

getCreateTime

setCreateTime

getDeleteSingleTenantHsmInstance

setDeleteSingleTenantHsmInstance

getDeleteTime

setDeleteTime

getDisableSingleTenantHsmInstance

setDisableSingleTenantHsmInstance

getEnableSingleTenantHsmInstance

setEnableSingleTenantHsmInstance

getExpireTime

setExpireTime

getFailureReason

setFailureReason

getName

setName

getPurgeTime

setPurgeTime

getQuorumParameters

setQuorumParameters

getRefreshSingleTenantHsmInstance

setRefreshSingleTenantHsmInstance

getRegisterTwoFactorAuthKeys

setRegisterTwoFactorAuthKeys

getRemoveQuorumMember

setRemoveQuorumMember

getRequiredActionQuorumParameters

setRequiredActionQuorumParameters

getState

setState

getTtl

setTtl

getUpgradeKeyTrust

setUpgradeKeyTrust

set

clone