Package com.google.cloud.kms.v1

Interface ImportJobOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ImportJob, ImportJob.Builder
@Generated public interface ImportJobOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Output only. The resource name for this
 [ImportJob][google.cloud.kms.v1.ImportJob] in the format
 `projects/*/locations/*/keyRings/*/importJobs/*`.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Output only. The resource name for this
 [ImportJob][google.cloud.kms.v1.ImportJob] in the format
 `projects/*/locations/*/keyRings/*/importJobs/*`.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for name.

    • getImportMethodValue

      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:
      The enum numeric value on the wire for importMethod.

    • getImportMethod

      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:
      The importMethod.

    • getProtectionLevelValue

      int getProtectionLevelValue()
       Required. Immutable. The protection level of the
 [ImportJob][google.cloud.kms.v1.ImportJob]. This must match the
 [protection_level][google.cloud.kms.v1.CryptoKeyVersionTemplate.protection_level]
 of the [version_template][google.cloud.kms.v1.CryptoKey.version_template]
 on the [CryptoKey][google.cloud.kms.v1.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:
      The enum numeric value on the wire for protectionLevel.

    • getProtectionLevel

      ProtectionLevel getProtectionLevel()
       Required. Immutable. The protection level of the
 [ImportJob][google.cloud.kms.v1.ImportJob]. This must match the
 [protection_level][google.cloud.kms.v1.CryptoKeyVersionTemplate.protection_level]
 of the [version_template][google.cloud.kms.v1.CryptoKey.version_template]
 on the [CryptoKey][google.cloud.kms.v1.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:
      The protectionLevel.

    • hasCreateTime

      boolean hasCreateTime()
       Output only. The time at which this
 [ImportJob][google.cloud.kms.v1.ImportJob] was created.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. The time at which this
 [ImportJob][google.cloud.kms.v1.ImportJob] was created.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The time at which this
 [ImportJob][google.cloud.kms.v1.ImportJob] was created.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasGenerateTime

      boolean hasGenerateTime()
       Output only. The time this [ImportJob][google.cloud.kms.v1.ImportJob]'s key
 material was generated.
      .google.protobuf.Timestamp generate_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the generateTime field is set.

    • getGenerateTime

      com.google.protobuf.Timestamp getGenerateTime()
       Output only. The time this [ImportJob][google.cloud.kms.v1.ImportJob]'s key
 material was generated.
      .google.protobuf.Timestamp generate_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The generateTime.

    • getGenerateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getGenerateTimeOrBuilder()
       Output only. The time this [ImportJob][google.cloud.kms.v1.ImportJob]'s key
 material was generated.
      .google.protobuf.Timestamp generate_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasExpireTime

      boolean hasExpireTime()
       Output only. The time at which this
 [ImportJob][google.cloud.kms.v1.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:
      Whether the expireTime field is set.

    • getExpireTime

      com.google.protobuf.Timestamp getExpireTime()
       Output only. The time at which this
 [ImportJob][google.cloud.kms.v1.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:
      The expireTime.

    • getExpireTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder()
       Output only. The time at which this
 [ImportJob][google.cloud.kms.v1.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];

    • hasExpireEventTime

      boolean hasExpireEventTime()
       Output only. The time this [ImportJob][google.cloud.kms.v1.ImportJob]
 expired. Only present if [state][google.cloud.kms.v1.ImportJob.state] is
 [EXPIRED][google.cloud.kms.v1.ImportJob.ImportJobState.EXPIRED].
      .google.protobuf.Timestamp expire_event_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the expireEventTime field is set.

    • getExpireEventTime

      com.google.protobuf.Timestamp getExpireEventTime()
       Output only. The time this [ImportJob][google.cloud.kms.v1.ImportJob]
 expired. Only present if [state][google.cloud.kms.v1.ImportJob.state] is
 [EXPIRED][google.cloud.kms.v1.ImportJob.ImportJobState.EXPIRED].
      .google.protobuf.Timestamp expire_event_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The expireEventTime.

    • getExpireEventTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getExpireEventTimeOrBuilder()
       Output only. The time this [ImportJob][google.cloud.kms.v1.ImportJob]
 expired. Only present if [state][google.cloud.kms.v1.ImportJob.state] is
 [EXPIRED][google.cloud.kms.v1.ImportJob.ImportJobState.EXPIRED].
      .google.protobuf.Timestamp expire_event_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getStateValue

      int getStateValue()
       Output only. The current state of the
 [ImportJob][google.cloud.kms.v1.ImportJob], indicating if it can be used.
      .google.cloud.kms.v1.ImportJob.ImportJobState state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for state.

    • getState

      ImportJob.ImportJobState getState()
       Output only. The current state of the
 [ImportJob][google.cloud.kms.v1.ImportJob], indicating if it can be used.
      .google.cloud.kms.v1.ImportJob.ImportJobState state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The state.

    • hasPublicKey

      boolean hasPublicKey()
       Output only. The public key with which to wrap key material prior to
 import. Only returned if [state][google.cloud.kms.v1.ImportJob.state] is
 [ACTIVE][google.cloud.kms.v1.ImportJob.ImportJobState.ACTIVE].
      .google.cloud.kms.v1.ImportJob.WrappingPublicKey public_key = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the publicKey field is set.

    • getPublicKey

      ImportJob.WrappingPublicKey getPublicKey()
       Output only. The public key with which to wrap key material prior to
 import. Only returned if [state][google.cloud.kms.v1.ImportJob.state] is
 [ACTIVE][google.cloud.kms.v1.ImportJob.ImportJobState.ACTIVE].
      .google.cloud.kms.v1.ImportJob.WrappingPublicKey public_key = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The publicKey.

    • getPublicKeyOrBuilder

      ImportJob.WrappingPublicKeyOrBuilder getPublicKeyOrBuilder()
       Output only. The public key with which to wrap key material prior to
 import. Only returned if [state][google.cloud.kms.v1.ImportJob.state] is
 [ACTIVE][google.cloud.kms.v1.ImportJob.ImportJobState.ACTIVE].
      .google.cloud.kms.v1.ImportJob.WrappingPublicKey public_key = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getPublicKeyFormatValue

      int getPublicKeyFormatValue()
       Output only. Specifies the
 [WrappingPublicKey][google.cloud.kms.v1.ImportJob.WrappingPublicKey] format
 provided by the customer in the
 [KeyManagementService.GetImportJob][google.cloud.kms.v1.KeyManagementService.GetImportJob]
 request.
      .google.cloud.kms.v1.PublicKey.PublicKeyFormat public_key_format = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for publicKeyFormat.

    • getPublicKeyFormat

      PublicKey.PublicKeyFormat getPublicKeyFormat()
       Output only. Specifies the
 [WrappingPublicKey][google.cloud.kms.v1.ImportJob.WrappingPublicKey] format
 provided by the customer in the
 [KeyManagementService.GetImportJob][google.cloud.kms.v1.KeyManagementService.GetImportJob]
 request.
      .google.cloud.kms.v1.PublicKey.PublicKeyFormat public_key_format = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The publicKeyFormat.

    • hasAttestation

      boolean hasAttestation()
       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][google.cloud.kms.v1.ImportJob.ImportMethod] is one with a
 protection level of [HSM][google.cloud.kms.v1.ProtectionLevel.HSM].
      .google.cloud.kms.v1.KeyOperationAttestation attestation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the attestation field is set.

    • getAttestation

      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][google.cloud.kms.v1.ImportJob.ImportMethod] is one with a
 protection level of [HSM][google.cloud.kms.v1.ProtectionLevel.HSM].
      .google.cloud.kms.v1.KeyOperationAttestation attestation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The attestation.

    • getAttestationOrBuilder

      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][google.cloud.kms.v1.ImportJob.ImportMethod] is one with a
 protection level of [HSM][google.cloud.kms.v1.ProtectionLevel.HSM].
      .google.cloud.kms.v1.KeyOperationAttestation attestation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getCryptoKeyBackend

      String getCryptoKeyBackend()
       Immutable. The resource name of the backend environment where the key
 material for the wrapping key resides and where all related cryptographic
 operations are performed. Currently, this field is only populated for keys
 stored in HSM_SINGLE_TENANT. Note, this list is non-exhaustive and may
 apply to additional [ProtectionLevels][google.cloud.kms.v1.ProtectionLevel]
 in the future. Supported resources:
 * `"projects/*/locations/*/singleTenantHsmInstances/*"`
      string crypto_key_backend = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      The cryptoKeyBackend.

    • getCryptoKeyBackendBytes

      com.google.protobuf.ByteString getCryptoKeyBackendBytes()
       Immutable. The resource name of the backend environment where the key
 material for the wrapping key resides and where all related cryptographic
 operations are performed. Currently, this field is only populated for keys
 stored in HSM_SINGLE_TENANT. Note, this list is non-exhaustive and may
 apply to additional [ProtectionLevels][google.cloud.kms.v1.ProtectionLevel]
 in the future. Supported resources:
 * `"projects/*/locations/*/singleTenantHsmInstances/*"`
      string crypto_key_backend = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for cryptoKeyBackend.