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

Class EncryptRequest

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

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

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

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

Request message for KeyManagementService.Encrypt.

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 Google 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

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
EncryptRequest()

Method Summary

Methods

Modifier and Type	Method and Description
EncryptRequest	clone()
byte[]	decodeAdditionalAuthenticatedData() Optional data that, if specified, must also be provided during decryption through DecryptRequest.additional_authenticated_data.
byte[]	decodePlaintext() Required.
EncryptRequest	encodeAdditionalAuthenticatedData(byte[] additionalAuthenticatedData) Optional data that, if specified, must also be provided during decryption through DecryptRequest.additional_authenticated_data.
EncryptRequest	encodePlaintext(byte[] plaintext) Required.
java.lang.String	getAdditionalAuthenticatedData() Optional data that, if specified, must also be provided during decryption through DecryptRequest.additional_authenticated_data.
java.lang.String	getPlaintext() Required.
EncryptRequest	set(java.lang.String fieldName, java.lang.Object value)
EncryptRequest	setAdditionalAuthenticatedData(java.lang.String additionalAuthenticatedData) Optional data that, if specified, must also be provided during decryption through DecryptRequest.additional_authenticated_data.
EncryptRequest	setPlaintext(java.lang.String plaintext) Required.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EncryptRequest

public EncryptRequest()

Method Detail

getAdditionalAuthenticatedData

public java.lang.String getAdditionalAuthenticatedData()

Optional data that, if specified, must also be provided during decryption through DecryptRequest.additional_authenticated_data. Must be no larger than 64KiB.

Returns:

value or null for none

See Also:

decodeAdditionalAuthenticatedData()

decodeAdditionalAuthenticatedData

public byte[] decodeAdditionalAuthenticatedData()

Optional data that, if specified, must also be provided during decryption through DecryptRequest.additional_authenticated_data. Must be no larger than 64KiB.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getAdditionalAuthenticatedData()

setAdditionalAuthenticatedData

public EncryptRequest setAdditionalAuthenticatedData(java.lang.String additionalAuthenticatedData)

Optional data that, if specified, must also be provided during decryption through DecryptRequest.additional_authenticated_data. Must be no larger than 64KiB.

Parameters:

additionalAuthenticatedData - additionalAuthenticatedData or null for none

See Also:

#encodeAdditionalAuthenticatedData()

encodeAdditionalAuthenticatedData

public EncryptRequest encodeAdditionalAuthenticatedData(byte[] additionalAuthenticatedData)

Optional data that, if specified, must also be provided during decryption through DecryptRequest.additional_authenticated_data. Must be no larger than 64KiB.

Since:

1.14

See Also:

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

getPlaintext

public java.lang.String getPlaintext()

Required. The data to encrypt. Must be no larger than 64KiB.

Returns:

value or null for none

See Also:

decodePlaintext()

decodePlaintext

public byte[] decodePlaintext()

Required. The data to encrypt. Must be no larger than 64KiB.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getPlaintext()

setPlaintext

public EncryptRequest setPlaintext(java.lang.String plaintext)

Required. The data to encrypt. Must be no larger than 64KiB.

Parameters:

plaintext - plaintext or null for none

See Also:

#encodePlaintext()

encodePlaintext

public EncryptRequest encodePlaintext(byte[] plaintext)

Required. The data to encrypt. Must be no larger than 64KiB.

Since:

1.14

See Also:

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

set

public EncryptRequest set(java.lang.String fieldName,
                 java.lang.Object value)

Overrides:

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

clone

public EncryptRequest clone()

Overrides:

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