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
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CustomerManagedEncryption.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public CustomerManagedEncryption build()
Returns
buildPartial()
public CustomerManagedEncryption buildPartial()
Returns
clear()
public CustomerManagedEncryption.Builder clear()
Returns
Overrides
clearField(Descriptors.FieldDescriptor field)
public CustomerManagedEncryption.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
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
clearOneof(Descriptors.OneofDescriptor oneof)
public CustomerManagedEncryption.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clone()
public CustomerManagedEncryption.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public CustomerManagedEncryption getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
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
Type | Description |
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
Type | Description |
ByteString | The bytes for kmsKeyName.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(CustomerManagedEncryption other)
public CustomerManagedEncryption.Builder mergeFrom(CustomerManagedEncryption other)
Parameter
Returns
public CustomerManagedEncryption.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public CustomerManagedEncryption.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CustomerManagedEncryption.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public CustomerManagedEncryption.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
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
Name | Description |
value | String
The kmsKeyName to set.
|
Returns
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
Name | Description |
value | ByteString
The bytes for kmsKeyName to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CustomerManagedEncryption.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final CustomerManagedEncryption.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides