Package com.google.cloud.compute.v1

Interface CustomerEncryptionKeyOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getKmsKeyName()
    The name of the encryption key that is stored in Google Cloud KMS.
    com.google.protobuf.ByteString
    getKmsKeyNameBytes()
    The name of the encryption key that is stored in Google Cloud KMS.
    String
    getKmsKeyServiceAccount()
    The service account being used for the encryption request for the given KMS key.
    com.google.protobuf.ByteString
    getKmsKeyServiceAccountBytes()
    The service account being used for the encryption request for the given KMS key.
    String
    getRawKey()
    Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
    com.google.protobuf.ByteString
    getRawKeyBytes()
    Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
    String
    getRsaEncryptedKey()
    Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
    com.google.protobuf.ByteString
    getRsaEncryptedKeyBytes()
    Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
    String
    getSha256()
    [Output only] TheRFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
    com.google.protobuf.ByteString
    getSha256Bytes()
    [Output only] TheRFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
    boolean
    hasKmsKeyName()
    The name of the encryption key that is stored in Google Cloud KMS.
    boolean
    hasKmsKeyServiceAccount()
    The service account being used for the encryption request for the given KMS key.
    boolean
    hasRawKey()
    Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
    boolean
    hasRsaEncryptedKey()
    Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
    boolean
    hasSha256()
    [Output only] TheRFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasKmsKeyName

      boolean hasKmsKeyName()
       The name of the encryption key that is stored in Google Cloud KMS.
 For example:

 "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
 key_region/cryptoKeys/key

 The fully-qualifed key name may be returned for resource GET requests. For
 example:

 "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
 key_region/cryptoKeys/key
 /cryptoKeyVersions/1
      optional string kms_key_name = 484373913;
      Returns:
      Whether the kmsKeyName field is set.

    • getKmsKeyName

      String getKmsKeyName()
       The name of the encryption key that is stored in Google Cloud KMS.
 For example:

 "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
 key_region/cryptoKeys/key

 The fully-qualifed key name may be returned for resource GET requests. For
 example:

 "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
 key_region/cryptoKeys/key
 /cryptoKeyVersions/1
      optional string kms_key_name = 484373913;
      Returns:
      The kmsKeyName.

    • getKmsKeyNameBytes

      com.google.protobuf.ByteString getKmsKeyNameBytes()
       The name of the encryption key that is stored in Google Cloud KMS.
 For example:

 "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
 key_region/cryptoKeys/key

 The fully-qualifed key name may be returned for resource GET requests. For
 example:

 "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
 key_region/cryptoKeys/key
 /cryptoKeyVersions/1
      optional string kms_key_name = 484373913;
      Returns:
      The bytes for kmsKeyName.

    • hasKmsKeyServiceAccount

      boolean hasKmsKeyServiceAccount()
       The service account being used for the encryption request for the given KMS
 key. If absent, the Compute Engine default service account is used.
 For example:

 "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
      optional string kms_key_service_account = 209986261;
      Returns:
      Whether the kmsKeyServiceAccount field is set.

    • getKmsKeyServiceAccount

      String getKmsKeyServiceAccount()
       The service account being used for the encryption request for the given KMS
 key. If absent, the Compute Engine default service account is used.
 For example:

 "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
      optional string kms_key_service_account = 209986261;
      Returns:
      The kmsKeyServiceAccount.

    • getKmsKeyServiceAccountBytes

      com.google.protobuf.ByteString getKmsKeyServiceAccountBytes()
       The service account being used for the encryption request for the given KMS
 key. If absent, the Compute Engine default service account is used.
 For example:

 "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
      optional string kms_key_service_account = 209986261;
      Returns:
      The bytes for kmsKeyServiceAccount.

    • hasRawKey

      boolean hasRawKey()
       Specifies a 256-bit customer-supplied
 encryption key, encoded in RFC
 4648 base64 to either encrypt or decrypt this resource. You can
 provide either the rawKey or thersaEncryptedKey.
 For example:

 "rawKey":
 "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
      optional string raw_key = 449196488;
      Returns:
      Whether the rawKey field is set.

    • getRawKey

      String getRawKey()
       Specifies a 256-bit customer-supplied
 encryption key, encoded in RFC
 4648 base64 to either encrypt or decrypt this resource. You can
 provide either the rawKey or thersaEncryptedKey.
 For example:

 "rawKey":
 "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
      optional string raw_key = 449196488;
      Returns:
      The rawKey.

    • getRawKeyBytes

      com.google.protobuf.ByteString getRawKeyBytes()
       Specifies a 256-bit customer-supplied
 encryption key, encoded in RFC
 4648 base64 to either encrypt or decrypt this resource. You can
 provide either the rawKey or thersaEncryptedKey.
 For example:

 "rawKey":
 "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
      optional string raw_key = 449196488;
      Returns:
      The bytes for rawKey.

    • hasRsaEncryptedKey

      boolean hasRsaEncryptedKey()
       Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
 customer-supplied encryption key to either encrypt or decrypt this
 resource. You can provide either the rawKey or thersaEncryptedKey.
 For example:

 "rsaEncryptedKey":
 "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
 z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
 D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="

 The key must meet the following requirements before you can provide it to
 Compute Engine:

 1. The key is wrapped using a RSA public key certificate provided by
 Google.
 2. After being wrapped, the key must be encoded in RFC 4648 base64
 encoding.

 Gets the RSA public key certificate provided by Google at:


 https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
      optional string rsa_encrypted_key = 335487397;
      Returns:
      Whether the rsaEncryptedKey field is set.

    • getRsaEncryptedKey

      String getRsaEncryptedKey()
       Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
 customer-supplied encryption key to either encrypt or decrypt this
 resource. You can provide either the rawKey or thersaEncryptedKey.
 For example:

 "rsaEncryptedKey":
 "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
 z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
 D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="

 The key must meet the following requirements before you can provide it to
 Compute Engine:

 1. The key is wrapped using a RSA public key certificate provided by
 Google.
 2. After being wrapped, the key must be encoded in RFC 4648 base64
 encoding.

 Gets the RSA public key certificate provided by Google at:


 https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
      optional string rsa_encrypted_key = 335487397;
      Returns:
      The rsaEncryptedKey.

    • getRsaEncryptedKeyBytes

      com.google.protobuf.ByteString getRsaEncryptedKeyBytes()
       Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
 customer-supplied encryption key to either encrypt or decrypt this
 resource. You can provide either the rawKey or thersaEncryptedKey.
 For example:

 "rsaEncryptedKey":
 "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
 z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
 D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="

 The key must meet the following requirements before you can provide it to
 Compute Engine:

 1. The key is wrapped using a RSA public key certificate provided by
 Google.
 2. After being wrapped, the key must be encoded in RFC 4648 base64
 encoding.

 Gets the RSA public key certificate provided by Google at:


 https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
      optional string rsa_encrypted_key = 335487397;
      Returns:
      The bytes for rsaEncryptedKey.

    • hasSha256

      boolean hasSha256()
       [Output only] TheRFC
 4648 base64 encoded SHA-256 hash of the customer-supplied
 encryption key that protects this resource.
      optional string sha256 = 170112551;
      Returns:
      Whether the sha256 field is set.

    • getSha256

      String getSha256()
       [Output only] TheRFC
 4648 base64 encoded SHA-256 hash of the customer-supplied
 encryption key that protects this resource.
      optional string sha256 = 170112551;
      Returns:
      The sha256.

    • getSha256Bytes

      com.google.protobuf.ByteString getSha256Bytes()
       [Output only] TheRFC
 4648 base64 encoded SHA-256 hash of the customer-supplied
 encryption key that protects this resource.
      optional string sha256 = 170112551;
      Returns:
      The bytes for sha256.