Class CmekSettings.Builder (3.5.3)

public static final class CmekSettings.Builder extends 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 Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization. See Enabling CMEK for Logs Router for more information.

Protobuf type google.logging.v2.CmekSettings

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CmekSettings.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CmekSettings.Builder
Overrides

build()

public CmekSettings build()
Returns
TypeDescription
CmekSettings

buildPartial()

public CmekSettings buildPartial()
Returns
TypeDescription
CmekSettings

clear()

public CmekSettings.Builder clear()
Returns
TypeDescription
CmekSettings.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public CmekSettings.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
CmekSettings.Builder
Overrides

clearKmsKeyName()

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-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;

Returns
TypeDescription
CmekSettings.Builder

This builder for chaining.

clearName()

public CmekSettings.Builder clearName()

Output only. The resource name of the CMEK settings.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
CmekSettings.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public CmekSettings.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
CmekSettings.Builder
Overrides

clearServiceAccountId()

public CmekSettings.Builder clearServiceAccountId()

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];

Returns
TypeDescription
CmekSettings.Builder

This builder for chaining.

clone()

public CmekSettings.Builder clone()
Returns
TypeDescription
CmekSettings.Builder
Overrides

getDefaultInstanceForType()

public CmekSettings getDefaultInstanceForType()
Returns
TypeDescription
CmekSettings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getKmsKeyName()

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-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;

Returns
TypeDescription
String

The kmsKeyName.

getKmsKeyNameBytes()

public 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;

Returns
TypeDescription
ByteString

The bytes for kmsKeyName.

getName()

public String getName()

Output only. The resource name of the CMEK settings.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of the CMEK settings.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for name.

getServiceAccountId()

public 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];

Returns
TypeDescription
String

The serviceAccountId.

getServiceAccountIdBytes()

public 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];

Returns
TypeDescription
ByteString

The bytes for serviceAccountId.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CmekSettings other)

public CmekSettings.Builder mergeFrom(CmekSettings other)
Parameter
NameDescription
otherCmekSettings
Returns
TypeDescription
CmekSettings.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CmekSettings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CmekSettings.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public CmekSettings.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
CmekSettings.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CmekSettings.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CmekSettings.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public CmekSettings.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CmekSettings.Builder
Overrides

setKmsKeyName(String value)

public 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-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;

Parameter
NameDescription
valueString

The kmsKeyName to set.

Returns
TypeDescription
CmekSettings.Builder

This builder for chaining.

setKmsKeyNameBytes(ByteString value)

public CmekSettings.Builder setKmsKeyNameBytes(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-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;

Parameter
NameDescription
valueByteString

The bytes for kmsKeyName to set.

Returns
TypeDescription
CmekSettings.Builder

This builder for chaining.

setName(String value)

public CmekSettings.Builder setName(String value)

Output only. The resource name of the CMEK settings.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
CmekSettings.Builder

This builder for chaining.

setNameBytes(ByteString value)

public CmekSettings.Builder setNameBytes(ByteString value)

Output only. The resource name of the CMEK settings.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
CmekSettings.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CmekSettings.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
CmekSettings.Builder
Overrides

setServiceAccountId(String value)

public CmekSettings.Builder setServiceAccountId(String value)

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];

Parameter
NameDescription
valueString

The serviceAccountId to set.

Returns
TypeDescription
CmekSettings.Builder

This builder for chaining.

setServiceAccountIdBytes(ByteString value)

public CmekSettings.Builder setServiceAccountIdBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for serviceAccountId to set.

Returns
TypeDescription
CmekSettings.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CmekSettings.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CmekSettings.Builder
Overrides