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

Class AsymmetricDecryptRequest

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class AsymmetricDecryptRequest
extends GenericJson

Request message for KeyManagementService.AsymmetricDecrypt.

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

Method Summary

Modifier and Type	Method and Description
AsymmetricDecryptRequest	clone()
byte[]	decodeCiphertext() Required.
AsymmetricDecryptRequest	encodeCiphertext(byte[] ciphertext) Required.
String	getCiphertext() Required.
Long	getCiphertextCrc32c() Optional.
AsymmetricDecryptRequest	set(String fieldName, Object value)
AsymmetricDecryptRequest	setCiphertext(String ciphertext) Required.
AsymmetricDecryptRequest	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

AsymmetricDecryptRequest

public AsymmetricDecryptRequest()

Method Detail

getCiphertext

public String getCiphertext()

Required. The data encrypted with the named CryptoKeyVersion's public key using OAEP.

Returns:

value or null for none

See Also:

decodeCiphertext()

decodeCiphertext

public byte[] decodeCiphertext()

Required. The data encrypted with the named CryptoKeyVersion's public key using OAEP.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getCiphertext()

setCiphertext

public AsymmetricDecryptRequest setCiphertext(String ciphertext)

Required. The data encrypted with the named CryptoKeyVersion's public key using OAEP.

Parameters:

ciphertext - ciphertext or null for none

See Also:

#encodeCiphertext()

encodeCiphertext

public AsymmetricDecryptRequest encodeCiphertext(byte[] ciphertext)

Required. The data encrypted with the named CryptoKeyVersion's public key using OAEP.

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 AsymmetricDecryptRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received AsymmetricDecryptRequest.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(AsymmetricDecryptRequest.ciphertext) is equal to AsymmetricDecryptRequest.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 AsymmetricDecryptRequest setCiphertextCrc32c(Long ciphertextCrc32c)

Optional. An optional CRC32C checksum of the AsymmetricDecryptRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received AsymmetricDecryptRequest.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(AsymmetricDecryptRequest.ciphertext) is equal to AsymmetricDecryptRequest.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 AsymmetricDecryptRequest set(String fieldName,
                                    Object value)

Overrides:

set in class GenericJson

clone

public AsymmetricDecryptRequest clone()

Overrides:

clone in class GenericJson