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

Class RawEncryptRequest

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

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

Method Summary

Modifier and Type	Method and Description
RawEncryptRequest	clone()
byte[]	decodeAdditionalAuthenticatedData() Optional.
byte[]	decodeInitializationVector() Optional.
byte[]	decodePlaintext() Required.
RawEncryptRequest	encodeAdditionalAuthenticatedData(byte[] additionalAuthenticatedData) Optional.
RawEncryptRequest	encodeInitializationVector(byte[] initializationVector) Optional.
RawEncryptRequest	encodePlaintext(byte[] plaintext) Required.
String	getAdditionalAuthenticatedData() Optional.
Long	getAdditionalAuthenticatedDataCrc32c() Optional.
String	getInitializationVector() Optional.
Long	getInitializationVectorCrc32c() Optional.
String	getPlaintext() Required.
Long	getPlaintextCrc32c() Optional.
RawEncryptRequest	set(String fieldName, Object value)
RawEncryptRequest	setAdditionalAuthenticatedData(String additionalAuthenticatedData) Optional.
RawEncryptRequest	setAdditionalAuthenticatedDataCrc32c(Long additionalAuthenticatedDataCrc32c) Optional.
RawEncryptRequest	setInitializationVector(String initializationVector) Optional.
RawEncryptRequest	setInitializationVectorCrc32c(Long initializationVectorCrc32c) Optional.
RawEncryptRequest	setPlaintext(String plaintext) Required.
RawEncryptRequest	setPlaintextCrc32c(Long plaintextCrc32c) 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

RawEncryptRequest

public RawEncryptRequest()

Method Detail

getAdditionalAuthenticatedData

public String getAdditionalAuthenticatedData()

Optional. Optional data that, if specified, must also be provided during decryption through RawDecryptRequest.additional_authenticated_data. This field may only be used in conjunction with an algorithm that accepts additional authenticated data (for example, AES-GCM). The maximum size depends on the key version's protection_level. For SOFTWARE keys, the plaintext must be no larger than 64KiB. For HSM keys, the combined length of the plaintext and additional_authenticated_data fields must be no larger than 8KiB.

Returns:

value or null for none

See Also:

decodeAdditionalAuthenticatedData()

decodeAdditionalAuthenticatedData

public byte[] decodeAdditionalAuthenticatedData()

Optional. Optional data that, if specified, must also be provided during decryption through RawDecryptRequest.additional_authenticated_data. This field may only be used in conjunction with an algorithm that accepts additional authenticated data (for example, AES-GCM). The maximum size depends on the key version's protection_level. For SOFTWARE keys, the plaintext must be no larger than 64KiB. For HSM keys, the combined length of the plaintext and additional_authenticated_data fields must be no larger than 8KiB.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getAdditionalAuthenticatedData()

setAdditionalAuthenticatedData

public RawEncryptRequest setAdditionalAuthenticatedData(String additionalAuthenticatedData)

Optional. Optional data that, if specified, must also be provided during decryption through RawDecryptRequest.additional_authenticated_data. This field may only be used in conjunction with an algorithm that accepts additional authenticated data (for example, AES-GCM). The maximum size depends on the key version's protection_level. For SOFTWARE keys, the plaintext must be no larger than 64KiB. For HSM keys, the combined length of the plaintext and additional_authenticated_data fields must be no larger than 8KiB.

Parameters:

additionalAuthenticatedData - additionalAuthenticatedData or null for none

See Also:

#encodeAdditionalAuthenticatedData()

encodeAdditionalAuthenticatedData

public RawEncryptRequest encodeAdditionalAuthenticatedData(byte[] additionalAuthenticatedData)

Optional. Optional data that, if specified, must also be provided during decryption through RawDecryptRequest.additional_authenticated_data. This field may only be used in conjunction with an algorithm that accepts additional authenticated data (for example, AES-GCM). The maximum size depends on the key version's protection_level. For SOFTWARE keys, the plaintext must be no larger than 64KiB. For HSM keys, the combined length of the plaintext and additional_authenticated_data fields must be no larger than 8KiB.

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 RawEncryptRequest.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 RawEncryptRequest setAdditionalAuthenticatedDataCrc32c(Long additionalAuthenticatedDataCrc32c)

