com.google.cloud.kms.v1

Class EncryptResponse

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.kms.v1.EncryptResponse

All Implemented Interfaces:

EncryptResponseOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

public final class EncryptResponse
extends GeneratedMessageV3
implements EncryptResponseOrBuilder

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

Protobuf type google.cloud.kms.v1.EncryptResponse

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EncryptResponse.Builder Response 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	CIPHERTEXT_CRC32C_FIELD_NUMBER
static int	CIPHERTEXT_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	PROTECTION_LEVEL_FIELD_NUMBER
static int	VERIFIED_ADDITIONAL_AUTHENTICATED_DATA_CRC32C_FIELD_NUMBER
static int	VERIFIED_PLAINTEXT_CRC32C_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	getCiphertext() The encrypted data.
Int64Value	getCiphertextCrc32C() Integrity verification field.
Int64ValueOrBuilder	getCiphertextCrc32COrBuilder() Integrity verification field.
static EncryptResponse	getDefaultInstance()
EncryptResponse	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
String	getName() The resource name of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in encryption.
ByteString	getNameBytes() The resource name of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in encryption.
Parser<EncryptResponse>	getParserForType()
ProtectionLevel	getProtectionLevel() The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in encryption.
int	getProtectionLevelValue() The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in encryption.
int	getSerializedSize()
UnknownFieldSet	getUnknownFields()
boolean	getVerifiedAdditionalAuthenticatedDataCrc32C() Integrity verification field.
boolean	getVerifiedPlaintextCrc32C() Integrity verification field.
boolean	hasCiphertextCrc32C() Integrity verification field.
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static EncryptResponse.Builder	newBuilder()
static EncryptResponse.Builder	newBuilder(EncryptResponse prototype)
EncryptResponse.Builder	newBuilderForType()
protected EncryptResponse.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static EncryptResponse	parseDelimitedFrom(InputStream input)
static EncryptResponse	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static EncryptResponse	parseFrom(byte[] data)
static EncryptResponse	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static EncryptResponse	parseFrom(ByteBuffer data)
static EncryptResponse	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static EncryptResponse	parseFrom(ByteString data)
static EncryptResponse	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static EncryptResponse	parseFrom(CodedInputStream input)
static EncryptResponse	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static EncryptResponse	parseFrom(InputStream input)
static EncryptResponse	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<EncryptResponse>	parser()
EncryptResponse.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

CIPHERTEXT_FIELD_NUMBER

public static final int CIPHERTEXT_FIELD_NUMBER

See Also:

Constant Field Values

CIPHERTEXT_CRC32C_FIELD_NUMBER

public static final int CIPHERTEXT_CRC32C_FIELD_NUMBER

See Also:

Constant Field Values

VERIFIED_PLAINTEXT_CRC32C_FIELD_NUMBER

public static final int VERIFIED_PLAINTEXT_CRC32C_FIELD_NUMBER

See Also:

Constant Field Values

VERIFIED_ADDITIONAL_AUTHENTICATED_DATA_CRC32C_FIELD_NUMBER

public static final int VERIFIED_ADDITIONAL_AUTHENTICATED_DATA_CRC32C_FIELD_NUMBER

See Also:

Constant Field Values

PROTECTION_LEVEL_FIELD_NUMBER

public static final int PROTECTION_LEVEL_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()

 The resource name of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in
 encryption. Check this field to verify that the intended resource was used
 for encryption.
 

string name = 1;

Specified by:

getName in interface EncryptResponseOrBuilder

Returns:

The name.

getNameBytes

public ByteString getNameBytes()

 The resource name of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in
 encryption. Check this field to verify that the intended resource was used
 for encryption.
 

string name = 1;

Specified by:

getNameBytes in interface EncryptResponseOrBuilder

Returns:

The bytes for name.

getCiphertext

public ByteString getCiphertext()

 The encrypted data.
 

bytes ciphertext = 2;

Specified by:

getCiphertext in interface EncryptResponseOrBuilder

Returns:

The ciphertext.

hasCiphertextCrc32C

public boolean hasCiphertextCrc32C()

 Integrity verification field. A CRC32C checksum of the returned
 [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext].
 An integrity check of
 [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext]
 can be performed by computing the CRC32C checksum of
 [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext]
 and comparing your results to this field. Discard the response in case of
 non-matching checksum values, and 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 ciphertext_crc32c = 4;

Specified by:

hasCiphertextCrc32C in interface EncryptResponseOrBuilder

