Interface CmekSettingsOrBuilder (0.3.0)

public interface CmekSettingsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getKmsKey()

public abstract String getKmsKey()

Optional. The resource name for the configured Cloud KMS key. The format is:

projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]

For example:

projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key

string kms_key = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The kmsKey.

getKmsKeyBytes()

public abstract ByteString getKmsKeyBytes()

Optional. The resource name for the configured Cloud KMS key. The format is:

projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]

For example:

projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key

string kms_key = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for kmsKey.

getKmsKeyVersion()

public abstract String getKmsKeyVersion()

Output only. The CryptoKeyVersion resource name for the configured Cloud KMS key. The format is:

projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]

For example:

projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1

This read-only field is used to convey the specific configured CryptoKeyVersion of the kms_key that has been configured. It is populated when the CMEK settings are bound to a single key version.

string kms_key_version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The kmsKeyVersion.

getKmsKeyVersionBytes()

public abstract ByteString getKmsKeyVersionBytes()

Output only. The CryptoKeyVersion resource name for the configured Cloud KMS key. The format is:

projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]

For example:

projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1

This read-only field is used to convey the specific configured CryptoKeyVersion of the kms_key that has been configured. It is populated when the CMEK settings are bound to a single key version.

string kms_key_version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for kmsKeyVersion.

getServiceAccountId()

public abstract String getServiceAccountId()

Output only. The service account used to access the key.

string service_account_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The serviceAccountId.

getServiceAccountIdBytes()

public abstract ByteString getServiceAccountIdBytes()

Output only. The service account used to access the key.

string service_account_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for serviceAccountId.