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

Class RawEncryptResponse

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Response message for KeyManagementService.RawEncrypt.

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

Method Summary

Modifier and Type	Method and Description
RawEncryptResponse	clone()
byte[]	decodeCiphertext() The encrypted data.
byte[]	decodeInitializationVector() The initialization vector (IV) generated by the service during encryption.
RawEncryptResponse	encodeCiphertext(byte[] ciphertext) The encrypted data.
RawEncryptResponse	encodeInitializationVector(byte[] initializationVector) The initialization vector (IV) generated by the service during encryption.
String	getCiphertext() The encrypted data.
Long	getCiphertextCrc32c() Integrity verification field.
String	getInitializationVector() The initialization vector (IV) generated by the service during encryption.
Long	getInitializationVectorCrc32c() Integrity verification field.
String	getName() The resource name of the CryptoKeyVersion used in encryption.
String	getProtectionLevel() The ProtectionLevel of the CryptoKeyVersion used in encryption.
Integer	getTagLength() The length of the authentication tag that is appended to the end of the ciphertext.
Boolean	getVerifiedAdditionalAuthenticatedDataCrc32c() Integrity verification field.
Boolean	getVerifiedInitializationVectorCrc32c() Integrity verification field.
Boolean	getVerifiedPlaintextCrc32c() Integrity verification field.
RawEncryptResponse	set(String fieldName, Object value)
RawEncryptResponse	setCiphertext(String ciphertext) The encrypted data.
RawEncryptResponse	setCiphertextCrc32c(Long ciphertextCrc32c) Integrity verification field.
RawEncryptResponse	setInitializationVector(String initializationVector) The initialization vector (IV) generated by the service during encryption.
RawEncryptResponse	setInitializationVectorCrc32c(Long initializationVectorCrc32c) Integrity verification field.
RawEncryptResponse	setName(String name) The resource name of the CryptoKeyVersion used in encryption.
RawEncryptResponse	setProtectionLevel(String protectionLevel) The ProtectionLevel of the CryptoKeyVersion used in encryption.
RawEncryptResponse	setTagLength(Integer tagLength) The length of the authentication tag that is appended to the end of the ciphertext.
RawEncryptResponse	setVerifiedAdditionalAuthenticatedDataCrc32c(Boolean verifiedAdditionalAuthenticatedDataCrc32c) Integrity verification field.
RawEncryptResponse	setVerifiedInitializationVectorCrc32c(Boolean verifiedInitializationVectorCrc32c) Integrity verification field.
RawEncryptResponse	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

RawEncryptResponse

public RawEncryptResponse()

Method Detail

getCiphertext

public String getCiphertext()

The encrypted data. In the case of AES-GCM, the authentication tag is the tag_length bytes at the end of this field.

Returns:

value or null for none

See Also:

decodeCiphertext()

decodeCiphertext

public byte[] decodeCiphertext()

The encrypted data. In the case of AES-GCM, the authentication tag is the tag_length bytes at the end of this field.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getCiphertext()

setCiphertext

public RawEncryptResponse setCiphertext(String ciphertext)

The encrypted data. In the case of AES-GCM, the authentication tag is the tag_length bytes at the end of this field.

Parameters:

ciphertext - ciphertext or null for none

See Also:

#encodeCiphertext()

encodeCiphertext

public RawEncryptResponse encodeCiphertext(byte[] ciphertext)

The encrypted data. In the case of AES-GCM, the authentication tag is the tag_length bytes at the end of this field.

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 RawEncryptResponse.ciphertext. An integrity check of ciphertext can be performed by computing the CRC32C checksum of 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.

Returns:

value or null for none

setCiphertextCrc32c

public RawEncryptResponse setCiphertextCrc32c(Long ciphertextCrc32c)

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

Parameters:

ciphertextCrc32c - ciphertextCrc32c or null for none

getInitializationVector

public String getInitializationVector()

The initialization vector (IV) generated by the service during encryption. This value must be stored and provided in RawDecryptRequest.initialization_vector at decryption time.

Returns:

value or null for none

See Also:

decodeInitializationVector()

decodeInitializationVector

public byte[] decodeInitializationVector()

The initialization vector (IV) generated by the service during encryption. This value must be stored and provided in RawDecryptRequest.initialization_vector at decryption time.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getInitializationVector()

setInitializationVector

public RawEncryptResponse setInitializationVector(String initializationVector)

The initialization vector (IV) generated by the service during encryption. This value must be stored and provided in RawDecryptRequest.initialization_vector at decryption time.

Parameters:

initializationVector - initializationVector or null for none

See Also:

#encodeInitializationVector()

encodeInitializationVector

public RawEncryptResponse encodeInitializationVector(byte[] initializationVector)

The initialization vector (IV) generated by the service during encryption. This value must be stored and provided in RawDecryptRequest.initialization_vector at decryption time.

Since:

1.14

See Also:

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

getInitializationVectorCrc32c

public Long getInitializationVectorCrc32c()

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

Returns:

value or null for none

setInitializationVectorCrc32c

public RawEncryptResponse setInitializationVectorCrc32c(Long initializationVectorCrc32c)

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

Parameters:

initializationVectorCrc32c - initializationVectorCrc32c 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 RawEncryptResponse 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

getProtectionLevel

public String getProtectionLevel()

The ProtectionLevel of the CryptoKeyVersion used in encryption.

Returns:

value or null for none

setProtectionLevel

public RawEncryptResponse setProtectionLevel(String protectionLevel)

The ProtectionLevel of the CryptoKeyVersion used in encryption.

Parameters:

protectionLevel - protectionLevel or null for none

getTagLength

public Integer getTagLength()

The length of the authentication tag that is appended to the end of the ciphertext.

Returns:

value or null for none

setTagLength

public RawEncryptResponse setTagLength(Integer tagLength)

The length of the authentication tag that is appended to the end of the ciphertext.

Parameters:

tagLength - tagLength or null for none

getVerifiedAdditionalAuthenticatedDataCrc32c

public Boolean getVerifiedAdditionalAuthenticatedDataCrc32c()

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

Returns:

value or null for none

setVerifiedAdditionalAuthenticatedDataCrc32c

public RawEncryptResponse setVerifiedAdditionalAuthenticatedDataCrc32c(Boolean verifiedAdditionalAuthenticatedDataCrc32c)

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

Parameters:

verifiedAdditionalAuthenticatedDataCrc32c - verifiedAdditionalAuthenticatedDataCrc32c or null for none

getVerifiedInitializationVectorCrc32c

public Boolean getVerifiedInitializationVectorCrc32c()

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

Returns:

value or null for none

setVerifiedInitializationVectorCrc32c

public RawEncryptResponse setVerifiedInitializationVectorCrc32c(Boolean verifiedInitializationVectorCrc32c)

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

Parameters:

verifiedInitializationVectorCrc32c - verifiedInitializationVectorCrc32c or null for none

getVerifiedPlaintextCrc32c

public Boolean getVerifiedPlaintextCrc32c()

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

Returns:

value or null for none

setVerifiedPlaintextCrc32c

public RawEncryptResponse setVerifiedPlaintextCrc32c(Boolean verifiedPlaintextCrc32c)

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

Parameters:

verifiedPlaintextCrc32c - verifiedPlaintextCrc32c or null for none

set

public RawEncryptResponse set(String fieldName,
                              Object value)

Overrides:

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

clone

public RawEncryptResponse clone()

Overrides:

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