Returns:

Whether the ciphertextCrc32c field is set.

getCiphertextCrc32C

public Int64Value getCiphertextCrc32C()

 Integrity verification field. A CRC32C checksum of the returned
 [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext].
 An integrity check of
 [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext]
 can be performed by computing the CRC32C checksum of
 [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext]
 and comparing your results to this field. Discard the response in case of
 non-matching checksum values, and 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 ciphertext_crc32c = 4;

Specified by:

getCiphertextCrc32C in interface EncryptResponseOrBuilder

Returns:

The ciphertextCrc32c.

getCiphertextCrc32COrBuilder

public Int64ValueOrBuilder getCiphertextCrc32COrBuilder()

 Integrity verification field. A CRC32C checksum of the returned
 [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext].
 An integrity check of
 [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext]
 can be performed by computing the CRC32C checksum of
 [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext]
 and comparing your results to this field. Discard the response in case of
 non-matching checksum values, and 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 ciphertext_crc32c = 4;

Specified by:

getCiphertextCrc32COrBuilder in interface EncryptResponseOrBuilder

getVerifiedPlaintextCrc32C

public boolean getVerifiedPlaintextCrc32C()

 Integrity verification field. A flag indicating whether
 [EncryptRequest.plaintext_crc32c][google.cloud.kms.v1.EncryptRequest.plaintext_crc32c]
 was received by
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used
 for the integrity verification of the
 [plaintext][google.cloud.kms.v1.EncryptRequest.plaintext]. A false value of
 this field indicates either that
 [EncryptRequest.plaintext_crc32c][google.cloud.kms.v1.EncryptRequest.plaintext_crc32c]
 was left unset or that it was not delivered to
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've
 set
 [EncryptRequest.plaintext_crc32c][google.cloud.kms.v1.EncryptRequest.plaintext_crc32c]
 but this field is still false, discard the response and perform a limited
 number of retries.
 

bool verified_plaintext_crc32c = 5;

Specified by:

getVerifiedPlaintextCrc32C in interface EncryptResponseOrBuilder

Returns:

The verifiedPlaintextCrc32c.

getVerifiedAdditionalAuthenticatedDataCrc32C

public boolean getVerifiedAdditionalAuthenticatedDataCrc32C()

 Integrity verification field. A flag indicating whether
 [EncryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data_crc32c]
 was received by
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used
 for the integrity verification of the
 [AAD][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data]. A
 false value of this field indicates either that
 [EncryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data_crc32c]
 was left unset or that it was not delivered to
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've
 set
 [EncryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data_crc32c]
 but this field is still false, discard the response and perform a limited
 number of retries.
 

bool verified_additional_authenticated_data_crc32c = 6;

Specified by:

getVerifiedAdditionalAuthenticatedDataCrc32C in interface EncryptResponseOrBuilder

Returns:

The verifiedAdditionalAuthenticatedDataCrc32c.

getProtectionLevelValue

public int getProtectionLevelValue()

 The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in
 encryption.
 

.google.cloud.kms.v1.ProtectionLevel protection_level = 7;

Specified by:

getProtectionLevelValue in interface EncryptResponseOrBuilder

Returns:

The enum numeric value on the wire for protectionLevel.

getProtectionLevel

public ProtectionLevel getProtectionLevel()

 The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in
 encryption.
 

.google.cloud.kms.v1.ProtectionLevel protection_level = 7;

Specified by:

getProtectionLevel in interface EncryptResponseOrBuilder

Returns:

The protectionLevel.

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 EncryptResponse parseFrom(ByteBuffer data)
                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

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

Throws:

InvalidProtocolBufferException

parseFrom

public static EncryptResponse parseFrom(ByteString data)
                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

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

Throws:

InvalidProtocolBufferException

parseFrom

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

Throws:

InvalidProtocolBufferException

parseFrom

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

Throws:

InvalidProtocolBufferException

parseFrom

public static EncryptResponse parseFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static EncryptResponse parseDelimitedFrom(InputStream input)
                                          throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static EncryptResponse parseFrom(CodedInputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public EncryptResponse.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static EncryptResponse.Builder newBuilder()

newBuilder

public static EncryptResponse.Builder newBuilder(EncryptResponse prototype)

toBuilder

public EncryptResponse.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected EncryptResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static EncryptResponse getDefaultInstance()

parser

public static Parser<EncryptResponse> parser()

getParserForType

public Parser<EncryptResponse> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public EncryptResponse getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder