Class EncryptResponse (2.27.0)

public final class EncryptResponse extends GeneratedMessageV3 implements EncryptResponseOrBuilder

Response message for KeyManagementService.Encrypt.

Protobuf type google.cloud.kms.v1.EncryptResponse

Static Fields

CIPHERTEXT_CRC32C_FIELD_NUMBER

public static final int CIPHERTEXT_CRC32C_FIELD_NUMBER
Field Value
TypeDescription
int

CIPHERTEXT_FIELD_NUMBER

public static final int CIPHERTEXT_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PROTECTION_LEVEL_FIELD_NUMBER

public static final int PROTECTION_LEVEL_FIELD_NUMBER
Field Value
TypeDescription
int

VERIFIED_ADDITIONAL_AUTHENTICATED_DATA_CRC32C_FIELD_NUMBER

public static final int VERIFIED_ADDITIONAL_AUTHENTICATED_DATA_CRC32C_FIELD_NUMBER
Field Value
TypeDescription
int

VERIFIED_PLAINTEXT_CRC32C_FIELD_NUMBER

public static final int VERIFIED_PLAINTEXT_CRC32C_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static EncryptResponse getDefaultInstance()
Returns
TypeDescription
EncryptResponse

getDescriptor()

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

newBuilder()

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

newBuilder(EncryptResponse prototype)

public static EncryptResponse.Builder newBuilder(EncryptResponse prototype)
Parameter
NameDescription
prototypeEncryptResponse
Returns
TypeDescription
EncryptResponse.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCiphertext()

public ByteString getCiphertext()

The encrypted data.

bytes ciphertext = 2;

Returns
TypeDescription
ByteString

The ciphertext.

getCiphertextCrc32C()

public Int64Value getCiphertextCrc32C()

Integrity verification field. A CRC32C checksum of the returned EncryptResponse.ciphertext. An integrity check of EncryptResponse.ciphertext can be performed by computing the CRC32C checksum of EncryptResponse.ciphertext and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.

.google.protobuf.Int64Value ciphertext_crc32c = 4;

Returns
TypeDescription
Int64Value

The ciphertextCrc32c.

getCiphertextCrc32COrBuilder()

public Int64ValueOrBuilder getCiphertextCrc32COrBuilder()

Integrity verification field. A CRC32C checksum of the returned EncryptResponse.ciphertext. An integrity check of EncryptResponse.ciphertext can be performed by computing the CRC32C checksum of EncryptResponse.ciphertext and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.

.google.protobuf.Int64Value ciphertext_crc32c = 4;

Returns
TypeDescription
Int64ValueOrBuilder

getDefaultInstanceForType()

public EncryptResponse getDefaultInstanceForType()
Returns
TypeDescription
EncryptResponse

getName()

public String getName()

The resource name of the CryptoKeyVersion used in encryption. Check this field to verify that the intended resource was used for encryption.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The resource name of the CryptoKeyVersion used in encryption. Check this field to verify that the intended resource was used for encryption.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

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

getProtectionLevel()

public ProtectionLevel getProtectionLevel()

The ProtectionLevel of the CryptoKeyVersion used in encryption.

.google.cloud.kms.v1.ProtectionLevel protection_level = 7;

Returns
TypeDescription
ProtectionLevel

The protectionLevel.

getProtectionLevelValue()

public int getProtectionLevelValue()

The ProtectionLevel of the CryptoKeyVersion used in encryption.

.google.cloud.kms.v1.ProtectionLevel protection_level = 7;

Returns
TypeDescription
int

The enum numeric value on the wire for protectionLevel.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getVerifiedAdditionalAuthenticatedDataCrc32C()

public boolean getVerifiedAdditionalAuthenticatedDataCrc32C()

Integrity verification field. A flag indicating whether EncryptRequest.additional_authenticated_data_crc32c was received by KeyManagementService and used for the integrity verification of the AAD. A false value of this field indicates either that EncryptRequest.additional_authenticated_data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set EncryptRequest.additional_authenticated_data_crc32c but this field is still false, discard the response and perform a limited number of retries.

bool verified_additional_authenticated_data_crc32c = 6;

Returns
TypeDescription
boolean

The verifiedAdditionalAuthenticatedDataCrc32c.

getVerifiedPlaintextCrc32C()

public boolean getVerifiedPlaintextCrc32C()

Integrity verification field. A flag indicating whether EncryptRequest.plaintext_crc32c was received by KeyManagementService and used for the integrity verification of the plaintext. A false value of this field indicates either that EncryptRequest.plaintext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set EncryptRequest.plaintext_crc32c but this field is still false, discard the response and perform a limited number of retries.

bool verified_plaintext_crc32c = 5;

Returns
TypeDescription
boolean

The verifiedPlaintextCrc32c.

hasCiphertextCrc32C()

public boolean hasCiphertextCrc32C()

Integrity verification field. A CRC32C checksum of the returned EncryptResponse.ciphertext. An integrity check of EncryptResponse.ciphertext can be performed by computing the CRC32C checksum of EncryptResponse.ciphertext and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.

.google.protobuf.Int64Value ciphertext_crc32c = 4;

Returns
TypeDescription
boolean

Whether the ciphertextCrc32c field is set.

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 EncryptResponse.Builder newBuilderForType()
Returns
TypeDescription
EncryptResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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