Package 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
    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
    getKmsKeyVersionName()
    The CryptoKeyVersion resource name for the configured Cloud KMS key.
    com.google.protobuf.ByteString
    getKmsKeyVersionNameBytes()
    The CryptoKeyVersion 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.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getName

      String getName()
       Output only. The resource name of the CMEK settings.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Output only. The resource name of the CMEK settings.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      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/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"`



 To enable CMEK for the Log Router, set this field to a valid
 `kms_key_name` for which the associated service account has the required
 cloudkms.cryptoKeyEncrypterDecrypter roles 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 or disabled by setting the key name
 to an empty string. 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 Log Router, set this field to an empty string.

 See [Enabling CMEK for Log
 Router](https://cloud.google.com/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/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"`



 To enable CMEK for the Log Router, set this field to a valid
 `kms_key_name` for which the associated service account has the required
 cloudkms.cryptoKeyEncrypterDecrypter roles 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 or disabled by setting the key name
 to an empty string. 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 Log Router, set this field to an empty string.

 See [Enabling CMEK for Log
 Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
 for more information.
      string kms_key_name = 2;
      Returns:
      The bytes for kmsKeyName.

    • getKmsKeyVersionName

      String getKmsKeyVersionName()
       The CryptoKeyVersion resource name for the configured Cloud KMS key.

 KMS key name format:

     "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 is a read-only field used to convey the specific configured
 CryptoKeyVersion of `kms_key` that has been configured. It will be
 populated in cases where the CMEK settings are bound to a single key
 version.

 If this field is populated, the `kms_key` is tied to a specific
 CryptoKeyVersion.
      string kms_key_version_name = 4;
      Returns:
      The kmsKeyVersionName.

    • getKmsKeyVersionNameBytes

      com.google.protobuf.ByteString getKmsKeyVersionNameBytes()
       The CryptoKeyVersion resource name for the configured Cloud KMS key.

 KMS key name format:

     "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 is a read-only field used to convey the specific configured
 CryptoKeyVersion of `kms_key` that has been configured. It will be
 populated in cases where the CMEK settings are bound to a single key
 version.

 If this field is populated, the `kms_key` is tied to a specific
 CryptoKeyVersion.
      string kms_key_version_name = 4;
      Returns:
      The bytes for kmsKeyVersionName.

    • getServiceAccountId

      String getServiceAccountId()
       Output only. The service account that will be used by the Log Router to
 access your Cloud KMS key.

 Before enabling CMEK for Log Router, you must first assign the
 cloudkms.cryptoKeyEncrypterDecrypter role to the service account that
 the Log 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 Log
 Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
 for more information.
      string service_account_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The serviceAccountId.

    • getServiceAccountIdBytes

      com.google.protobuf.ByteString getServiceAccountIdBytes()
       Output only. The service account that will be used by the Log Router to
 access your Cloud KMS key.

 Before enabling CMEK for Log Router, you must first assign the
 cloudkms.cryptoKeyEncrypterDecrypter role to the service account that
 the Log 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 Log
 Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
 for more information.
      string service_account_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for serviceAccountId.