Class SingleTenantHsmInstanceProposal.UpgradeKeyTrust.Builder (2.98.0)

public static final class SingleTenantHsmInstanceProposal.UpgradeKeyTrust.Builder extends GeneratedMessage.Builder<SingleTenantHsmInstanceProposal.UpgradeKeyTrust.Builder> implements SingleTenantHsmInstanceProposal.UpgradeKeyTrustOrBuilder

Promotes a key with the AES_WRAPPING purpose to a trusted wrapping key. The key must be in the ACTIVE state to perform this operation.

Protobuf type google.cloud.kms.v1.SingleTenantHsmInstanceProposal.UpgradeKeyTrust

Static Methods

getDescriptor()

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

Methods

build()

public SingleTenantHsmInstanceProposal.UpgradeKeyTrust build()
Returns
Type Description
SingleTenantHsmInstanceProposal.UpgradeKeyTrust

buildPartial()

public SingleTenantHsmInstanceProposal.UpgradeKeyTrust buildPartial()
Returns
Type Description
SingleTenantHsmInstanceProposal.UpgradeKeyTrust

clear()

public SingleTenantHsmInstanceProposal.UpgradeKeyTrust.Builder clear()
Returns
Type Description
SingleTenantHsmInstanceProposal.UpgradeKeyTrust.Builder
Overrides

clearName()

public SingleTenantHsmInstanceProposal.UpgradeKeyTrust.Builder clearName()

Required. The name of the CryptoKeyVersion to promote.

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

Returns
Type Description
SingleTenantHsmInstanceProposal.UpgradeKeyTrust.Builder

This builder for chaining.

clearTwoFactorPublicKeyPem()

public SingleTenantHsmInstanceProposal.UpgradeKeyTrust.Builder clearTwoFactorPublicKeyPem()

Required. The public key associated with the 2FA key that will sign the login nonce for this operation.

string two_factor_public_key_pem = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SingleTenantHsmInstanceProposal.UpgradeKeyTrust.Builder

This builder for chaining.

getDefaultInstanceForType()

public SingleTenantHsmInstanceProposal.UpgradeKeyTrust getDefaultInstanceForType()
Returns
Type Description
SingleTenantHsmInstanceProposal.UpgradeKeyTrust

getDescriptorForType()

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

getName()

public String getName()

Required. The name of the CryptoKeyVersion to promote.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the CryptoKeyVersion to promote.

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

Returns
Type Description
ByteString

The bytes for name.

getTwoFactorPublicKeyPem()

public String getTwoFactorPublicKeyPem()

Required. The public key associated with the 2FA key that will sign the login nonce for this operation.

string two_factor_public_key_pem = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The twoFactorPublicKeyPem.

getTwoFactorPublicKeyPemBytes()

public ByteString getTwoFactorPublicKeyPemBytes()

Required. The public key associated with the 2FA key that will sign the login nonce for this operation.

string two_factor_public_key_pem = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for twoFactorPublicKeyPem.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SingleTenantHsmInstanceProposal.UpgradeKeyTrust other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setName(String value)

public SingleTenantHsmInstanceProposal.UpgradeKeyTrust.Builder setName(String value)

Required. The name of the CryptoKeyVersion to promote.

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
SingleTenantHsmInstanceProposal.UpgradeKeyTrust.Builder

This builder for chaining.

setNameBytes(ByteString value)

public SingleTenantHsmInstanceProposal.UpgradeKeyTrust.Builder setNameBytes(ByteString value)

Required. The name of the CryptoKeyVersion to promote.

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
SingleTenantHsmInstanceProposal.UpgradeKeyTrust.Builder

This builder for chaining.

setTwoFactorPublicKeyPem(String value)

public SingleTenantHsmInstanceProposal.UpgradeKeyTrust.Builder setTwoFactorPublicKeyPem(String value)

Required. The public key associated with the 2FA key that will sign the login nonce for this operation.

string two_factor_public_key_pem = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The twoFactorPublicKeyPem to set.

Returns
Type Description
SingleTenantHsmInstanceProposal.UpgradeKeyTrust.Builder

This builder for chaining.

setTwoFactorPublicKeyPemBytes(ByteString value)

public SingleTenantHsmInstanceProposal.UpgradeKeyTrust.Builder setTwoFactorPublicKeyPemBytes(ByteString value)

Required. The public key associated with the 2FA key that will sign the login nonce for this operation.

string two_factor_public_key_pem = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for twoFactorPublicKeyPem to set.

Returns
Type Description
SingleTenantHsmInstanceProposal.UpgradeKeyTrust.Builder

This builder for chaining.