Package com.google.cloud.kms.v1

Class RawDecryptRequest

  • All Implemented Interfaces:
    RawDecryptRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class RawDecryptRequest
extends com.google.protobuf.GeneratedMessageV3
implements RawDecryptRequestOrBuilder
     Request message for
 [KeyManagementService.RawDecrypt][google.cloud.kms.v1.KeyManagementService.RawDecrypt].
    Protobuf type google.cloud.kms.v1.RawDecryptRequest
    See Also:
    Serialized Form

    • Field Detail

      • CIPHERTEXT_FIELD_NUMBER

        public static final int CIPHERTEXT_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

      • INITIALIZATION_VECTOR_FIELD_NUMBER

        public static final int INITIALIZATION_VECTOR_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TAG_LENGTH_FIELD_NUMBER

        public static final int TAG_LENGTH_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CIPHERTEXT_CRC32C_FIELD_NUMBER

        public static final int CIPHERTEXT_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

      • INITIALIZATION_VECTOR_CRC32C_FIELD_NUMBER

        public static final int INITIALIZATION_VECTOR_CRC32C_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Required. The resource name of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to use for
 decryption.
        string name = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getName in interface RawDecryptRequestOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Required. The resource name of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to use for
 decryption.
        string name = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getNameBytes in interface RawDecryptRequestOrBuilder
        Returns:
        The bytes for name.

      • getCiphertext

        public com.google.protobuf.ByteString getCiphertext()
         Required. The encrypted data originally returned in
 [RawEncryptResponse.ciphertext][google.cloud.kms.v1.RawEncryptResponse.ciphertext].
        bytes ciphertext = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getCiphertext in interface RawDecryptRequestOrBuilder
        Returns:
        The ciphertext.

      • getAdditionalAuthenticatedData

        public com.google.protobuf.ByteString getAdditionalAuthenticatedData()
         Optional. Optional data that must match the data originally supplied in
 [RawEncryptRequest.additional_authenticated_data][google.cloud.kms.v1.RawEncryptRequest.additional_authenticated_data].
        bytes additional_authenticated_data = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAdditionalAuthenticatedData in interface RawDecryptRequestOrBuilder
        Returns:
        The additionalAuthenticatedData.

      • getInitializationVector

        public com.google.protobuf.ByteString getInitializationVector()
         Required. The initialization vector (IV) used during encryption, which must
 match the data originally provided in
 [RawEncryptResponse.initialization_vector][google.cloud.kms.v1.RawEncryptResponse.initialization_vector].
        bytes initialization_vector = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getInitializationVector in interface RawDecryptRequestOrBuilder
        Returns:
        The initializationVector.

      • getTagLength

        public int getTagLength()
         The length of the authentication tag that is appended to the end of
 the ciphertext. If unspecified (0), the default value for the key's
 algorithm will be used (for AES-GCM, the default value is 16).
        int32 tag_length = 5;
        Specified by:
        getTagLength in interface RawDecryptRequestOrBuilder
        Returns:
        The tagLength.

      • hasCiphertextCrc32C

        public boolean hasCiphertextCrc32C()
         Optional. An optional CRC32C checksum of the
 [RawDecryptRequest.ciphertext][google.cloud.kms.v1.RawDecryptRequest.ciphertext].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received ciphertext 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(ciphertext) is equal
 to 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.
        .google.protobuf.Int64Value ciphertext_crc32c = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasCiphertextCrc32C in interface RawDecryptRequestOrBuilder
        Returns:
        Whether the ciphertextCrc32c field is set.

      • getCiphertextCrc32C

        public com.google.protobuf.Int64Value getCiphertextCrc32C()
         Optional. An optional CRC32C checksum of the
 [RawDecryptRequest.ciphertext][google.cloud.kms.v1.RawDecryptRequest.ciphertext].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received ciphertext 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(ciphertext) is equal
 to 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.
        .google.protobuf.Int64Value ciphertext_crc32c = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getCiphertextCrc32C in interface RawDecryptRequestOrBuilder
        Returns:
        The ciphertextCrc32c.

      • getCiphertextCrc32COrBuilder

        public com.google.protobuf.Int64ValueOrBuilder getCiphertextCrc32COrBuilder()
         Optional. An optional CRC32C checksum of the
 [RawDecryptRequest.ciphertext][google.cloud.kms.v1.RawDecryptRequest.ciphertext].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received ciphertext 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(ciphertext) is equal
 to 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.
        .google.protobuf.Int64Value ciphertext_crc32c = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getCiphertextCrc32COrBuilder in interface RawDecryptRequestOrBuilder

      • hasAdditionalAuthenticatedDataCrc32C

        public boolean hasAdditionalAuthenticatedDataCrc32C()
         Optional. An optional CRC32C checksum of the
 [RawDecryptRequest.additional_authenticated_data][google.cloud.kms.v1.RawDecryptRequest.additional_authenticated_data].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received 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(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.
        .google.protobuf.Int64Value additional_authenticated_data_crc32c = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasAdditionalAuthenticatedDataCrc32C in interface RawDecryptRequestOrBuilder
        Returns:
        Whether the additionalAuthenticatedDataCrc32c field is set.

      • getAdditionalAuthenticatedDataCrc32C

        public com.google.protobuf.Int64Value getAdditionalAuthenticatedDataCrc32C()
         Optional. An optional CRC32C checksum of the
 [RawDecryptRequest.additional_authenticated_data][google.cloud.kms.v1.RawDecryptRequest.additional_authenticated_data].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received 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(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.
        .google.protobuf.Int64Value additional_authenticated_data_crc32c = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAdditionalAuthenticatedDataCrc32C in interface RawDecryptRequestOrBuilder
        Returns:
        The additionalAuthenticatedDataCrc32c.

      • getAdditionalAuthenticatedDataCrc32COrBuilder

        public com.google.protobuf.Int64ValueOrBuilder getAdditionalAuthenticatedDataCrc32COrBuilder()
         Optional. An optional CRC32C checksum of the
 [RawDecryptRequest.additional_authenticated_data][google.cloud.kms.v1.RawDecryptRequest.additional_authenticated_data].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received 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(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.
        .google.protobuf.Int64Value additional_authenticated_data_crc32c = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAdditionalAuthenticatedDataCrc32COrBuilder in interface RawDecryptRequestOrBuilder

      • hasInitializationVectorCrc32C

        public boolean hasInitializationVectorCrc32C()
         Optional. An optional CRC32C checksum of the
 [RawDecryptRequest.initialization_vector][google.cloud.kms.v1.RawDecryptRequest.initialization_vector].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received initialization_vector 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(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.
        .google.protobuf.Int64Value initialization_vector_crc32c = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasInitializationVectorCrc32C in interface RawDecryptRequestOrBuilder
        Returns:
        Whether the initializationVectorCrc32c field is set.

      • getInitializationVectorCrc32C

        public com.google.protobuf.Int64Value getInitializationVectorCrc32C()
         Optional. An optional CRC32C checksum of the
 [RawDecryptRequest.initialization_vector][google.cloud.kms.v1.RawDecryptRequest.initialization_vector].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received initialization_vector 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(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.
        .google.protobuf.Int64Value initialization_vector_crc32c = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getInitializationVectorCrc32C in interface RawDecryptRequestOrBuilder
        Returns:
        The initializationVectorCrc32c.

      • getInitializationVectorCrc32COrBuilder

        public com.google.protobuf.Int64ValueOrBuilder getInitializationVectorCrc32COrBuilder()
         Optional. An optional CRC32C checksum of the
 [RawDecryptRequest.initialization_vector][google.cloud.kms.v1.RawDecryptRequest.initialization_vector].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received initialization_vector 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(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.
        .google.protobuf.Int64Value initialization_vector_crc32c = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getInitializationVectorCrc32COrBuilder in interface RawDecryptRequestOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static RawDecryptRequest parseFrom​(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RawDecryptRequest parseFrom​(ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RawDecryptRequest parseFrom​(com.google.protobuf.ByteString data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RawDecryptRequest parseFrom​(com.google.protobuf.ByteString data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RawDecryptRequest parseFrom​(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RawDecryptRequest parseFrom​(byte[] data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RawDecryptRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
        Throws:
        IOException

      • newBuilderForType

        public RawDecryptRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public RawDecryptRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected RawDecryptRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<RawDecryptRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public RawDecryptRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder