Class ImportJob.Builder (2.27.0)

public static final class ImportJob.Builder extends GeneratedMessageV3.Builder<ImportJob.Builder> implements ImportJobOrBuilder

An ImportJob can be used to create CryptoKeys and CryptoKeyVersions using pre-existing key material, generated outside of Cloud KMS.

When an ImportJob is created, Cloud KMS will generate a "wrapping key", which is a public/private key pair. You use the wrapping key to encrypt (also known as wrap) the pre-existing key material to protect it during the import process. The nature of the wrapping key depends on the choice of import_method. When the wrapping key generation is complete, the state will be set to ACTIVE and the public_key can be fetched. The fetched public key can then be used to wrap your pre-existing key material.

Once the key material is wrapped, it can be imported into a new CryptoKeyVersion in an existing CryptoKey by calling ImportCryptoKeyVersion. Multiple CryptoKeyVersions can be imported with a single ImportJob. Cloud KMS uses the private key portion of the wrapping key to unwrap the key material. Only Cloud KMS has access to the private key.

An ImportJob expires 3 days after it is created. Once expired, Cloud KMS will no longer be able to import or unwrap any key material that was wrapped with the ImportJob's public key.

For more information, see Importing a key.

Protobuf type google.cloud.kms.v1.ImportJob

Implements

ImportJobOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ImportJob.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ImportJob.Builder
Overrides

build()

public ImportJob build()
Returns
TypeDescription
ImportJob

buildPartial()

public ImportJob buildPartial()
Returns
TypeDescription
ImportJob

clear()

public ImportJob.Builder clear()
Returns
TypeDescription
ImportJob.Builder
Overrides

clearAttestation()

public ImportJob.Builder clearAttestation()

Output only. Statement that was generated and signed by the key creator (for example, an HSM) at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only present if the chosen ImportMethod is one with a protection level of HSM.

.google.cloud.kms.v1.KeyOperationAttestation attestation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ImportJob.Builder

clearCreateTime()

public ImportJob.Builder clearCreateTime()

Output only. The time at which this ImportJob was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ImportJob.Builder

clearExpireEventTime()

public ImportJob.Builder clearExpireEventTime()

Output only. The time this ImportJob expired. Only present if state is EXPIRED.

.google.protobuf.Timestamp expire_event_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ImportJob.Builder

clearExpireTime()

public ImportJob.Builder clearExpireTime()

Output only. The time at which this ImportJob is scheduled for expiration and can no longer be used to import key material.

.google.protobuf.Timestamp expire_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ImportJob.Builder

clearField(Descriptors.FieldDescriptor field)

public ImportJob.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ImportJob.Builder
Overrides

clearGenerateTime()

public ImportJob.Builder clearGenerateTime()

Output only. The time this ImportJob's key material was generated.

.google.protobuf.Timestamp generate_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ImportJob.Builder

clearImportMethod()

public ImportJob.Builder clearImportMethod()

Required. Immutable. The wrapping method to be used for incoming key material.

.google.cloud.kms.v1.ImportJob.ImportMethod import_method = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
ImportJob.Builder

This builder for chaining.

clearName()

public ImportJob.Builder clearName()

Output only. The resource name for this ImportJob in the format projects/*/locations/*/keyRings/*/importJobs/*.

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

Returns
TypeDescription
ImportJob.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ImportJob.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ImportJob.Builder
Overrides

clearProtectionLevel()

public ImportJob.Builder clearProtectionLevel()

Required. Immutable. The protection level of the ImportJob. This must match the protection_level of the version_template on the CryptoKey you attempt to import into.

.google.cloud.kms.v1.ProtectionLevel protection_level = 9 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
ImportJob.Builder

This builder for chaining.

clearPublicKey()

public ImportJob.Builder clearPublicKey()

Output only. The public key with which to wrap key material prior to import. Only returned if state is ACTIVE.

.google.cloud.kms.v1.ImportJob.WrappingPublicKey public_key = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ImportJob.Builder

clearState()

public ImportJob.Builder clearState()

Output only. The current state of the ImportJob, indicating if it can be used.

.google.cloud.kms.v1.ImportJob.ImportJobState state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ImportJob.Builder

This builder for chaining.

clone()

public ImportJob.Builder clone()
Returns
TypeDescription
ImportJob.Builder
Overrides

getAttestation()

public KeyOperationAttestation getAttestation()

Output only. Statement that was generated and signed by the key creator (for example, an HSM) at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only present if the chosen ImportMethod is one with a protection level of HSM.

.google.cloud.kms.v1.KeyOperationAttestation attestation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
KeyOperationAttestation

The attestation.

getAttestationBuilder()

public KeyOperationAttestation.Builder getAttestationBuilder()

Output only. Statement that was generated and signed by the key creator (for example, an HSM) at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only present if the chosen ImportMethod is one with a protection level of HSM.

.google.cloud.kms.v1.KeyOperationAttestation attestation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
KeyOperationAttestation.Builder

getAttestationOrBuilder()

public KeyOperationAttestationOrBuilder getAttestationOrBuilder()

Output only. Statement that was generated and signed by the key creator (for example, an HSM) at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only present if the chosen ImportMethod is one with a protection level of HSM.

.google.cloud.kms.v1.KeyOperationAttestation attestation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
KeyOperationAttestationOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. The time at which this ImportJob was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time at which this ImportJob was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time at which this ImportJob was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public ImportJob getDefaultInstanceForType()
Returns
TypeDescription
ImportJob

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getExpireEventTime()

public Timestamp getExpireEventTime()

Output only. The time this ImportJob expired. Only present if state is EXPIRED.

.google.protobuf.Timestamp expire_event_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The expireEventTime.

getExpireEventTimeBuilder()

public Timestamp.Builder getExpireEventTimeBuilder()

Output only. The time this ImportJob expired. Only present if state is EXPIRED.

.google.protobuf.Timestamp expire_event_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Builder

getExpireEventTimeOrBuilder()

public TimestampOrBuilder getExpireEventTimeOrBuilder()

Output only. The time this ImportJob expired. Only present if state is EXPIRED.

.google.protobuf.Timestamp expire_event_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getExpireTime()

public Timestamp getExpireTime()

Output only. The time at which this ImportJob is scheduled for expiration and can no longer be used to import key material.

.google.protobuf.Timestamp expire_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The expireTime.

getExpireTimeBuilder()

public Timestamp.Builder getExpireTimeBuilder()

Output only. The time at which this ImportJob is scheduled for expiration and can no longer be used to import key material.

.google.protobuf.Timestamp expire_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Builder

getExpireTimeOrBuilder()

public TimestampOrBuilder getExpireTimeOrBuilder()

Output only. The time at which this ImportJob is scheduled for expiration and can no longer be used to import key material.

.google.protobuf.Timestamp expire_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getGenerateTime()

public Timestamp getGenerateTime()

Output only. The time this ImportJob's key material was generated.

.google.protobuf.Timestamp generate_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The generateTime.

getGenerateTimeBuilder()

public Timestamp.Builder getGenerateTimeBuilder()

Output only. The time this ImportJob's key material was generated.

.google.protobuf.Timestamp generate_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Builder

getGenerateTimeOrBuilder()

public TimestampOrBuilder getGenerateTimeOrBuilder()

Output only. The time this ImportJob's key material was generated.

.google.protobuf.Timestamp generate_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getImportMethod()

public ImportJob.ImportMethod getImportMethod()

Required. Immutable. The wrapping method to be used for incoming key material.

.google.cloud.kms.v1.ImportJob.ImportMethod import_method = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
ImportJob.ImportMethod

The importMethod.

getImportMethodValue()

public int getImportMethodValue()

Required. Immutable. The wrapping method to be used for incoming key material.

.google.cloud.kms.v1.ImportJob.ImportMethod import_method = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
int

The enum numeric value on the wire for importMethod.

getName()

public String getName()

Output only. The resource name for this ImportJob in the format projects/*/locations/*/keyRings/*/importJobs/*.

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name for this ImportJob in the format projects/*/locations/*/keyRings/*/importJobs/*.

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

Returns
TypeDescription