Class SingleTenantHsmInstance.Builder (2.86.0)

public static final class SingleTenantHsmInstance.Builder extends GeneratedMessage.Builder<SingleTenantHsmInstance.Builder> implements SingleTenantHsmInstanceOrBuilder

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.

Protobuf type google.cloud.kms.v1.SingleTenantHsmInstance

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public SingleTenantHsmInstance build()
Returns
Type Description
SingleTenantHsmInstance

buildPartial()

public SingleTenantHsmInstance buildPartial()
Returns
Type Description
SingleTenantHsmInstance

clear()

public SingleTenantHsmInstance.Builder clear()
Returns
Type Description
SingleTenantHsmInstance.Builder
Overrides

clearCreateTime()

public SingleTenantHsmInstance.Builder clearCreateTime()

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

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SingleTenantHsmInstance.Builder

clearDeleteTime()

public SingleTenantHsmInstance.Builder clearDeleteTime()

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

.google.protobuf.Timestamp delete_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SingleTenantHsmInstance.Builder

clearDisableTime()

public SingleTenantHsmInstance.Builder clearDisableTime()

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.

.google.protobuf.Timestamp disable_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SingleTenantHsmInstance.Builder

clearName()

public SingleTenantHsmInstance.Builder clearName()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
SingleTenantHsmInstance.Builder

This builder for chaining.

clearQuorumAuth()

public SingleTenantHsmInstance.Builder clearQuorumAuth()

Required. The quorum auth configuration for the SingleTenantHsmInstance.

.google.cloud.kms.v1.SingleTenantHsmInstance.QuorumAuth quorum_auth = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SingleTenantHsmInstance.Builder

clearState()

public SingleTenantHsmInstance.Builder clearState()

Output only. The state of the SingleTenantHsmInstance.

.google.cloud.kms.v1.SingleTenantHsmInstance.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SingleTenantHsmInstance.Builder

This builder for chaining.

clearUnrefreshedDurationUntilDisable()

public SingleTenantHsmInstance.Builder clearUnrefreshedDurationUntilDisable()

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

.google.protobuf.Duration unrefreshed_duration_until_disable = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SingleTenantHsmInstance.Builder

getCreateTime()

public Timestamp getCreateTime()

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

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

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

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public SingleTenantHsmInstance getDefaultInstanceForType()
Returns
Type Description
SingleTenantHsmInstance

getDeleteTime()

public Timestamp getDeleteTime()

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

.google.protobuf.Timestamp delete_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The deleteTime.

getDeleteTimeBuilder()

public Timestamp.Builder getDeleteTimeBuilder()

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

.google.protobuf.Timestamp delete_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getDeleteTimeOrBuilder()

public TimestampOrBuilder getDeleteTimeOrBuilder()

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

.google.protobuf.Timestamp delete_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisableTime()

public Timestamp 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.

.google.protobuf.Timestamp disable_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The disableTime.

getDisableTimeBuilder()

public Timestamp.Builder getDisableTimeBuilder()

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.

.google.protobuf.Timestamp disable_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getDisableTimeOrBuilder()

public TimestampOrBuilder getDisableTimeOrBuilder()

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.

.google.protobuf.Timestamp disable_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getName()

public String getName()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getQuorumAuth()

public SingleTenantHsmInstance.QuorumAuth getQuorumAuth()

Required. The quorum auth configuration for the SingleTenantHsmInstance.

.google.cloud.kms.v1.SingleTenantHsmInstance.QuorumAuth quorum_auth = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SingleTenantHsmInstance.QuorumAuth

The quorumAuth.

getQuorumAuthBuilder()

public SingleTenantHsmInstance.QuorumAuth.Builder getQuorumAuthBuilder()

Required. The quorum auth configuration for the SingleTenantHsmInstance.

.google.cloud.kms.v1.SingleTenantHsmInstance.QuorumAuth quorum_auth = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SingleTenantHsmInstance.QuorumAuth.Builder

getQuorumAuthOrBuilder()

public SingleTenantHsmInstance.QuorumAuthOrBuilder getQuorumAuthOrBuilder()

