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

Class EncryptResponse

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class EncryptResponse
extends GenericJson

Response message for KeyManagementService.Encrypt.

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

Method Summary

Modifier and Type	Method and Description
EncryptResponse	clone()
byte[]	decodeCiphertext() The encrypted data.
EncryptResponse	encodeCiphertext(byte[] ciphertext) The encrypted data.
String	getCiphertext() The encrypted data.
Long	getCiphertextCrc32c() Integrity verification field.
String	getName() The resource name of the CryptoKeyVersion used in encryption.
Boolean	getVerifiedAdditionalAuthenticatedDataCrc32c() Integrity verification field.
Boolean	getVerifiedPlaintextCrc32c() Integrity verification field.
EncryptResponse	set(String fieldName, Object value)
EncryptResponse	setCiphertext(String ciphertext) The encrypted data.
EncryptResponse	setCiphertextCrc32c(Long ciphertextCrc32c) Integrity verification field.
EncryptResponse	setName(String name) The resource name of the CryptoKeyVersion used in encryption.
EncryptResponse	setVerifiedAdditionalAuthenticatedDataCrc32c(Boolean verifiedAdditionalAuthenticatedDataCrc32c) Integrity verification field.
EncryptResponse	setVerifiedPlaintextCrc32c(Boolean verifiedPlaintextCrc32c) 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

EncryptResponse

public EncryptResponse()

Method Detail

getCiphertext

public String getCiphertext()

The encrypted data.

Returns:

value or null for none

See Also:

decodeCiphertext()

decodeCiphertext

public byte[] decodeCiphertext()

The encrypted data.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getCiphertext()

setCiphertext

public EncryptResponse setCiphertext(String ciphertext)

The encrypted data.

Parameters:

ciphertext - ciphertext or null for none

See Also:

#encodeCiphertext()

encodeCiphertext

public EncryptResponse encodeCiphertext(byte[] ciphertext)

The encrypted data.

Since:

1.14

See Also:

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

getCiphertextCrc32c

public Long 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. NOTE: This field is in Beta.

Returns:

value or null for none

setCiphertextCrc32c

public EncryptResponse setCiphertextCrc32c(Long ciphertextCrc32c)

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. NOTE: This field is in Beta.

Parameters:

ciphertextCrc32c - ciphertextCrc32c or null for none

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.

Returns:

value or null for none

setName

public EncryptResponse setName(String name)

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

Parameters:

name - name or null for none

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. NOTE: This field is in Beta.

Returns:

value or null for none

setVerifiedAdditionalAuthenticatedDataCrc32c

public EncryptResponse setVerifiedAdditionalAuthenticatedDataCrc32c(Boolean verifiedAdditionalAuthenticatedDataCrc32c)

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. NOTE: This field is in Beta.

Parameters:

verifiedAdditionalAuthenticatedDataCrc32c - verifiedAdditionalAuthenticatedDataCrc32c or null for none

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. NOTE: This field is in Beta.

Returns:

value or null for none

setVerifiedPlaintextCrc32c

public EncryptResponse setVerifiedPlaintextCrc32c(Boolean verifiedPlaintextCrc32c)

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. NOTE: This field is in Beta.

Parameters:

verifiedPlaintextCrc32c - verifiedPlaintextCrc32c or null for none

set

public EncryptResponse set(String fieldName,
                           Object value)

Overrides:

set in class GenericJson

clone

public EncryptResponse clone()

Overrides:

clone in class GenericJson