# Interface SingleTenantHsmInstanceOrBuilder (2.96.0)

2.96.0 (latest) 2.94.0 2.91.0 2.90.0 2.88.0 2.86.0 2.85.0 2.84.0 2.83.0 2.81.0 2.79.0 2.78.0 2.77.0 2.76.0 2.75.0 2.73.0 2.71.0 2.70.0 2.67.0 2.66.0 2.65.0 2.63.0 2.62.0 2.61.0 2.60.0 2.59.0 2.58.0 2.57.0 2.56.0 2.55.0 2.54.0 2.52.0 2.51.0 2.50.0 2.49.0 2.48.0 2.47.0 2.46.0 2.45.0 2.44.0 2.43.0 2.42.0 2.40.0 2.39.0 2.38.0 2.37.0 2.36.0 2.35.0 2.34.0 2.33.0 2.32.0 2.31.0 2.30.0 2.27.0 2.26.0 2.25.0 2.24.0 2.23.0 2.22.0 2.21.0 2.20.0 2.19.0 2.18.0 2.17.0 2.16.0 2.15.0 2.14.0 2.12.0 2.11.0 2.10.0 2.9.0 2.8.0 2.7.0 2.6.8 2.5.3 2.4.4 2.3.1

    public interface SingleTenantHsmInstanceOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## Methods

### getCreateTime()

    public abstract 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Timestamp.html` | The createTime. |

### getCreateTimeOrBuilder()

    public abstract 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.TimestampOrBuilder.html` |   |

### getDeleteTime()

    public abstract 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Timestamp.html` | The deleteTime. |

### getDeleteTimeOrBuilder()

    public abstract 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.TimestampOrBuilder.html` |   |

### getDisableTime()

    public abstract 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Timestamp.html` | The disableTime. |

### getDisableTimeOrBuilder()

    public abstract 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.TimestampOrBuilder.html` |   |

### getKeyPortabilityEnabled()

    public abstract 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 and not yet available in GA.

`
bool key_portability_enabled = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The keyPortabilityEnabled. |

### getName()

    public abstract 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The name. |

### getNameBytes()

    public abstract 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for name. |

### getQuorumAuth()

    public abstract 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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-kms/latest/com.google.cloud.kms.v1.SingleTenantHsmInstance.QuorumAuth` | The quorumAuth. |

### getQuorumAuthOrBuilder()

    public abstract 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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-kms/latest/com.google.cloud.kms.v1.SingleTenantHsmInstance.QuorumAuthOrBuilder` |   |

### getState()

    public abstract 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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-kms/latest/com.google.cloud.kms.v1.SingleTenantHsmInstance.State` | The state. |

### getStateValue()

    public abstract 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The enum numeric value on the wire for state. |

### getUnrefreshedDurationUntilDisable()

    public abstract 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
730 days.

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Duration.html` | The unrefreshedDurationUntilDisable. |

### getUnrefreshedDurationUntilDisableOrBuilder()

    public abstract 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
730 days.

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.DurationOrBuilder.html` |   |

### hasCreateTime()

    public abstract 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the createTime field is set. |

### hasDeleteTime()

    public abstract 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the deleteTime field is set. |

### hasDisableTime()

    public abstract 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the disableTime field is set. |

### hasQuorumAuth()

    public abstract 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the quorumAuth field is set. |

### hasUnrefreshedDurationUntilDisable()

    public abstract 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
730 days.

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the unrefreshedDurationUntilDisable field is set. |