com.google.api.services.cloudkms.v1.model

Class DecapsulateResponse

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.cloudkms.v1.model.DecapsulateResponse

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class DecapsulateResponse
extends com.google.api.client.json.GenericJson

Response message for KeyManagementService.Decapsulate.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Key Management Service (KMS) API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
DecapsulateResponse()

Method Summary

Modifier and Type	Method and Description
DecapsulateResponse	clone()
byte[]	decodeSharedSecret() The decapsulated shared_secret originally encapsulated with the matching public key.
DecapsulateResponse	encodeSharedSecret(byte[] sharedSecret) The decapsulated shared_secret originally encapsulated with the matching public key.
String	getName() The resource name of the CryptoKeyVersion used for decapsulation.
String	getProtectionLevel() The ProtectionLevel of the CryptoKeyVersion used in decapsulation.
String	getSharedSecret() The decapsulated shared_secret originally encapsulated with the matching public key.
Long	getSharedSecretCrc32c() Integrity verification field.
Boolean	getVerifiedCiphertextCrc32c() Integrity verification field.
DecapsulateResponse	set(String fieldName, Object value)
DecapsulateResponse	setName(String name) The resource name of the CryptoKeyVersion used for decapsulation.
DecapsulateResponse	setProtectionLevel(String protectionLevel) The ProtectionLevel of the CryptoKeyVersion used in decapsulation.
DecapsulateResponse	setSharedSecret(String sharedSecret) The decapsulated shared_secret originally encapsulated with the matching public key.
DecapsulateResponse	setSharedSecretCrc32c(Long sharedSecretCrc32c) Integrity verification field.
DecapsulateResponse	setVerifiedCiphertextCrc32c(Boolean verifiedCiphertextCrc32c) Integrity verification field.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

DecapsulateResponse

public DecapsulateResponse()

Method Detail

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.

Returns:

value or null for none

setName

public DecapsulateResponse setName(String name)

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

Parameters:

name - name or null for none

getProtectionLevel

public String getProtectionLevel()

The ProtectionLevel of the CryptoKeyVersion used in decapsulation.

Returns:

value or null for none

setProtectionLevel

public DecapsulateResponse setProtectionLevel(String protectionLevel)

The ProtectionLevel of the CryptoKeyVersion used in decapsulation.

Parameters:

protectionLevel - protectionLevel or null for none

getSharedSecret

public String getSharedSecret()

The decapsulated shared_secret originally encapsulated with the matching public key.

Returns:

value or null for none

See Also:

decodeSharedSecret()

decodeSharedSecret

public byte[] decodeSharedSecret()

The decapsulated shared_secret originally encapsulated with the matching public key.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getSharedSecret()

setSharedSecret

public DecapsulateResponse setSharedSecret(String sharedSecret)

The decapsulated shared_secret originally encapsulated with the matching public key.

Parameters:

sharedSecret - sharedSecret or null for none

See Also:

#encodeSharedSecret()

encodeSharedSecret

public DecapsulateResponse encodeSharedSecret(byte[] sharedSecret)

The decapsulated shared_secret originally encapsulated with the matching public key.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

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.

Returns:

value or null for none

setSharedSecretCrc32c

public DecapsulateResponse setSharedSecretCrc32c(Long sharedSecretCrc32c)

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.

Parameters:

sharedSecretCrc32c - sharedSecretCrc32c or null for none

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.

Returns:

value or null for none

setVerifiedCiphertextCrc32c

public DecapsulateResponse setVerifiedCiphertextCrc32c(Boolean verifiedCiphertextCrc32c)

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.

Parameters:

verifiedCiphertextCrc32c - verifiedCiphertextCrc32c or null for none

set

public DecapsulateResponse set(String fieldName,
                               Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public DecapsulateResponse clone()

Overrides:

clone in class com.google.api.client.json.GenericJson