Package com.google.cloud.kms.v1

Class RawEncryptRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.kms.v1.RawEncryptRequest
All Implemented Interfaces:
RawEncryptRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class RawEncryptRequest extends com.google.protobuf.GeneratedMessage implements RawEncryptRequestOrBuilder
 Request message for
 [KeyManagementService.RawEncrypt][google.cloud.kms.v1.KeyManagementService.RawEncrypt].
Protobuf type google.cloud.kms.v1.RawEncryptRequest
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • PLAINTEXT_FIELD_NUMBER

      public static final int PLAINTEXT_FIELD_NUMBER
      See Also:

    • ADDITIONAL_AUTHENTICATED_DATA_FIELD_NUMBER

      public static final int ADDITIONAL_AUTHENTICATED_DATA_FIELD_NUMBER
      See Also:

    • PLAINTEXT_CRC32C_FIELD_NUMBER

      public static final int PLAINTEXT_CRC32C_FIELD_NUMBER
      See Also:

    • ADDITIONAL_AUTHENTICATED_DATA_CRC32C_FIELD_NUMBER

      public static final int ADDITIONAL_AUTHENTICATED_DATA_CRC32C_FIELD_NUMBER
      See Also:

    • INITIALIZATION_VECTOR_FIELD_NUMBER

      public static final int INITIALIZATION_VECTOR_FIELD_NUMBER
      See Also:

    • INITIALIZATION_VECTOR_CRC32C_FIELD_NUMBER

      public static final int INITIALIZATION_VECTOR_CRC32C_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getName

      public String getName()
       Required. The resource name of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to use for
 encryption.
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getName in interface RawEncryptRequestOrBuilder
      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
 encryption.
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getNameBytes in interface RawEncryptRequestOrBuilder
      Returns:
      The bytes for name.

    • getPlaintext

      public com.google.protobuf.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 RawEncryptRequestOrBuilder
      Returns:
      The plaintext.

    • getAdditionalAuthenticatedData

      public com.google.protobuf.ByteString getAdditionalAuthenticatedData()
       Optional. Optional data that, if specified, must also be provided during
 decryption through
 [RawDecryptRequest.additional_authenticated_data][google.cloud.kms.v1.RawDecryptRequest.additional_authenticated_data].

 This field may only be used in conjunction with an
 [algorithm][google.cloud.kms.v1.CryptoKeyVersion.algorithm] that accepts
 additional authenticated data (for example, AES-GCM).

 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 additional_authenticated_data = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAdditionalAuthenticatedData in interface RawEncryptRequestOrBuilder
      Returns:
      The additionalAuthenticatedData.

    • hasPlaintextCrc32C

      public boolean hasPlaintextCrc32C()
       Optional. An optional CRC32C checksum of the
 [RawEncryptRequest.plaintext][google.cloud.kms.v1.RawEncryptRequest.plaintext].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received 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(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.
      .google.protobuf.Int64Value plaintext_crc32c = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasPlaintextCrc32C in interface RawEncryptRequestOrBuilder
      Returns:
      Whether the plaintextCrc32c field is set.

    • getPlaintextCrc32C

      public com.google.protobuf.Int64Value getPlaintextCrc32C()
       Optional. An optional CRC32C checksum of the
 [RawEncryptRequest.plaintext][google.cloud.kms.v1.RawEncryptRequest.plaintext].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received 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(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.
      .google.protobuf.Int64Value plaintext_crc32c = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPlaintextCrc32C in interface RawEncryptRequestOrBuilder
      Returns:
      The plaintextCrc32c.

    • getPlaintextCrc32COrBuilder

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

    • hasAdditionalAuthenticatedDataCrc32C

      public boolean hasAdditionalAuthenticatedDataCrc32C()
       Optional. An optional CRC32C checksum of the
 [RawEncryptRequest.additional_authenticated_data][google.cloud.kms.v1.RawEncryptRequest.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 = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasAdditionalAuthenticatedDataCrc32C in interface RawEncryptRequestOrBuilder
      Returns:
      Whether the additionalAuthenticatedDataCrc32c field is set.

    • getAdditionalAuthenticatedDataCrc32C

      public com.google.protobuf.Int64Value getAdditionalAuthenticatedDataCrc32C()
       Optional. An optional CRC32C checksum of the
 [RawEncryptRequest.additional_authenticated_data][google.cloud.kms.v1.RawEncryptRequest.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 = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAdditionalAuthenticatedDataCrc32C in interface RawEncryptRequestOrBuilder
      Returns:
      The additionalAuthenticatedDataCrc32c.

    • getAdditionalAuthenticatedDataCrc32COrBuilder

      public com.google.protobuf.Int64ValueOrBuilder getAdditionalAuthenticatedDataCrc32COrBuilder()
       Optional. An optional CRC32C checksum of the
 [RawEncryptRequest.additional_authenticated_data][google.cloud.kms.v1.RawEncryptRequest.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 = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAdditionalAuthenticatedDataCrc32COrBuilder in interface RawEncryptRequestOrBuilder

    • getInitializationVector

      public com.google.protobuf.ByteString 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][google.cloud.kms.v1.RawEncryptResponse.initialization_vector].
      bytes initialization_vector = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getInitializationVector in interface RawEncryptRequestOrBuilder
      Returns:
      The initializationVector.

    • hasInitializationVectorCrc32C

      public boolean hasInitializationVectorCrc32C()
       Optional. An optional CRC32C checksum of the
 [RawEncryptRequest.initialization_vector][google.cloud.kms.v1.RawEncryptRequest.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 = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasInitializationVectorCrc32C in interface RawEncryptRequestOrBuilder
      Returns:
      Whether the initializationVectorCrc32c field is set.

    • getInitializationVectorCrc32C

      public com.google.protobuf.Int64Value getInitializationVectorCrc32C()
       Optional. An optional CRC32C checksum of the
 [RawEncryptRequest.initialization_vector][google.cloud.kms.v1.RawEncryptRequest.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 = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getInitializationVectorCrc32C in interface RawEncryptRequestOrBuilder
      Returns:
      The initializationVectorCrc32c.

    • getInitializationVectorCrc32COrBuilder

      public com.google.protobuf.Int64ValueOrBuilder getInitializationVectorCrc32COrBuilder()
       Optional. An optional CRC32C checksum of the
 [RawEncryptRequest.initialization_vector][google.cloud.kms.v1.RawEncryptRequest.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 = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getInitializationVectorCrc32COrBuilder in interface RawEncryptRequestOrBuilder

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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 RawEncryptRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static RawEncryptRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RawEncryptRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RawEncryptRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RawEncryptRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RawEncryptRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static RawEncryptRequest.Builder newBuilder()

    • newBuilder

      public static RawEncryptRequest.Builder newBuilder(RawEncryptRequest prototype)

    • toBuilder

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

    • newBuilderForType

      protected RawEncryptRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static RawEncryptRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RawEncryptRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<RawEncryptRequest> 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.GeneratedMessage

    • getDefaultInstanceForType

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