public interface CmekSettingsOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getKmsKeyName()
public abstract String getKmsKeyName() The resource name for the configured Cloud KMS key.
KMS key name format:
"projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]"
For example:
"projects/my-project-id/locations/my-region/keyRings/key-ring-name/cryptoKeys/key-name"
To enable CMEK for the Logs Router, set this field to a valid
kms_key_name for which the associated service account has the required
roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key.
The Cloud KMS key used by the Log Router can be updated by changing the
kms_key_name to a new valid key name. Encryption operations that are in
progress will be completed with the key that was in use when they started.
Decryption operations will be completed using the key that was used at the
time of encryption unless access to that key has been revoked.
To disable CMEK for the Logs Router, set this field to an empty string.
See Enabling CMEK for Logs
Router
for more information.
string kms_key_name = 2;
| Type | Description |
| String | The kmsKeyName. |
getKmsKeyNameBytes()
public abstract ByteString getKmsKeyNameBytes() The resource name for the configured Cloud KMS key.
KMS key name format:
"projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]"
For example:
"projects/my-project-id/locations/my-region/keyRings/key-ring-name/cryptoKeys/key-name"
To enable CMEK for the Logs Router, set this field to a valid
kms_key_name for which the associated service account has the required
roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key.
The Cloud KMS key used by the Log Router can be updated by changing the
kms_key_name to a new valid key name. Encryption operations that are in
progress will be completed with the key that was in use when they started.
Decryption operations will be completed using the key that was used at the
time of encryption unless access to that key has been revoked.
To disable CMEK for the Logs Router, set this field to an empty string.
See Enabling CMEK for Logs
Router
for more information.
string kms_key_name = 2;
| Type | Description |
| ByteString | The bytes for kmsKeyName. |
getName()
public abstract String getName()Output only. The resource name of the CMEK settings.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| String | The name. |
getNameBytes()
public abstract ByteString getNameBytes()Output only. The resource name of the CMEK settings.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| ByteString | The bytes for name. |
getServiceAccountId()
public abstract String getServiceAccountId() Output only. The service account that will be used by the Logs Router to access your
Cloud KMS key.
Before enabling CMEK for Logs Router, you must first assign the role
roles/cloudkms.cryptoKeyEncrypterDecrypter to the service account that
the Logs Router will use to access your Cloud KMS key. Use
GetCmekSettings to
obtain the service account ID.
See Enabling CMEK for Logs
Router
for more information.
string service_account_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| String | The serviceAccountId. |
getServiceAccountIdBytes()
public abstract ByteString getServiceAccountIdBytes() Output only. The service account that will be used by the Logs Router to access your
Cloud KMS key.
Before enabling CMEK for Logs Router, you must first assign the role
roles/cloudkms.cryptoKeyEncrypterDecrypter to the service account that
the Logs Router will use to access your Cloud KMS key. Use
GetCmekSettings to
obtain the service account ID.
See Enabling CMEK for Logs
Router
for more information.
string service_account_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| ByteString | The bytes for serviceAccountId. |