Class CustomerManagedEncryption (2.36.0)

public final class CustomerManagedEncryption extends GeneratedMessageV3 implements CustomerManagedEncryptionOrBuilder

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

Protobuf type google.cloud.secretmanager.v1.CustomerManagedEncryption

Static Fields

KMS_KEY_NAME_FIELD_NUMBER

public static final int KMS_KEY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CustomerManagedEncryption getDefaultInstance()
Returns
TypeDescription
CustomerManagedEncryption

getDescriptor()

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

newBuilder()

public static CustomerManagedEncryption.Builder newBuilder()
Returns
TypeDescription
CustomerManagedEncryption.Builder

newBuilder(CustomerManagedEncryption prototype)

public static CustomerManagedEncryption.Builder newBuilder(CustomerManagedEncryption prototype)
Parameter
NameDescription
prototypeCustomerManagedEncryption
Returns
TypeDescription
CustomerManagedEncryption.Builder

parseDelimitedFrom(InputStream input)

public static CustomerManagedEncryption parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CustomerManagedEncryption
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomerManagedEncryption parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CustomerManagedEncryption
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CustomerManagedEncryption parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CustomerManagedEncryption
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CustomerManagedEncryption parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CustomerManagedEncryption
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CustomerManagedEncryption parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CustomerManagedEncryption
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CustomerManagedEncryption parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CustomerManagedEncryption
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CustomerManagedEncryption parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CustomerManagedEncryption
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomerManagedEncryption parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CustomerManagedEncryption
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CustomerManagedEncryption parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CustomerManagedEncryption
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomerManagedEncryption parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CustomerManagedEncryption
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CustomerManagedEncryption parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CustomerManagedEncryption
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CustomerManagedEncryption parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CustomerManagedEncryption
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CustomerManagedEncryption> parser()
Returns
TypeDescription
Parser<CustomerManagedEncryption>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public CustomerManagedEncryption getDefaultInstanceForType()
Returns
TypeDescription
CustomerManagedEncryption

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.

getParserForType()

public Parser<CustomerManagedEncryption> getParserForType()
Returns
TypeDescription
Parser<CustomerManagedEncryption>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CustomerManagedEncryption.Builder newBuilderForType()
Returns
TypeDescription
CustomerManagedEncryption.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CustomerManagedEncryption.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CustomerManagedEncryption.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CustomerManagedEncryption.Builder toBuilder()
Returns
TypeDescription
CustomerManagedEncryption.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException