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

Class DecryptResponse

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.DecryptResponse

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class DecryptResponse
extends GenericJson

Response message for KeyManagementService.Decrypt.

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

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

Method Summary

Modifier and Type	Method and Description
DecryptResponse	clone()
byte[]	decodePlaintext() The decrypted data originally supplied in EncryptRequest.plaintext.
DecryptResponse	encodePlaintext(byte[] plaintext) The decrypted data originally supplied in EncryptRequest.plaintext.
String	getPlaintext() The decrypted data originally supplied in EncryptRequest.plaintext.
Long	getPlaintextCrc32c() Integrity verification field.
String	getProtectionLevel() The ProtectionLevel of the CryptoKeyVersion used in decryption.
Boolean	getUsedPrimary() Whether the Decryption was performed using the primary key version.
DecryptResponse	set(String fieldName, Object value)
DecryptResponse	setPlaintext(String plaintext) The decrypted data originally supplied in EncryptRequest.plaintext.
DecryptResponse	setPlaintextCrc32c(Long plaintextCrc32c) Integrity verification field.
DecryptResponse	setProtectionLevel(String protectionLevel) The ProtectionLevel of the CryptoKeyVersion used in decryption.
DecryptResponse	setUsedPrimary(Boolean usedPrimary) Whether the Decryption was performed using the primary key version.

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

DecryptResponse

public DecryptResponse()

Method Detail

getPlaintext

public String getPlaintext()

The decrypted data originally supplied in EncryptRequest.plaintext.

Returns:

value or null for none

See Also:

decodePlaintext()

decodePlaintext

public byte[] decodePlaintext()

The decrypted data originally supplied in EncryptRequest.plaintext.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getPlaintext()

setPlaintext

public DecryptResponse setPlaintext(String plaintext)

The decrypted data originally supplied in EncryptRequest.plaintext.

Parameters:

plaintext - plaintext or null for none

See Also:

#encodePlaintext()

encodePlaintext

public DecryptResponse encodePlaintext(byte[] plaintext)

The decrypted data originally supplied in EncryptRequest.plaintext.

Since:

1.14

See Also:

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

getPlaintextCrc32c

public Long getPlaintextCrc32c()

Integrity verification field. A CRC32C checksum of the returned DecryptResponse.plaintext. An integrity check of DecryptResponse.plaintext can be performed by computing the CRC32C checksum of DecryptResponse.plaintext 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

setPlaintextCrc32c

public DecryptResponse setPlaintextCrc32c(Long plaintextCrc32c)

Integrity verification field. A CRC32C checksum of the returned DecryptResponse.plaintext. An integrity check of DecryptResponse.plaintext can be performed by computing the CRC32C checksum of DecryptResponse.plaintext 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:

plaintextCrc32c - plaintextCrc32c or null for none

getProtectionLevel

public String getProtectionLevel()

The ProtectionLevel of the CryptoKeyVersion used in decryption.

Returns:

value or null for none

setProtectionLevel

public DecryptResponse setProtectionLevel(String protectionLevel)

The ProtectionLevel of the CryptoKeyVersion used in decryption.

Parameters:

protectionLevel - protectionLevel or null for none

getUsedPrimary

public Boolean getUsedPrimary()

Whether the Decryption was performed using the primary key version.

Returns:

value or null for none

setUsedPrimary

public DecryptResponse setUsedPrimary(Boolean usedPrimary)

Whether the Decryption was performed using the primary key version.

Parameters:

usedPrimary - usedPrimary or null for none

set

public DecryptResponse set(String fieldName,
                           Object value)

Overrides:

set in class GenericJson

clone

public DecryptResponse clone()

Overrides:

clone in class GenericJson