Optional. An optional CRC32C checksum of the RawEncryptRequest.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

getInitializationVector

public String getInitializationVector()

Optional. A customer-supplied initialization vector that will be used for encryption. If it is not provided for AES-CBC and AES-CTR, one will be generated. It will be returned in RawEncryptResponse.initialization_vector.

Returns:

value or null for none

See Also:

decodeInitializationVector()

decodeInitializationVector

public byte[] decodeInitializationVector()

Optional. A customer-supplied initialization vector that will be used for encryption. If it is not provided for AES-CBC and AES-CTR, one will be generated. It will be returned in RawEncryptResponse.initialization_vector.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getInitializationVector()

setInitializationVector

public RawEncryptRequest setInitializationVector(String initializationVector)

Optional. A customer-supplied initialization vector that will be used for encryption. If it is not provided for AES-CBC and AES-CTR, one will be generated. It will be returned in RawEncryptResponse.initialization_vector.

Parameters:

initializationVector - initializationVector or null for none

See Also:

#encodeInitializationVector()

encodeInitializationVector

public RawEncryptRequest encodeInitializationVector(byte[] initializationVector)

Optional. A customer-supplied initialization vector that will be used for encryption. If it is not provided for AES-CBC and AES-CTR, one will be generated. It will be returned 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 RawEncryptRequest.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 RawEncryptRequest setInitializationVectorCrc32c(Long initializationVectorCrc32c)

Optional. An optional CRC32C checksum of the RawEncryptRequest.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

getPlaintext

public String getPlaintext()

Required. The data to encrypt. Must be no larger than 64KiB. The maximum size depends on the key version's protection_level. For SOFTWARE keys, the plaintext must be no larger than 64KiB. For HSM keys, the combined length of the plaintext and additional_authenticated_data fields must be no larger than 8KiB.

Returns:

value or null for none

See Also:

decodePlaintext()

decodePlaintext

public byte[] decodePlaintext()

Required. The data to encrypt. Must be no larger than 64KiB. The maximum size depends on the key version's protection_level. For SOFTWARE keys, the plaintext must be no larger than 64KiB. For HSM keys, the combined length of the plaintext and additional_authenticated_data fields must be no larger than 8KiB.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getPlaintext()

setPlaintext

public RawEncryptRequest setPlaintext(String plaintext)

Required. The data to encrypt. Must be no larger than 64KiB. The maximum size depends on the key version's protection_level. For SOFTWARE keys, the plaintext must be no larger than 64KiB. For HSM keys, the combined length of the plaintext and additional_authenticated_data fields must be no larger than 8KiB.

Parameters:

plaintext - plaintext or null for none

See Also:

#encodePlaintext()

encodePlaintext

public RawEncryptRequest encodePlaintext(byte[] plaintext)

Required. The data to encrypt. Must be no larger than 64KiB. The maximum size depends on the key version's protection_level. For SOFTWARE keys, the plaintext must be no larger than 64KiB. For HSM keys, the combined length of the plaintext and additional_authenticated_data fields must be no larger than 8KiB.

Since:

1.14

See Also:

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

getPlaintextCrc32c

public Long getPlaintextCrc32c()

Optional. An optional CRC32C checksum of the RawEncryptRequest.plaintext. If specified, KeyManagementService will verify the integrity of the received plaintext 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(plaintext) is equal to plaintext_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

setPlaintextCrc32c

public RawEncryptRequest setPlaintextCrc32c(Long plaintextCrc32c)

Optional. An optional CRC32C checksum of the RawEncryptRequest.plaintext. If specified, KeyManagementService will verify the integrity of the received plaintext 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(plaintext) is equal to plaintext_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:

plaintextCrc32c - plaintextCrc32c or null for none

set

public RawEncryptRequest set(String fieldName,
                             Object value)

Overrides:

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

clone

public RawEncryptRequest clone()

Overrides:

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