Class ImportTrustedKeyWrappedCryptoKeyVersionRequest (2.98.0)

public final class ImportTrustedKeyWrappedCryptoKeyVersionRequest extends GeneratedMessage implements ImportTrustedKeyWrappedCryptoKeyVersionRequestOrBuilder

Request message for KeyManagementService.ImportTrustedKeyWrappedCryptoKeyVersion.

Protobuf type google.cloud.kms.v1.ImportTrustedKeyWrappedCryptoKeyVersionRequest

Inheritance

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

Static Fields

ALGORITHM_FIELD_NUMBER

public static final int ALGORITHM_FIELD_NUMBER
Field Value
Type Description
int

CRYPTO_KEY_VERSION_FIELD_NUMBER

public static final int CRYPTO_KEY_VERSION_FIELD_NUMBER
Field Value
Type Description
int

IMPORTING_KEY_FIELD_NUMBER

public static final int IMPORTING_KEY_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

WRAPPED_KEY_FIELD_NUMBER

public static final int WRAPPED_KEY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ImportTrustedKeyWrappedCryptoKeyVersionRequest getDefaultInstance()
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest

getDescriptor()

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

newBuilder()

public static ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder newBuilder()
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder

newBuilder(ImportTrustedKeyWrappedCryptoKeyVersionRequest prototype)

public static ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder newBuilder(ImportTrustedKeyWrappedCryptoKeyVersionRequest prototype)
Parameter
Name Description
prototype ImportTrustedKeyWrappedCryptoKeyVersionRequest
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder

parseDelimitedFrom(InputStream input)

public static ImportTrustedKeyWrappedCryptoKeyVersionRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportTrustedKeyWrappedCryptoKeyVersionRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ImportTrustedKeyWrappedCryptoKeyVersionRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ImportTrustedKeyWrappedCryptoKeyVersionRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ImportTrustedKeyWrappedCryptoKeyVersionRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ImportTrustedKeyWrappedCryptoKeyVersionRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ImportTrustedKeyWrappedCryptoKeyVersionRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportTrustedKeyWrappedCryptoKeyVersionRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ImportTrustedKeyWrappedCryptoKeyVersionRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportTrustedKeyWrappedCryptoKeyVersionRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ImportTrustedKeyWrappedCryptoKeyVersionRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ImportTrustedKeyWrappedCryptoKeyVersionRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ImportTrustedKeyWrappedCryptoKeyVersionRequest> parser()
Returns
Type Description
Parser<ImportTrustedKeyWrappedCryptoKeyVersionRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAlgorithm()

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

getDefaultInstanceForType()

public ImportTrustedKeyWrappedCryptoKeyVersionRequest getDefaultInstanceForType()
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest

getImportingKey()

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

getParserForType()

public Parser<ImportTrustedKeyWrappedCryptoKeyVersionRequest> getParserForType()
Returns
Type Description
Parser<ImportTrustedKeyWrappedCryptoKeyVersionRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getWrappedKey()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder newBuilderForType()
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder
Overrides

toBuilder()

public ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder toBuilder()
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException