Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class SingleTenantHsmInstance (2.86.0)

public final class SingleTenantHsmInstance extends GeneratedMessage 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > SingleTenantHsmInstance

Implements

SingleTenantHsmInstanceOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

DELETE_TIME_FIELD_NUMBER

public static final int DELETE_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

DISABLE_TIME_FIELD_NUMBER

public static final int DISABLE_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

QUORUM_AUTH_FIELD_NUMBER

public static final int QUORUM_AUTH_FIELD_NUMBER

Field Value
Type	Description
`int`

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

Field Value
Type	Description
`int`

UNREFRESHED_DURATION_UNTIL_DISABLE_FIELD_NUMBER

public static final int UNREFRESHED_DURATION_UNTIL_DISABLE_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static SingleTenantHsmInstance getDefaultInstance()

Returns
Type	Description
`SingleTenantHsmInstance`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static SingleTenantHsmInstance.Builder newBuilder()

Returns
Type	Description
`SingleTenantHsmInstance.Builder`

newBuilder(SingleTenantHsmInstance prototype)

public static SingleTenantHsmInstance.Builder newBuilder(SingleTenantHsmInstance prototype)

Parameter
Name	Description
`prototype`	`SingleTenantHsmInstance`

Returns
Type	Description
`SingleTenantHsmInstance.Builder`

parseDelimitedFrom(InputStream input)

public static SingleTenantHsmInstance parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`SingleTenantHsmInstance`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SingleTenantHsmInstance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SingleTenantHsmInstance`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static SingleTenantHsmInstance parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`SingleTenantHsmInstance`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SingleTenantHsmInstance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SingleTenantHsmInstance`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static SingleTenantHsmInstance parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`SingleTenantHsmInstance`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SingleTenantHsmInstance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SingleTenantHsmInstance`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static SingleTenantHsmInstance parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`SingleTenantHsmInstance`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SingleTenantHsmInstance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SingleTenantHsmInstance`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static SingleTenantHsmInstance parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`SingleTenantHsmInstance`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SingleTenantHsmInstance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SingleTenantHsmInstance`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static SingleTenantHsmInstance parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`SingleTenantHsmInstance`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SingleTenantHsmInstance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SingleTenantHsmInstance`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<SingleTenantHsmInstance> parser()

Returns
Type	Description
`Parser<SingleTenantHsmInstance>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

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.

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.

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`

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.

getDisableTimeOrBuilder()

public TimestampOrBuilder getDisableTimeOrBuilder()

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

getParserForType()

public Parser<SingleTenantHsmInstance> getParserForType()

Returns
Type	Description
`Parser<SingleTenantHsmInstance>`

Overrides

GeneratedMessage.getParserForType()

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.

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`

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessage.getSerializedSize()

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.

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

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

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public SingleTenantHsmInstance.Builder newBuilderForType()

Returns
Type	Description
`SingleTenantHsmInstance.Builder`

newBuilderForType(AbstractMessage.BuilderParent parent)

protected SingleTenantHsmInstance.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`SingleTenantHsmInstance.Builder`

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public SingleTenantHsmInstance.Builder toBuilder()

Returns
Type	Description
`SingleTenantHsmInstance.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`