com.google.logging.v2

Interface CmekSettingsOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

CmekSettings, CmekSettings.Builder

public interface CmekSettingsOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getKmsKeyName() The resource name for the configured Cloud KMS key.
com.google.protobuf.ByteString	getKmsKeyNameBytes() The resource name for the configured Cloud KMS key.
String	getName() Output Only.
com.google.protobuf.ByteString	getNameBytes() Output Only.
String	getServiceAccountId() Output Only.
com.google.protobuf.ByteString	getServiceAccountIdBytes() Output Only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Output Only. The resource name of the CMEK settings.
 

string name = 1;

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Output Only. The resource name of the CMEK settings.
 

string name = 1;

Returns:

The bytes for name.

getKmsKeyName

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](/logging/docs/routing/managed-encryption) for more information.
 

string kms_key_name = 2;

Returns:

The kmsKeyName.

getKmsKeyNameBytes

com.google.protobuf.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](/logging/docs/routing/managed-encryption) for more information.
 

string kms_key_name = 2;

Returns:

The bytes for kmsKeyName.

getServiceAccountId

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][google.logging.v2.ConfigServiceV2.GetCmekSettings] to
 obtain the service account ID.
 See [Enabling CMEK for Logs
 Router](/logging/docs/routing/managed-encryption) for more information.
 

string service_account_id = 3;

Returns:

The serviceAccountId.

getServiceAccountIdBytes

com.google.protobuf.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][google.logging.v2.ConfigServiceV2.GetCmekSettings] to
 obtain the service account ID.
 See [Enabling CMEK for Logs
 Router](/logging/docs/routing/managed-encryption) for more information.
 

string service_account_id = 3;

Returns:

The bytes for serviceAccountId.