Class CustomerEncryptionKey (0.13.0) 

publicfinalclass CustomerEncryptionKeyextendsGeneratedMessageV3implementsCustomerEncryptionKeyOrBuilder

A customer-supplied encryption key.

Protobuf type google.cloud.backupdr.v1.CustomerEncryptionKey

Inherited Members

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

KMS_KEY_NAME_FIELD_NUMBER

publicstaticfinalintKMS_KEY_NAME_FIELD_NUMBER
Field Value
Type Description
int

KMS_KEY_SERVICE_ACCOUNT_FIELD_NUMBER

publicstaticfinalintKMS_KEY_SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

RAW_KEY_FIELD_NUMBER

publicstaticfinalintRAW_KEY_FIELD_NUMBER
Field Value
Type Description
int

RSA_ENCRYPTED_KEY_FIELD_NUMBER

publicstaticfinalintRSA_ENCRYPTED_KEY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticCustomerEncryptionKeygetDefaultInstance()
Returns
Type Description
CustomerEncryptionKey

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticCustomerEncryptionKey.BuildernewBuilder()
Returns
Type Description
CustomerEncryptionKey.Builder

newBuilder(CustomerEncryptionKey prototype)

publicstaticCustomerEncryptionKey.BuildernewBuilder(CustomerEncryptionKeyprototype)
Parameter
Name Description
prototype CustomerEncryptionKey
Returns
Type Description
CustomerEncryptionKey.Builder

parseDelimitedFrom(InputStream input)

publicstaticCustomerEncryptionKeyparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
CustomerEncryptionKey
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticCustomerEncryptionKeyparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomerEncryptionKey
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticCustomerEncryptionKeyparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
CustomerEncryptionKey
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticCustomerEncryptionKeyparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomerEncryptionKey
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticCustomerEncryptionKeyparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
CustomerEncryptionKey
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticCustomerEncryptionKeyparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomerEncryptionKey
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticCustomerEncryptionKeyparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CustomerEncryptionKey
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticCustomerEncryptionKeyparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomerEncryptionKey
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticCustomerEncryptionKeyparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
CustomerEncryptionKey
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticCustomerEncryptionKeyparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomerEncryptionKey
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticCustomerEncryptionKeyparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CustomerEncryptionKey
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticCustomerEncryptionKeyparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomerEncryptionKey
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<CustomerEncryptionKey>parser()
Returns
Type Description
Parser<CustomerEncryptionKey>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

publicCustomerEncryptionKeygetDefaultInstanceForType()
Returns
Type Description
CustomerEncryptionKey

getKeyCase()

publicCustomerEncryptionKey.KeyCasegetKeyCase()
Returns
Type Description
CustomerEncryptionKey.KeyCase

getKmsKeyName()

publicStringgetKmsKeyName()

Optional. The name of the encryption key that is stored in Google Cloud KMS.

string kms_key_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The kmsKeyName.

getKmsKeyNameBytes()

publicByteStringgetKmsKeyNameBytes()

Optional. The name of the encryption key that is stored in Google Cloud KMS.

string kms_key_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for kmsKeyName.

getKmsKeyServiceAccount()

publicStringgetKmsKeyServiceAccount()

Optional. The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

optional string kms_key_service_account = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The kmsKeyServiceAccount.

getKmsKeyServiceAccountBytes()

publicByteStringgetKmsKeyServiceAccountBytes()

Optional. The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

optional string kms_key_service_account = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for kmsKeyServiceAccount.

getParserForType()

publicParser<CustomerEncryptionKey>getParserForType()
Returns
Type Description
Parser<CustomerEncryptionKey>
Overrides

getRawKey()

publicStringgetRawKey()

Optional. Specifies a 256-bit customer-supplied encryption key.

string raw_key = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The rawKey.

getRawKeyBytes()

publicByteStringgetRawKeyBytes()

Optional. Specifies a 256-bit customer-supplied encryption key.

string raw_key = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for rawKey.

getRsaEncryptedKey()

publicStringgetRsaEncryptedKey()

Optional. RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

string rsa_encrypted_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The rsaEncryptedKey.

getRsaEncryptedKeyBytes()

publicByteStringgetRsaEncryptedKeyBytes()

Optional. RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

string rsa_encrypted_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for rsaEncryptedKey.

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

hasKmsKeyName()

publicbooleanhasKmsKeyName()

Optional. The name of the encryption key that is stored in Google Cloud KMS.

string kms_key_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the kmsKeyName field is set.

hasKmsKeyServiceAccount()

publicbooleanhasKmsKeyServiceAccount()

Optional. The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

optional string kms_key_service_account = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the kmsKeyServiceAccount field is set.

hasRawKey()

publicbooleanhasRawKey()

Optional. Specifies a 256-bit customer-supplied encryption key.

string raw_key = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the rawKey field is set.

hasRsaEncryptedKey()

publicbooleanhasRsaEncryptedKey()

Optional. RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

string rsa_encrypted_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the rsaEncryptedKey field is set.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicCustomerEncryptionKey.BuildernewBuilderForType()
Returns
Type Description
CustomerEncryptionKey.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedCustomerEncryptionKey.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CustomerEncryptionKey.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicCustomerEncryptionKey.BuildertoBuilder()
Returns
Type Description
CustomerEncryptionKey.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.