Interface ImportTrustedKeyWrappedCryptoKeyVersionRequestOrBuilder (2.98.0)

public interface ImportTrustedKeyWrappedCryptoKeyVersionRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAlgorithm()

public abstract CryptoKeyVersion.CryptoKeyVersionAlgorithm getAlgorithm()

Required. Required - The algorithm of the key being imported. This does not need to match the version_template of the CryptoKey this version imports into.

.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CryptoKeyVersion.CryptoKeyVersionAlgorithm

The algorithm.

getAlgorithmValue()

public abstract int getAlgorithmValue()

Required. Required - The algorithm of the key being imported. This does not need to match the version_template of the CryptoKey this version imports into.

.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for algorithm.

getCryptoKeyVersion()

public abstract String getCryptoKeyVersion()

Optional. The optional name of an existing CryptoKeyVersion to target for an import operation. If this field is not present, a new CryptoKeyVersion containing the supplied key material is created.

If this field is present, the supplied key material is imported into the existing CryptoKeyVersion. To import into an existing CryptoKeyVersion, the CryptoKeyVersion must be a child of ImportTrustedKeyWrappedCryptoKeyVersionRequest.parent, have been previously created via ImportTrustedKeyWrappedCryptoKeyVersion, and be in DESTROYED or IMPORT_FAILED state. The key material and algorithm must match the previous CryptoKeyVersion exactly if the CryptoKeyVersion has ever contained key material

string crypto_key_version = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The cryptoKeyVersion.

getCryptoKeyVersionBytes()

public abstract ByteString getCryptoKeyVersionBytes()

Optional. The optional name of an existing CryptoKeyVersion to target for an import operation. If this field is not present, a new CryptoKeyVersion containing the supplied key material is created.

If this field is present, the supplied key material is imported into the existing CryptoKeyVersion. To import into an existing CryptoKeyVersion, the CryptoKeyVersion must be a child of ImportTrustedKeyWrappedCryptoKeyVersionRequest.parent, have been previously created via ImportTrustedKeyWrappedCryptoKeyVersion, and be in DESTROYED or IMPORT_FAILED state. The key material and algorithm must match the previous CryptoKeyVersion exactly if the CryptoKeyVersion has ever contained key material

string crypto_key_version = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for cryptoKeyVersion.

getImportingKey()

public abstract String getImportingKey()

Required. Required - the CKV of the trusted key used to import. This can be the name of a CryptoKeyVersion or a CryptoKey.

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

Returns
Type Description
String

The importingKey.

getImportingKeyBytes()

public abstract ByteString getImportingKeyBytes()

Required. Required - the CKV of the trusted key used to import. This can be the name of a CryptoKeyVersion or a CryptoKey.

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

Returns
Type Description
ByteString

The bytes for importingKey.

getParent()

public abstract String getParent()

Required. The name of the CryptoKey to be imported into.

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

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. The name of the CryptoKey to be imported into.

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

Returns
Type Description
ByteString

The bytes for parent.

getWrappedKey()

public abstract ByteString getWrappedKey()

Required. The target key pre-wrapped on premises.

bytes wrapped_key = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The wrappedKey.