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

Class DecryptRequest

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class DecryptRequest
extends GenericJson

Request 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
DecryptRequest()

Method Summary

Modifier and Type	Method and Description
DecryptRequest	clone()
byte[]	decodeAdditionalAuthenticatedData() Optional.
byte[]	decodeCiphertext() Required.
DecryptRequest	encodeAdditionalAuthenticatedData(byte[] additionalAuthenticatedData) Optional.
DecryptRequest	encodeCiphertext(byte[] ciphertext) Required.
String	getAdditionalAuthenticatedData() Optional.
Long	getAdditionalAuthenticatedDataCrc32c() Optional.
String	getCiphertext() Required.
Long	getCiphertextCrc32c() Optional.
DecryptRequest	set(String fieldName, Object value)
DecryptRequest	setAdditionalAuthenticatedData(String additionalAuthenticatedData) Optional.
DecryptRequest	setAdditionalAuthenticatedDataCrc32c(Long additionalAuthenticatedDataCrc32c) Optional.
DecryptRequest	setCiphertext(String ciphertext) Required.
DecryptRequest	setCiphertextCrc32c(Long ciphertextCrc32c) Optional.

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

DecryptRequest

public DecryptRequest()

Method Detail

getAdditionalAuthenticatedData

public String getAdditionalAuthenticatedData()

Optional. Optional data that must match the data originally supplied in EncryptRequest.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 EncryptRequest.additional_authenticated_data.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getAdditionalAuthenticatedData()

setAdditionalAuthenticatedData

public DecryptRequest setAdditionalAuthenticatedData(String additionalAuthenticatedData)

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

Parameters:

additionalAuthenticatedData - additionalAuthenticatedData or null for none

See Also:

#encodeAdditionalAuthenticatedData()

encodeAdditionalAuthenticatedData

public DecryptRequest encodeAdditionalAuthenticatedData(byte[] additionalAuthenticatedData)

Optional. Optional data that must match the data originally supplied in EncryptRequest.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 DecryptRequest.additional_authenticated_data. If specified, KeyManagementService will verify the integrity of the received DecryptRequest.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(DecryptRequest.additional_authenticated_data) is equal to DecryptRequest.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. NOTE: This field is in Beta.

Returns:

value or null for none

setAdditionalAuthenticatedDataCrc32c

public DecryptRequest setAdditionalAuthenticatedDataCrc32c(Long additionalAuthenticatedDataCrc32c)

Optional. An optional CRC32C checksum of the DecryptRequest.additional_authenticated_data. If specified, KeyManagementService will verify the integrity of the received DecryptRequest.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(DecryptRequest.additional_authenticated_data) is equal to DecryptRequest.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. NOTE: This field is in Beta.

Parameters:

additionalAuthenticatedDataCrc32c - additionalAuthenticatedDataCrc32c or null for none

getCiphertext

public String getCiphertext()

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

Returns:

value or null for none

See Also:

decodeCiphertext()

decodeCiphertext

public byte[] decodeCiphertext()

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

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getCiphertext()

setCiphertext

public DecryptRequest setCiphertext(String ciphertext)

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

Parameters:

ciphertext - ciphertext or null for none

See Also:

#encodeCiphertext()

encodeCiphertext

public DecryptRequest encodeCiphertext(byte[] ciphertext)

Required. The encrypted data originally returned in EncryptResponse.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 DecryptRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received DecryptRequest.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(DecryptRequest.ciphertext) is equal to DecryptRequest.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. NOTE: This field is in Beta.

Returns:

value or null for none

setCiphertextCrc32c

public DecryptRequest setCiphertextCrc32c(Long ciphertextCrc32c)

Optional. An optional CRC32C checksum of the DecryptRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received DecryptRequest.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(DecryptRequest.ciphertext) is equal to DecryptRequest.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. NOTE: This field is in Beta.

Parameters:

ciphertextCrc32c - ciphertextCrc32c or null for none

set

public DecryptRequest set(String fieldName,
                          Object value)

Overrides:

set in class GenericJson

clone

public DecryptRequest clone()

Overrides:

clone in class GenericJson