public static final class CmekSettings.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<CmekSettings.Builder> implements CmekSettingsOrBuilder
Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource. Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization. See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.Protobuf type
google.logging.v2.CmekSettings| Modifier and Type | Method and Description |
|---|---|
CmekSettings.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
CmekSettings |
build() |
CmekSettings |
buildPartial() |
CmekSettings.Builder |
clear() |
CmekSettings.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
CmekSettings.Builder |
clearKmsKeyName()
The resource name for the configured Cloud KMS key.
|
CmekSettings.Builder |
clearKmsKeyVersionName()
The CryptoKeyVersion resource name for the configured Cloud KMS key.
|
CmekSettings.Builder |
clearName()
Output only.
|
CmekSettings.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
CmekSettings.Builder |
clearServiceAccountId()
Output only.
|
CmekSettings.Builder |
clone() |
CmekSettings |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
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.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
CmekSettings.Builder |
mergeFrom(CmekSettings other) |
CmekSettings.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
CmekSettings.Builder |
mergeFrom(com.google.protobuf.Message other) |
CmekSettings.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
CmekSettings.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
CmekSettings.Builder |
setKmsKeyName(String value)
The resource name for the configured Cloud KMS key.
|
CmekSettings.Builder |
setKmsKeyNameBytes(com.google.protobuf.ByteString value)
The resource name for the configured Cloud KMS key.
|
CmekSettings.Builder |
setKmsKeyVersionName(String value)
The CryptoKeyVersion resource name for the configured Cloud KMS key.
|
CmekSettings.Builder |
setKmsKeyVersionNameBytes(com.google.protobuf.ByteString value)
The CryptoKeyVersion resource name for the configured Cloud KMS key.
|
CmekSettings.Builder |
setName(String value)
Output only.
|
CmekSettings.Builder |
setNameBytes(com.google.protobuf.ByteString value)
Output only.
|
CmekSettings.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
CmekSettings.Builder |
setServiceAccountId(String value)
Output only.
|
CmekSettings.Builder |
setServiceAccountIdBytes(com.google.protobuf.ByteString value)
Output only.
|
CmekSettings.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<CmekSettings.Builder>public CmekSettings.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<CmekSettings.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<CmekSettings.Builder>public CmekSettings getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic CmekSettings build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic CmekSettings buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic CmekSettings.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<CmekSettings.Builder>public CmekSettings.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<CmekSettings.Builder>public CmekSettings.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<CmekSettings.Builder>public CmekSettings.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<CmekSettings.Builder>public CmekSettings.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CmekSettings.Builder>public CmekSettings.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CmekSettings.Builder>public CmekSettings.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<CmekSettings.Builder>public CmekSettings.Builder mergeFrom(CmekSettings other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<CmekSettings.Builder>public CmekSettings.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<CmekSettings.Builder>IOExceptionpublic String getName()
Output only. The resource name of the CMEK settings.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];getName in interface CmekSettingsOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Output only. The resource name of the CMEK settings.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];getNameBytes in interface CmekSettingsOrBuilderpublic CmekSettings.Builder setName(String value)
Output only. The resource name of the CMEK settings.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];value - The name to set.public CmekSettings.Builder clearName()
Output only. The resource name of the CMEK settings.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];public CmekSettings.Builder setNameBytes(com.google.protobuf.ByteString value)
Output only. The resource name of the CMEK settings.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];value - The bytes for name to set.public 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;getKmsKeyName in interface CmekSettingsOrBuilderpublic 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;getKmsKeyNameBytes in interface CmekSettingsOrBuilderpublic CmekSettings.Builder setKmsKeyName(String value)
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;value - The kmsKeyName to set.public CmekSettings.Builder clearKmsKeyName()
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;public CmekSettings.Builder setKmsKeyNameBytes(com.google.protobuf.ByteString value)
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;value - The bytes for kmsKeyName to set.public 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;getKmsKeyVersionName in interface CmekSettingsOrBuilderpublic 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;getKmsKeyVersionNameBytes in interface CmekSettingsOrBuilderpublic CmekSettings.Builder setKmsKeyVersionName(String value)
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;value - The kmsKeyVersionName to set.public CmekSettings.Builder clearKmsKeyVersionName()
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;public CmekSettings.Builder setKmsKeyVersionNameBytes(com.google.protobuf.ByteString value)
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;value - The bytes for kmsKeyVersionName to set.public 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];getServiceAccountId in interface CmekSettingsOrBuilderpublic 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];getServiceAccountIdBytes in interface CmekSettingsOrBuilderpublic CmekSettings.Builder setServiceAccountId(String value)
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];value - The serviceAccountId to set.public CmekSettings.Builder clearServiceAccountId()
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];public CmekSettings.Builder setServiceAccountIdBytes(com.google.protobuf.ByteString value)
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];value - The bytes for serviceAccountId to set.public final CmekSettings.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CmekSettings.Builder>public final CmekSettings.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CmekSettings.Builder>Copyright © 2023 Google LLC. All rights reserved.