com.google.cloud.kms.v1

Class EncryptRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.kms.v1.EncryptRequest

All Implemented Interfaces:

EncryptRequestOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

public final class EncryptRequest
extends GeneratedMessageV3
implements EncryptRequestOrBuilder

 Request message for
 [KeyManagementService.Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt].
 

Protobuf type google.cloud.kms.v1.EncryptRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EncryptRequest.Builder Request message for [KeyManagementService.Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt].

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADDITIONAL_AUTHENTICATED_DATA_CRC32C_FIELD_NUMBER
static int	ADDITIONAL_AUTHENTICATED_DATA_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	PLAINTEXT_CRC32C_FIELD_NUMBER
static int	PLAINTEXT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
ByteString	getAdditionalAuthenticatedData() Optional.
Int64Value	getAdditionalAuthenticatedDataCrc32C() Optional.
Int64ValueOrBuilder	getAdditionalAuthenticatedDataCrc32COrBuilder() Optional.
static EncryptRequest	getDefaultInstance()
EncryptRequest	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
String	getName() Required.
ByteString	getNameBytes() Required.
Parser<EncryptRequest>	getParserForType()
ByteString	getPlaintext() Required.
Int64Value	getPlaintextCrc32C() Optional.
Int64ValueOrBuilder	getPlaintextCrc32COrBuilder() Optional.
int	getSerializedSize()
UnknownFieldSet	getUnknownFields()
boolean	hasAdditionalAuthenticatedDataCrc32C() Optional.
int	hashCode()
boolean	hasPlaintextCrc32C() Optional.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static EncryptRequest.Builder	newBuilder()
static EncryptRequest.Builder	newBuilder(EncryptRequest prototype)
EncryptRequest.Builder	newBuilderForType()
protected EncryptRequest.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static EncryptRequest	parseDelimitedFrom(InputStream input)
static EncryptRequest	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static EncryptRequest	parseFrom(byte[] data)
static EncryptRequest	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static EncryptRequest	parseFrom(ByteBuffer data)
static EncryptRequest	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static EncryptRequest	parseFrom(ByteString data)
static EncryptRequest	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static EncryptRequest	parseFrom(CodedInputStream input)
static EncryptRequest	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static EncryptRequest	parseFrom(InputStream input)
static EncryptRequest	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<EncryptRequest>	parser()
EncryptRequest.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

PLAINTEXT_FIELD_NUMBER

public static final int PLAINTEXT_FIELD_NUMBER

See Also:

Constant Field Values

ADDITIONAL_AUTHENTICATED_DATA_FIELD_NUMBER

public static final int ADDITIONAL_AUTHENTICATED_DATA_FIELD_NUMBER

See Also:

Constant Field Values

PLAINTEXT_CRC32C_FIELD_NUMBER

public static final int PLAINTEXT_CRC32C_FIELD_NUMBER

See Also:

Constant Field Values

ADDITIONAL_AUTHENTICATED_DATA_CRC32C_FIELD_NUMBER

public static final int ADDITIONAL_AUTHENTICATED_DATA_CRC32C_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getName

public String getName()

 Required. The resource name of the
 [CryptoKey][google.cloud.kms.v1.CryptoKey] or
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to use for
 encryption.
 If a [CryptoKey][google.cloud.kms.v1.CryptoKey] is specified, the server
 will use its [primary version][google.cloud.kms.v1.CryptoKey.primary].
 

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getName in interface EncryptRequestOrBuilder

Returns:

The name.

getNameBytes

public ByteString getNameBytes()

 Required. The resource name of the
 [CryptoKey][google.cloud.kms.v1.CryptoKey] or
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to use for
 encryption.
 If a [CryptoKey][google.cloud.kms.v1.CryptoKey] is specified, the server
 will use its [primary version][google.cloud.kms.v1.CryptoKey.primary].
 

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getNameBytes in interface EncryptRequestOrBuilder

Returns:

The bytes for name.

getPlaintext

public ByteString getPlaintext()

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

bytes plaintext = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getPlaintext in interface EncryptRequestOrBuilder

Returns:

The plaintext.

getAdditionalAuthenticatedData

public ByteString getAdditionalAuthenticatedData()

 Optional. Optional data that, if specified, must also be provided during
 decryption through
 [DecryptRequest.additional_authenticated_data][google.cloud.kms.v1.DecryptRequest.additional_authenticated_data].
 The maximum size depends on the key version's
 [protection_level][google.cloud.kms.v1.CryptoKeyVersionTemplate.protection_level].
 For [SOFTWARE][google.cloud.kms.v1.ProtectionLevel.SOFTWARE] keys, the AAD
 must be no larger than 64KiB. For
 [HSM][google.cloud.kms.v1.ProtectionLevel.HSM] keys, the combined length of
 the plaintext and additional_authenticated_data fields must be no larger
 than 8KiB.
 

bytes additional_authenticated_data = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getAdditionalAuthenticatedData in interface EncryptRequestOrBuilder

Returns:

