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

Class RawDecryptRequest

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Request message for KeyManagementService.RawDecrypt.

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

Method Summary

Modifier and Type	Method and Description
RawDecryptRequest	clone()
byte[]	decodeAdditionalAuthenticatedData() Optional.
byte[]	decodeCiphertext() Required.
byte[]	decodeInitializationVector() Required.
RawDecryptRequest	encodeAdditionalAuthenticatedData(byte[] additionalAuthenticatedData) Optional.
RawDecryptRequest	encodeCiphertext(byte[] ciphertext) Required.
RawDecryptRequest	encodeInitializationVector(byte[] initializationVector) Required.
String	getAdditionalAuthenticatedData() Optional.
Long	getAdditionalAuthenticatedDataCrc32c() Optional.
String	getCiphertext() Required.
Long	getCiphertextCrc32c() Optional.
String	getInitializationVector() Required.
Long	getInitializationVectorCrc32c() Optional.
Integer	getTagLength() The length of the authentication tag that is appended to the end of the ciphertext.
RawDecryptRequest	set(String fieldName, Object value)
RawDecryptRequest	setAdditionalAuthenticatedData(String additionalAuthenticatedData) Optional.
RawDecryptRequest	setAdditionalAuthenticatedDataCrc32c(Long additionalAuthenticatedDataCrc32c) Optional.
RawDecryptRequest	setCiphertext(String ciphertext) Required.
RawDecryptRequest	setCiphertextCrc32c(Long ciphertextCrc32c) Optional.
RawDecryptRequest	setInitializationVector(String initializationVector) Required.
RawDecryptRequest	setInitializationVectorCrc32c(Long initializationVectorCrc32c) Optional.
RawDecryptRequest	setTagLength(Integer tagLength) The length of the authentication tag that is appended to the end of the ciphertext.

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

RawDecryptRequest

public RawDecryptRequest()

Method Detail

getAdditionalAuthenticatedData

public String getAdditionalAuthenticatedData()

Optional. Optional data that must match the data originally supplied in RawEncryptRequest.additional_authenticated_data.

Returns:

value or null for none

See Also:

decodeAdditionalAuthenticatedData()

decodeAdditionalAuthenticatedData

public byte[] decodeAdditionalAuthenticatedData()

Optional. Optional data that must match the data originally supplied in RawEncryptRequest.additional_authenticated_data.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getAdditionalAuthenticatedData()

setAdditionalAuthenticatedData

public RawDecryptRequest setAdditionalAuthenticatedData(String additionalAuthenticatedData)

Optional. Optional data that must match the data originally supplied in RawEncryptRequest.additional_authenticated_data.

Parameters:

additionalAuthenticatedData - additionalAuthenticatedData or null for none

See Also:

#encodeAdditionalAuthenticatedData()

encodeAdditionalAuthenticatedData

public RawDecryptRequest encodeAdditionalAuthenticatedData(byte[] additionalAuthenticatedData)

Optional. Optional data that must match the data originally supplied in RawEncryptRequest.additional_authenticated_data.

Since:

1.14

See Also:

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

getAdditionalAuthenticatedDataCrc32c

public Long getAdditionalAuthenticatedDataCrc32c()

Optional. An optional CRC32C checksum of the RawDecryptRequest.additional_authenticated_data. If specified, KeyManagementService will verify the integrity of the received additional_authenticated_data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(additional_authenticated_data) is equal to additional_authenticated_data_crc32c, and if so, 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

setAdditionalAuthenticatedDataCrc32c

public RawDecryptRequest setAdditionalAuthenticatedDataCrc32c(Long additionalAuthenticatedDataCrc32c)

Optional. An optional CRC32C checksum of the RawDecryptRequest.additional_authenticated_data. If specified, KeyManagementService will verify the integrity of the received additional_authenticated_data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(additional_authenticated_data) is equal to additional_authenticated_data_crc32c, and if so, 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:

additionalAuthenticatedDataCrc32c - additionalAuthenticatedDataCrc32c or null for none

getCiphertext

public String getCiphertext()

Required. The encrypted data originally returned in RawEncryptResponse.ciphertext.

Returns:

value or null for none

See Also:

decodeCiphertext()

decodeCiphertext

public byte[] decodeCiphertext()

Required. The encrypted data originally returned in RawEncryptResponse.ciphertext.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getCiphertext()

setCiphertext

public RawDecryptRequest setCiphertext(String ciphertext)

Required. The encrypted data originally returned in RawEncryptResponse.ciphertext.

Parameters:

ciphertext - ciphertext or null for none

See Also:

#encodeCiphertext()

encodeCiphertext

public RawDecryptRequest encodeCiphertext(byte[] ciphertext)

Required. The encrypted data originally returned in RawEncryptResponse.ciphertext.

Since:

1.14

See Also:

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

getCiphertextCrc32c

public Long getCiphertextCrc32c()

Optional. An optional CRC32C checksum of the RawDecryptRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(ciphertext) is equal to ciphertext_crc32c, and if so, 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 RawDecryptRequest setCiphertextCrc32c(Long ciphertextCrc32c)

Optional. An optional CRC32C checksum of the RawDecryptRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(ciphertext) is equal to ciphertext_crc32c, and if so, 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()

Required. The initialization vector (IV) used during encryption, which must match the data originally provided in RawEncryptResponse.initialization_vector.

Returns:

value or null for none

See Also:

decodeInitializationVector()

decodeInitializationVector

public byte[] decodeInitializationVector()

Required. The initialization vector (IV) used during encryption, which must match the data originally provided in RawEncryptResponse.initialization_vector.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getInitializationVector()

setInitializationVector

public RawDecryptRequest setInitializationVector(String initializationVector)

Required. The initialization vector (IV) used during encryption, which must match the data originally provided in RawEncryptResponse.initialization_vector.

Parameters:

initializationVector - initializationVector or null for none

See Also:

#encodeInitializationVector()

encodeInitializationVector

public RawDecryptRequest encodeInitializationVector(byte[] initializationVector)

Required. The initialization vector (IV) used during encryption, which must match the data originally provided in RawEncryptResponse.initialization_vector.

Since:

1.14

See Also:

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

getInitializationVectorCrc32c

public Long getInitializationVectorCrc32c()

Optional. An optional CRC32C checksum of the RawDecryptRequest.initialization_vector. If specified, KeyManagementService will verify the integrity of the received initialization_vector using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(initialization_vector) is equal to initialization_vector_crc32c, and if so, 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 RawDecryptRequest setInitializationVectorCrc32c(Long initializationVectorCrc32c)

Optional. An optional CRC32C checksum of the RawDecryptRequest.initialization_vector. If specified, KeyManagementService will verify the integrity of the received initialization_vector using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(initialization_vector) is equal to initialization_vector_crc32c, and if so, 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

getTagLength

public Integer getTagLength()

The length of the authentication tag that is appended to the end of the ciphertext. If unspecified (0), the default value for the key's algorithm will be used (for AES-GCM, the default value is 16).

Returns:

value or null for none

setTagLength

public RawDecryptRequest setTagLength(Integer tagLength)

The length of the authentication tag that is appended to the end of the ciphertext. If unspecified (0), the default value for the key's algorithm will be used (for AES-GCM, the default value is 16).

Parameters:

tagLength - tagLength or null for none

set

public RawDecryptRequest set(String fieldName,
                             Object value)

Overrides:

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

clone

public RawDecryptRequest clone()

Overrides:

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