Required. The quorum auth configuration for the SingleTenantHsmInstance.

.google.cloud.kms.v1.SingleTenantHsmInstance.QuorumAuth quorum_auth = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SingleTenantHsmInstance.QuorumAuthOrBuilder

getState()

public SingleTenantHsmInstance.State getState()

Output only. The state of the SingleTenantHsmInstance.

.google.cloud.kms.v1.SingleTenantHsmInstance.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SingleTenantHsmInstance.State

The state.

getStateValue()

public int getStateValue()

Output only. The state of the SingleTenantHsmInstance.

.google.cloud.kms.v1.SingleTenantHsmInstance.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getUnrefreshedDurationUntilDisable()

public Duration getUnrefreshedDurationUntilDisable()

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

.google.protobuf.Duration unrefreshed_duration_until_disable = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Duration

The unrefreshedDurationUntilDisable.

getUnrefreshedDurationUntilDisableBuilder()

public Duration.Builder getUnrefreshedDurationUntilDisableBuilder()

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

.google.protobuf.Duration unrefreshed_duration_until_disable = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUnrefreshedDurationUntilDisableOrBuilder()

public DurationOrBuilder getUnrefreshedDurationUntilDisableOrBuilder()

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

.google.protobuf.Duration unrefreshed_duration_until_disable = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DurationOrBuilder

hasCreateTime()

public boolean hasCreateTime()

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

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDeleteTime()

public boolean hasDeleteTime()

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

.google.protobuf.Timestamp delete_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the deleteTime field is set.

hasDisableTime()

public boolean hasDisableTime()

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.

.google.protobuf.Timestamp disable_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the disableTime field is set.

hasQuorumAuth()

public boolean hasQuorumAuth()

Required. The quorum auth configuration for the SingleTenantHsmInstance.

.google.cloud.kms.v1.SingleTenantHsmInstance.QuorumAuth quorum_auth = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the quorumAuth field is set.

hasUnrefreshedDurationUntilDisable()

public boolean hasUnrefreshedDurationUntilDisable()

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

.google.protobuf.Duration unrefreshed_duration_until_disable = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the unrefreshedDurationUntilDisable field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public SingleTenantHsmInstance.Builder mergeCreateTime(Timestamp value)

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

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
SingleTenantHsmInstance.Builder

mergeDeleteTime(Timestamp value)

public SingleTenantHsmInstance.Builder mergeDeleteTime(Timestamp value)

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

.google.protobuf.Timestamp delete_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
SingleTenantHsmInstance.Builder

mergeDisableTime(Timestamp value)

public SingleTenantHsmInstance.Builder mergeDisableTime(Timestamp value)

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.

.google.protobuf.Timestamp disable_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
SingleTenantHsmInstance.Builder

mergeFrom(SingleTenantHsmInstance other)

public SingleTenantHsmInstance.Builder mergeFrom(SingleTenantHsmInstance other)
Parameter
Name Description
other SingleTenantHsmInstance
Returns
Type Description
SingleTenantHsmInstance.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SingleTenantHsmInstance.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SingleTenantHsmInstance.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SingleTenantHsmInstance.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SingleTenantHsmInstance.Builder
Overrides

mergeQuorumAuth(SingleTenantHsmInstance.QuorumAuth value)

public SingleTenantHsmInstance.Builder mergeQuorumAuth(SingleTenantHsmInstance.QuorumAuth value)

Required. The quorum auth configuration for the SingleTenantHsmInstance.

.google.cloud.kms.v1.SingleTenantHsmInstance.QuorumAuth quorum_auth = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value SingleTenantHsmInstance.QuorumAuth
Returns
Type Description
SingleTenantHsmInstance.Builder

mergeUnrefreshedDurationUntilDisable(Duration value)

public SingleTenantHsmInstance.Builder mergeUnrefreshedDurationUntilDisable(Duration value)

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

.google.protobuf.Duration unrefreshed_duration_until_disable = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Duration
Returns
Type Description
SingleTenantHsmInstance.Builder

