Represents a SingleTenantHsmInstanceProposal.
Package
@google-cloud/kmsConstructors
(constructor)(properties)
constructor(properties?: google.cloud.kms.v1.ISingleTenantHsmInstanceProposal);Constructs a new SingleTenantHsmInstanceProposal.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISingleTenantHsmInstanceProposal
Properties to set |
Properties
addQuorumMember
public addQuorumMember?: (google.cloud.kms.v1.SingleTenantHsmInstanceProposal.IAddQuorumMember|null);SingleTenantHsmInstanceProposal addQuorumMember.
approvalParameters
public approvalParameters?: ("quorumParameters"|"requiredActionQuorumParameters");SingleTenantHsmInstanceProposal approvalParameters.
createTime
public createTime?: (google.protobuf.ITimestamp|null);SingleTenantHsmInstanceProposal createTime.
deleteSingleTenantHsmInstance
public deleteSingleTenantHsmInstance?: (google.cloud.kms.v1.SingleTenantHsmInstanceProposal.IDeleteSingleTenantHsmInstance|null);SingleTenantHsmInstanceProposal deleteSingleTenantHsmInstance.
deleteTime
public deleteTime?: (google.protobuf.ITimestamp|null);SingleTenantHsmInstanceProposal deleteTime.
disableSingleTenantHsmInstance
public disableSingleTenantHsmInstance?: (google.cloud.kms.v1.SingleTenantHsmInstanceProposal.IDisableSingleTenantHsmInstance|null);SingleTenantHsmInstanceProposal disableSingleTenantHsmInstance.
enableSingleTenantHsmInstance
public enableSingleTenantHsmInstance?: (google.cloud.kms.v1.SingleTenantHsmInstanceProposal.IEnableSingleTenantHsmInstance|null);SingleTenantHsmInstanceProposal enableSingleTenantHsmInstance.
expiration
public expiration?: ("expireTime"|"ttl");SingleTenantHsmInstanceProposal expiration.
expireTime
public expireTime?: (google.protobuf.ITimestamp|null);SingleTenantHsmInstanceProposal expireTime.
failureReason
public failureReason: string;SingleTenantHsmInstanceProposal failureReason.
name
public name: string;SingleTenantHsmInstanceProposal name.
operation
public operation?: ("registerTwoFactorAuthKeys"|"disableSingleTenantHsmInstance"|"enableSingleTenantHsmInstance"|"deleteSingleTenantHsmInstance"|"addQuorumMember"|"removeQuorumMember"|"refreshSingleTenantHsmInstance");SingleTenantHsmInstanceProposal operation.
purgeTime
public purgeTime?: (google.protobuf.ITimestamp|null);SingleTenantHsmInstanceProposal purgeTime.
quorumParameters
public quorumParameters?: (google.cloud.kms.v1.SingleTenantHsmInstanceProposal.IQuorumParameters|null);SingleTenantHsmInstanceProposal quorumParameters.
refreshSingleTenantHsmInstance
public refreshSingleTenantHsmInstance?: (google.cloud.kms.v1.SingleTenantHsmInstanceProposal.IRefreshSingleTenantHsmInstance|null);SingleTenantHsmInstanceProposal refreshSingleTenantHsmInstance.
registerTwoFactorAuthKeys
public registerTwoFactorAuthKeys?: (google.cloud.kms.v1.SingleTenantHsmInstanceProposal.IRegisterTwoFactorAuthKeys|null);SingleTenantHsmInstanceProposal registerTwoFactorAuthKeys.
removeQuorumMember
public removeQuorumMember?: (google.cloud.kms.v1.SingleTenantHsmInstanceProposal.IRemoveQuorumMember|null);SingleTenantHsmInstanceProposal removeQuorumMember.
requiredActionQuorumParameters
public requiredActionQuorumParameters?: (google.cloud.kms.v1.SingleTenantHsmInstanceProposal.IRequiredActionQuorumParameters|null);SingleTenantHsmInstanceProposal requiredActionQuorumParameters.
state
public state: (google.cloud.kms.v1.SingleTenantHsmInstanceProposal.State|keyof typeof google.cloud.kms.v1.SingleTenantHsmInstanceProposal.State);SingleTenantHsmInstanceProposal state.
ttl
public ttl?: (google.protobuf.IDuration|null);SingleTenantHsmInstanceProposal ttl.
Methods
create(properties)
public static create(properties?: google.cloud.kms.v1.ISingleTenantHsmInstanceProposal): google.cloud.kms.v1.SingleTenantHsmInstanceProposal;Creates a new SingleTenantHsmInstanceProposal instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISingleTenantHsmInstanceProposal
Properties to set |
| Returns | |
|---|---|
| Type | Description |
SingleTenantHsmInstanceProposal |
SingleTenantHsmInstanceProposal instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.kms.v1.SingleTenantHsmInstanceProposal;Decodes a SingleTenantHsmInstanceProposal message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
SingleTenantHsmInstanceProposal |
SingleTenantHsmInstanceProposal |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.kms.v1.SingleTenantHsmInstanceProposal;Decodes a SingleTenantHsmInstanceProposal message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
SingleTenantHsmInstanceProposal |
SingleTenantHsmInstanceProposal |
encode(message, writer)
public static encode(message: google.cloud.kms.v1.ISingleTenantHsmInstanceProposal, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified SingleTenantHsmInstanceProposal message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ISingleTenantHsmInstanceProposal
SingleTenantHsmInstanceProposal message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.kms.v1.ISingleTenantHsmInstanceProposal, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified SingleTenantHsmInstanceProposal message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ISingleTenantHsmInstanceProposal
SingleTenantHsmInstanceProposal message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.kms.v1.SingleTenantHsmInstanceProposal;Creates a SingleTenantHsmInstanceProposal message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
SingleTenantHsmInstanceProposal |
SingleTenantHsmInstanceProposal |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for SingleTenantHsmInstanceProposal
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this SingleTenantHsmInstanceProposal to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.kms.v1.SingleTenantHsmInstanceProposal, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a SingleTenantHsmInstanceProposal message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
SingleTenantHsmInstanceProposal
SingleTenantHsmInstanceProposal |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a SingleTenantHsmInstanceProposal message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|