Class CustomerManagedEncryption.Builder (2.36.0)

public static final class CustomerManagedEncryption.Builder extends GeneratedMessageV3.Builder<CustomerManagedEncryption.Builder> implements CustomerManagedEncryptionOrBuilder

Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK).

Protobuf type google.cloud.secretmanager.v1.CustomerManagedEncryption

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public CustomerManagedEncryption build()
Returns
TypeDescription
CustomerManagedEncryption

buildPartial()

public CustomerManagedEncryption buildPartial()
Returns
TypeDescription
CustomerManagedEncryption

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearKmsKeyName()

public CustomerManagedEncryption.Builder clearKmsKeyName()

Required. The resource name of the Cloud KMS CryptoKey used to encrypt secret payloads.

For secrets using the UserManaged replication policy type, Cloud KMS CryptoKeys must reside in the same location as the replica location.

For secrets using the Automatic replication policy type, Cloud KMS CryptoKeys must reside in global.

The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.

string kms_key_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
CustomerManagedEncryption.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

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

getDefaultInstanceForType()

public CustomerManagedEncryption getDefaultInstanceForType()
Returns
TypeDescription
CustomerManagedEncryption

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getKmsKeyName()

public String getKmsKeyName()

Required. The resource name of the Cloud KMS CryptoKey used to encrypt secret payloads.

For secrets using the UserManaged replication policy type, Cloud KMS CryptoKeys must reside in the same location as the replica location.

For secrets using the Automatic replication policy type, Cloud KMS CryptoKeys must reside in global.

The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.

string kms_key_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The kmsKeyName.

getKmsKeyNameBytes()

public ByteString getKmsKeyNameBytes()

Required. The resource name of the Cloud KMS CryptoKey used to encrypt secret payloads.

For secrets using the UserManaged replication policy type, Cloud KMS CryptoKeys must reside in the same location as the replica location.

For secrets using the Automatic replication policy type, Cloud KMS CryptoKeys must reside in global.

The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.

string kms_key_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for kmsKeyName.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CustomerManagedEncryption other)

public CustomerManagedEncryption.Builder mergeFrom(CustomerManagedEncryption other)
Parameter
NameDescription
otherCustomerManagedEncryption
Returns
TypeDescription
CustomerManagedEncryption.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setKmsKeyName(String value)

public CustomerManagedEncryption.Builder setKmsKeyName(String value)

Required. The resource name of the Cloud KMS CryptoKey used to encrypt secret payloads.

For secrets using the UserManaged replication policy type, Cloud KMS CryptoKeys must reside in the same location as the replica location.

For secrets using the Automatic replication policy type, Cloud KMS CryptoKeys must reside in global.

The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.

string kms_key_name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueString

The kmsKeyName to set.

Returns
TypeDescription
CustomerManagedEncryption.Builder

This builder for chaining.

setKmsKeyNameBytes(ByteString value)

public CustomerManagedEncryption.Builder setKmsKeyNameBytes(ByteString value)

Required. The resource name of the Cloud KMS CryptoKey used to encrypt secret payloads.

For secrets using the UserManaged replication policy type, Cloud KMS CryptoKeys must reside in the same location as the replica location.

For secrets using the Automatic replication policy type, Cloud KMS CryptoKeys must reside in global.

The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.

string kms_key_name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueByteString

The bytes for kmsKeyName to set.

Returns
TypeDescription
CustomerManagedEncryption.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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