Class DecapsulateResponse (2.77.0)

public final class DecapsulateResponse extends GeneratedMessageV3 implements DecapsulateResponseOrBuilder

Response message for KeyManagementService.Decapsulate.

Protobuf type google.cloud.kms.v1.DecapsulateResponse

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PROTECTION_LEVEL_FIELD_NUMBER

public static final int PROTECTION_LEVEL_FIELD_NUMBER
Field Value
Type Description
int

SHARED_SECRET_CRC32C_FIELD_NUMBER

public static final int SHARED_SECRET_CRC32C_FIELD_NUMBER
Field Value
Type Description
int

SHARED_SECRET_FIELD_NUMBER

public static final int SHARED_SECRET_FIELD_NUMBER
Field Value
Type Description
int

VERIFIED_CIPHERTEXT_CRC32C_FIELD_NUMBER

public static final int VERIFIED_CIPHERTEXT_CRC32C_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DecapsulateResponse getDefaultInstance()
Returns
Type Description
DecapsulateResponse

getDescriptor()

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

newBuilder()

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

newBuilder(DecapsulateResponse prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public DecapsulateResponse getDefaultInstanceForType()
Returns
Type Description
DecapsulateResponse

getName()

public String getName()

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

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getProtectionLevel()

public ProtectionLevel getProtectionLevel()

The ProtectionLevel of the CryptoKeyVersion used in decapsulation.

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

Returns
Type Description
ProtectionLevel

The protectionLevel.

getProtectionLevelValue()

public int getProtectionLevelValue()

The ProtectionLevel of the CryptoKeyVersion used in decapsulation.

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

Returns
Type Description
int

The enum numeric value on the wire for protectionLevel.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSharedSecret()

public ByteString getSharedSecret()

The decapsulated shared_secret originally encapsulated with the matching public key.

bytes shared_secret = 2;

Returns
Type Description
ByteString

The sharedSecret.

getSharedSecretCrc32C()

public long getSharedSecretCrc32C()

Integrity verification field. A CRC32C checksum of the returned DecapsulateResponse.shared_secret. An integrity check of DecapsulateResponse.shared_secret can be performed by computing the CRC32C checksum of DecapsulateResponse.shared_secret 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: receiving this response message indicates that KeyManagementService is able to successfully decrypt the ciphertext. 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.

optional int64 shared_secret_crc32c = 3;

Returns
Type Description
long

The sharedSecretCrc32c.

getVerifiedCiphertextCrc32C()

public boolean getVerifiedCiphertextCrc32C()

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

bool verified_ciphertext_crc32c = 4;

Returns
Type Description
boolean

The verifiedCiphertextCrc32c.

hasSharedSecretCrc32C()

public boolean hasSharedSecretCrc32C()

Integrity verification field. A CRC32C checksum of the returned DecapsulateResponse.shared_secret. An integrity check of DecapsulateResponse.shared_secret can be performed by computing the CRC32C checksum of DecapsulateResponse.shared_secret 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: receiving this response message indicates that KeyManagementService is able to successfully decrypt the ciphertext. 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.

optional int64 shared_secret_crc32c = 3;

Returns
Type Description
boolean

Whether the sharedSecretCrc32c 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 DecapsulateResponse.Builder newBuilderForType()
Returns
Type Description
DecapsulateResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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