The additionalAuthenticatedData.

hasPlaintextCrc32C

public boolean hasPlaintextCrc32C()

 Optional. An optional CRC32C checksum of the
 [EncryptRequest.plaintext][google.cloud.kms.v1.EncryptRequest.plaintext].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received
 [EncryptRequest.plaintext][google.cloud.kms.v1.EncryptRequest.plaintext]
 using this checksum.
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 report an error if the checksum verification fails. If you receive a
 checksum error, your client should verify that
 CRC32C([EncryptRequest.plaintext][google.cloud.kms.v1.EncryptRequest.plaintext])
 is equal to
 [EncryptRequest.plaintext_crc32c][google.cloud.kms.v1.EncryptRequest.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.
 

.google.protobuf.Int64Value plaintext_crc32c = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasPlaintextCrc32C in interface EncryptRequestOrBuilder

Returns:

Whether the plaintextCrc32c field is set.

getPlaintextCrc32C

public Int64Value getPlaintextCrc32C()

 Optional. An optional CRC32C checksum of the
 [EncryptRequest.plaintext][google.cloud.kms.v1.EncryptRequest.plaintext].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received
 [EncryptRequest.plaintext][google.cloud.kms.v1.EncryptRequest.plaintext]
 using this checksum.
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 report an error if the checksum verification fails. If you receive a
 checksum error, your client should verify that
 CRC32C([EncryptRequest.plaintext][google.cloud.kms.v1.EncryptRequest.plaintext])
 is equal to
 [EncryptRequest.plaintext_crc32c][google.cloud.kms.v1.EncryptRequest.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.
 

.google.protobuf.Int64Value plaintext_crc32c = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getPlaintextCrc32C in interface EncryptRequestOrBuilder

Returns:

The plaintextCrc32c.

getPlaintextCrc32COrBuilder

public Int64ValueOrBuilder getPlaintextCrc32COrBuilder()

 Optional. An optional CRC32C checksum of the
 [EncryptRequest.plaintext][google.cloud.kms.v1.EncryptRequest.plaintext].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received
 [EncryptRequest.plaintext][google.cloud.kms.v1.EncryptRequest.plaintext]
 using this checksum.
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 report an error if the checksum verification fails. If you receive a
 checksum error, your client should verify that
 CRC32C([EncryptRequest.plaintext][google.cloud.kms.v1.EncryptRequest.plaintext])
 is equal to
 [EncryptRequest.plaintext_crc32c][google.cloud.kms.v1.EncryptRequest.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.
 

.google.protobuf.Int64Value plaintext_crc32c = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getPlaintextCrc32COrBuilder in interface EncryptRequestOrBuilder

hasAdditionalAuthenticatedDataCrc32C

public boolean hasAdditionalAuthenticatedDataCrc32C()

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

.google.protobuf.Int64Value additional_authenticated_data_crc32c = 8 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasAdditionalAuthenticatedDataCrc32C in interface EncryptRequestOrBuilder

Returns:

Whether the additionalAuthenticatedDataCrc32c field is set.

getAdditionalAuthenticatedDataCrc32C

public Int64Value getAdditionalAuthenticatedDataCrc32C()

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

.google.protobuf.Int64Value additional_authenticated_data_crc32c = 8 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getAdditionalAuthenticatedDataCrc32C in interface EncryptRequestOrBuilder

Returns:

The additionalAuthenticatedDataCrc32c.

getAdditionalAuthenticatedDataCrc32COrBuilder

public Int64ValueOrBuilder getAdditionalAuthenticatedDataCrc32COrBuilder()

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

.google.protobuf.Int64Value additional_authenticated_data_crc32c = 8 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getAdditionalAuthenticatedDataCrc32COrBuilder in interface EncryptRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static EncryptRequest parseFrom(ByteBuffer data)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static EncryptRequest parseFrom(ByteBuffer data,
                                       ExtensionRegistryLite extensionRegistry)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static EncryptRequest parseFrom(ByteString data)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static EncryptRequest parseFrom(ByteString data,
                                       ExtensionRegistryLite extensionRegistry)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static EncryptRequest parseFrom(byte[] data)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static EncryptRequest parseFrom(byte[] data,
                                       ExtensionRegistryLite extensionRegistry)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static EncryptRequest parseFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static EncryptRequest parseFrom(InputStream input,
                                       ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static EncryptRequest parseDelimitedFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static EncryptRequest parseDelimitedFrom(InputStream input,
                                                ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseFrom

public static EncryptRequest parseFrom(CodedInputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static EncryptRequest parseFrom(CodedInputStream input,
                                       ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

newBuilderForType

public EncryptRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static EncryptRequest.Builder newBuilder()

newBuilder

public static EncryptRequest.Builder newBuilder(EncryptRequest prototype)

toBuilder

public EncryptRequest.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected EncryptRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static EncryptRequest getDefaultInstance()

parser

public static Parser<EncryptRequest> parser()

getParserForType

public Parser<EncryptRequest> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public EncryptRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder