Class CustomerEncryptionKey (0.10.0) 

public final class CustomerEncryptionKey extends GeneratedMessageV3 implements CustomerEncryptionKeyOrBuilder

A customer-supplied encryption key.

Protobuf type google.cloud.backupdr.v1.CustomerEncryptionKey

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CustomerEncryptionKey

Static Fields

KMS_KEY_NAME_FIELD_NUMBER

public static final int KMS_KEY_NAME_FIELD_NUMBER
Field Value
Type Description
int

KMS_KEY_SERVICE_ACCOUNT_FIELD_NUMBER

public static final int KMS_KEY_SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

RAW_KEY_FIELD_NUMBER

public static final int RAW_KEY_FIELD_NUMBER
Field Value
Type Description
int

RSA_ENCRYPTED_KEY_FIELD_NUMBER

public static final int RSA_ENCRYPTED_KEY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CustomerEncryptionKey getDefaultInstance()
Returns
Type Description
CustomerEncryptionKey

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CustomerEncryptionKey.Builder newBuilder()
Returns
Type Description
CustomerEncryptionKey.Builder

newBuilder(CustomerEncryptionKey prototype)

public static CustomerEncryptionKey.Builder newBuilder(CustomerEncryptionKey prototype)
Parameter
Name Description
prototype CustomerEncryptionKey
Returns
Type Description
CustomerEncryptionKey.Builder

parseDelimitedFrom(InputStream input)

public static CustomerEncryptionKey parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CustomerEncryptionKey
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomerEncryptionKey parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomerEncryptionKey
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CustomerEncryptionKey parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CustomerEncryptionKey
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CustomerEncryptionKey parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomerEncryptionKey
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CustomerEncryptionKey parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CustomerEncryptionKey
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CustomerEncryptionKey parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomerEncryptionKey
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CustomerEncryptionKey parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CustomerEncryptionKey
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomerEncryptionKey parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomerEncryptionKey
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CustomerEncryptionKey parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CustomerEncryptionKey
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomerEncryptionKey parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomerEncryptionKey
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CustomerEncryptionKey parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CustomerEncryptionKey
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CustomerEncryptionKey parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomerEncryptionKey
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CustomerEncryptionKey> parser()
Returns
Type Description
Parser<CustomerEncryptionKey>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public CustomerEncryptionKey getDefaultInstanceForType()
Returns
Type Description
CustomerEncryptionKey

getKeyCase()

public CustomerEncryptionKey.KeyCase getKeyCase()
Returns
Type Description
CustomerEncryptionKey.KeyCase

getKmsKeyName()

public String getKmsKeyName()

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()

public ByteString getKmsKeyNameBytes()

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()

public String getKmsKeyServiceAccount()

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()

public ByteString getKmsKeyServiceAccountBytes()

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()

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

getRawKey()

public String getRawKey()

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()

public ByteString getRawKeyBytes()

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()

public String getRsaEncryptedKey()

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()

public ByteString getRsaEncryptedKeyBytes()

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()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasKmsKeyName()

public boolean hasKmsKeyName()

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()

public boolean hasKmsKeyServiceAccount()

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()

public boolean hasRawKey()

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()

public boolean hasRsaEncryptedKey()

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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CustomerEncryptionKey.Builder newBuilderForType()
Returns
Type Description
CustomerEncryptionKey.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CustomerEncryptionKey.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CustomerEncryptionKey.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CustomerEncryptionKey.Builder toBuilder()
Returns
Type Description
CustomerEncryptionKey.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException