Class SingleTenantHsmInstanceProposal

A SingleTenantHsmInstanceProposal represents a proposal to perform an operation on a SingleTenantHsmInstance.

Inheritance
object
SingleTenantHsmInstanceProposal
Implements
Inherited Members
Namespace: Google.Apis.CloudKMS.v1.Data
Assembly: Google.Apis.CloudKMS.v1.dll
Syntax
public class SingleTenantHsmInstanceProposal : IDirectResponseSchema

Properties

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.

Declaration
[JsonProperty("addQuorumMember")]
public virtual AddQuorumMember AddQuorumMember { get; set; }
Property Value
Type Description
AddQuorumMember

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

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

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

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.

Declaration
[JsonProperty("deleteSingleTenantHsmInstance")]
public virtual DeleteSingleTenantHsmInstance DeleteSingleTenantHsmInstance { get; set; }
Property Value
Type Description
DeleteSingleTenantHsmInstance

DeleteTime

object representation of DeleteTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use DeleteTimeDateTimeOffset instead.")]
public virtual object DeleteTime { get; set; }
Property Value
Type Description
object

DeleteTimeDateTimeOffset

DateTimeOffset representation of DeleteTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? DeleteTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

DeleteTimeRaw

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

Declaration
[JsonProperty("deleteTime")]
public virtual string DeleteTimeRaw { get; set; }
Property Value
Type Description
string

DisableSingleTenantHsmInstance

Disable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

Declaration
[JsonProperty("disableSingleTenantHsmInstance")]
public virtual DisableSingleTenantHsmInstance DisableSingleTenantHsmInstance { get; set; }
Property Value
Type Description
DisableSingleTenantHsmInstance

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EnableSingleTenantHsmInstance

Enable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the DISABLED state to perform this operation.

Declaration
[JsonProperty("enableSingleTenantHsmInstance")]
public virtual EnableSingleTenantHsmInstance EnableSingleTenantHsmInstance { get; set; }
Property Value
Type Description
EnableSingleTenantHsmInstance

ExpireTime

object representation of ExpireTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ExpireTimeDateTimeOffset instead.")]
public virtual object ExpireTime { get; set; }
Property Value
Type Description
object

ExpireTimeDateTimeOffset

DateTimeOffset representation of ExpireTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? ExpireTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

ExpireTimeRaw

The time at which the SingleTenantHsmInstanceProposal will expire if not approved and executed.

Declaration
[JsonProperty("expireTime")]
public virtual string ExpireTimeRaw { get; set; }
Property Value
Type Description
string

FailureReason

Output only. The root cause of the most recent failure. Only present if state is FAILED.

Declaration
[JsonProperty("failureReason")]
public virtual string FailureReason { get; set; }
Property Value
Type Description
string

Name

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

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

PurgeTime

object representation of PurgeTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use PurgeTimeDateTimeOffset instead.")]
public virtual object PurgeTime { get; set; }
Property Value
Type Description
object

PurgeTimeDateTimeOffset

DateTimeOffset representation of PurgeTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? PurgeTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

PurgeTimeRaw

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

Declaration
[JsonProperty("purgeTime")]
public virtual string PurgeTimeRaw { get; set; }
Property Value
Type Description
string

QuorumParameters

Output only. The quorum approval parameters for the SingleTenantHsmInstanceProposal.

Declaration
[JsonProperty("quorumParameters")]
public virtual QuorumParameters QuorumParameters { get; set; }
Property Value
Type Description
QuorumParameters

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.

Declaration
[JsonProperty("refreshSingleTenantHsmInstance")]
public virtual RefreshSingleTenantHsmInstance RefreshSingleTenantHsmInstance { get; set; }
Property Value
Type Description
RefreshSingleTenantHsmInstance

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.

Declaration
[JsonProperty("registerTwoFactorAuthKeys")]
public virtual RegisterTwoFactorAuthKeys RegisterTwoFactorAuthKeys { get; set; }
Property Value
Type Description
RegisterTwoFactorAuthKeys

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.

Declaration
[JsonProperty("removeQuorumMember")]
public virtual RemoveQuorumMember RemoveQuorumMember { get; set; }
Property Value
Type Description
RemoveQuorumMember

RequiredActionQuorumParameters

Output only. Parameters for an approval of a SingleTenantHsmInstanceProposal that has both required challenges and a quorum.

Declaration
[JsonProperty("requiredActionQuorumParameters")]
public virtual RequiredActionQuorumParameters RequiredActionQuorumParameters { get; set; }
Property Value
Type Description
RequiredActionQuorumParameters

State

Output only. The state of the SingleTenantHsmInstanceProposal.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

Ttl

Input only. The TTL for the SingleTenantHsmInstanceProposal. Proposals will expire after this duration.

Declaration
[JsonProperty("ttl")]
public virtual object Ttl { get; set; }
Property Value
Type Description
object

Implements