setCreateTime(Timestamp value)

public SingleTenantHsmInstance.Builder setCreateTime(Timestamp value)

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

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
SingleTenantHsmInstance.Builder

setCreateTime(Timestamp.Builder builderForValue)

public SingleTenantHsmInstance.Builder setCreateTime(Timestamp.Builder builderForValue)

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

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SingleTenantHsmInstance.Builder

setDeleteTime(Timestamp value)

public SingleTenantHsmInstance.Builder setDeleteTime(Timestamp value)

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

.google.protobuf.Timestamp delete_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
SingleTenantHsmInstance.Builder

setDeleteTime(Timestamp.Builder builderForValue)

public SingleTenantHsmInstance.Builder setDeleteTime(Timestamp.Builder builderForValue)

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

.google.protobuf.Timestamp delete_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SingleTenantHsmInstance.Builder

setDisableTime(Timestamp value)

public SingleTenantHsmInstance.Builder setDisableTime(Timestamp value)

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.

.google.protobuf.Timestamp disable_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
SingleTenantHsmInstance.Builder

setDisableTime(Timestamp.Builder builderForValue)

public SingleTenantHsmInstance.Builder setDisableTime(Timestamp.Builder builderForValue)

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.

.google.protobuf.Timestamp disable_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SingleTenantHsmInstance.Builder

setName(String value)

public SingleTenantHsmInstance.Builder setName(String value)

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
SingleTenantHsmInstance.Builder

This builder for chaining.

setNameBytes(ByteString value)

public SingleTenantHsmInstance.Builder setNameBytes(ByteString value)

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
SingleTenantHsmInstance.Builder

This builder for chaining.

setQuorumAuth(SingleTenantHsmInstance.QuorumAuth value)

public SingleTenantHsmInstance.Builder setQuorumAuth(SingleTenantHsmInstance.QuorumAuth value)

Required. The quorum auth configuration for the SingleTenantHsmInstance.

.google.cloud.kms.v1.SingleTenantHsmInstance.QuorumAuth quorum_auth = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value SingleTenantHsmInstance.QuorumAuth
Returns
Type Description
SingleTenantHsmInstance.Builder

setQuorumAuth(SingleTenantHsmInstance.QuorumAuth.Builder builderForValue)

public SingleTenantHsmInstance.Builder setQuorumAuth(SingleTenantHsmInstance.QuorumAuth.Builder builderForValue)

Required. The quorum auth configuration for the SingleTenantHsmInstance.

.google.cloud.kms.v1.SingleTenantHsmInstance.QuorumAuth quorum_auth = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue SingleTenantHsmInstance.QuorumAuth.Builder
Returns
Type Description
SingleTenantHsmInstance.Builder

setState(SingleTenantHsmInstance.State value)

public SingleTenantHsmInstance.Builder setState(SingleTenantHsmInstance.State value)

Output only. The state of the SingleTenantHsmInstance.

.google.cloud.kms.v1.SingleTenantHsmInstance.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value SingleTenantHsmInstance.State

The state to set.

Returns
Type Description
SingleTenantHsmInstance.Builder

This builder for chaining.

setStateValue(int value)

public SingleTenantHsmInstance.Builder setStateValue(int value)

Output only. The state of the SingleTenantHsmInstance.

.google.cloud.kms.v1.SingleTenantHsmInstance.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
SingleTenantHsmInstance.Builder

This builder for chaining.

setUnrefreshedDurationUntilDisable(Duration value)

public SingleTenantHsmInstance.Builder setUnrefreshedDurationUntilDisable(Duration value)

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

.google.protobuf.Duration unrefreshed_duration_until_disable = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Duration
Returns
Type Description
SingleTenantHsmInstance.Builder

setUnrefreshedDurationUntilDisable(Duration.Builder builderForValue)

public SingleTenantHsmInstance.Builder setUnrefreshedDurationUntilDisable(Duration.Builder builderForValue)

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

.google.protobuf.Duration unrefreshed_duration_until_disable = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SingleTenantHsmInstance.Builder