Package com.google.cloud.kms.v1

Class RawEncryptResponse

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

  • Field Details

    • CIPHERTEXT_FIELD_NUMBER

      public static final int CIPHERTEXT_FIELD_NUMBER
      See Also:

    • INITIALIZATION_VECTOR_FIELD_NUMBER

      public static final int INITIALIZATION_VECTOR_FIELD_NUMBER
      See Also:

    • TAG_LENGTH_FIELD_NUMBER

      public static final int TAG_LENGTH_FIELD_NUMBER
      See Also:

    • CIPHERTEXT_CRC32C_FIELD_NUMBER

      public static final int CIPHERTEXT_CRC32C_FIELD_NUMBER
      See Also:

    • INITIALIZATION_VECTOR_CRC32C_FIELD_NUMBER

      public static final int INITIALIZATION_VECTOR_CRC32C_FIELD_NUMBER
      See Also:

    • VERIFIED_PLAINTEXT_CRC32C_FIELD_NUMBER

      public static final int VERIFIED_PLAINTEXT_CRC32C_FIELD_NUMBER
      See Also:

    • VERIFIED_ADDITIONAL_AUTHENTICATED_DATA_CRC32C_FIELD_NUMBER

      public static final int VERIFIED_ADDITIONAL_AUTHENTICATED_DATA_CRC32C_FIELD_NUMBER
      See Also:

    • VERIFIED_INITIALIZATION_VECTOR_CRC32C_FIELD_NUMBER

      public static final int VERIFIED_INITIALIZATION_VECTOR_CRC32C_FIELD_NUMBER
      See Also:

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • PROTECTION_LEVEL_FIELD_NUMBER

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

    • getCiphertext

      public com.google.protobuf.ByteString getCiphertext()
       The encrypted data. In the case of AES-GCM, the authentication tag
 is the [tag_length][google.cloud.kms.v1.RawEncryptResponse.tag_length]
 bytes at the end of this field.
      bytes ciphertext = 1;
      Specified by:
      getCiphertext in interface RawEncryptResponseOrBuilder
      Returns:
      The ciphertext.

    • getInitializationVector

      public com.google.protobuf.ByteString getInitializationVector()
       The initialization vector (IV) generated by the service during
 encryption. This value must be stored and provided in
 [RawDecryptRequest.initialization_vector][google.cloud.kms.v1.RawDecryptRequest.initialization_vector]
 at decryption time.
      bytes initialization_vector = 2;
      Specified by:
      getInitializationVector in interface RawEncryptResponseOrBuilder
      Returns:
      The initializationVector.

    • getTagLength

      public int getTagLength()
       The length of the authentication tag that is appended to
 the end of the ciphertext.
      int32 tag_length = 3;
      Specified by:
      getTagLength in interface RawEncryptResponseOrBuilder
      Returns:
      The tagLength.

    • hasCiphertextCrc32C

      public boolean hasCiphertextCrc32C()
       Integrity verification field. A CRC32C checksum of the returned
 [RawEncryptResponse.ciphertext][google.cloud.kms.v1.RawEncryptResponse.ciphertext].
 An integrity check of ciphertext can be performed by computing the CRC32C
 checksum of 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 RawEncryptResponseOrBuilder
      Returns:
      Whether the ciphertextCrc32c field is set.

    • getCiphertextCrc32C

      public com.google.protobuf.Int64Value getCiphertextCrc32C()
       Integrity verification field. A CRC32C checksum of the returned
 [RawEncryptResponse.ciphertext][google.cloud.kms.v1.RawEncryptResponse.ciphertext].
 An integrity check of ciphertext can be performed by computing the CRC32C
 checksum of 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 RawEncryptResponseOrBuilder
      Returns:
      The ciphertextCrc32c.

    • getCiphertextCrc32COrBuilder

      public com.google.protobuf.Int64ValueOrBuilder getCiphertextCrc32COrBuilder()
       Integrity verification field. A CRC32C checksum of the returned
 [RawEncryptResponse.ciphertext][google.cloud.kms.v1.RawEncryptResponse.ciphertext].
 An integrity check of ciphertext can be performed by computing the CRC32C
 checksum of 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 RawEncryptResponseOrBuilder

    • hasInitializationVectorCrc32C

      public boolean hasInitializationVectorCrc32C()
       Integrity verification field. A CRC32C checksum of the returned
 [RawEncryptResponse.initialization_vector][google.cloud.kms.v1.RawEncryptResponse.initialization_vector].
 An integrity check of initialization_vector can be performed by computing
 the CRC32C checksum of initialization_vector 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 initialization_vector_crc32c = 5;
      Specified by:
      hasInitializationVectorCrc32C in interface RawEncryptResponseOrBuilder
      Returns:
      Whether the initializationVectorCrc32c field is set.

    • getInitializationVectorCrc32C

      public com.google.protobuf.Int64Value getInitializationVectorCrc32C()
       Integrity verification field. A CRC32C checksum of the returned
 [RawEncryptResponse.initialization_vector][google.cloud.kms.v1.RawEncryptResponse.initialization_vector].
 An integrity check of initialization_vector can be performed by computing
 the CRC32C checksum of initialization_vector 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 initialization_vector_crc32c = 5;
      Specified by:
      getInitializationVectorCrc32C in interface RawEncryptResponseOrBuilder
      Returns:
      The initializationVectorCrc32c.

    • getInitializationVectorCrc32COrBuilder

      public com.google.protobuf.Int64ValueOrBuilder getInitializationVectorCrc32COrBuilder()
       Integrity verification field. A CRC32C checksum of the returned
 [RawEncryptResponse.initialization_vector][google.cloud.kms.v1.RawEncryptResponse.initialization_vector].
 An integrity check of initialization_vector can be performed by computing
 the CRC32C checksum of initialization_vector 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 initialization_vector_crc32c = 5;
      Specified by:
      getInitializationVectorCrc32COrBuilder in interface RawEncryptResponseOrBuilder

    • getVerifiedPlaintextCrc32C

      public boolean getVerifiedPlaintextCrc32C()
       Integrity verification field. A flag indicating whether
 [RawEncryptRequest.plaintext_crc32c][google.cloud.kms.v1.RawEncryptRequest.plaintext_crc32c]
 was received by
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used
 for the integrity verification of the plaintext. A false value of this
 field indicates either that
 [RawEncryptRequest.plaintext_crc32c][google.cloud.kms.v1.RawEncryptRequest.plaintext_crc32c]
 was left unset or that it was not delivered to
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've
 set
 [RawEncryptRequest.plaintext_crc32c][google.cloud.kms.v1.RawEncryptRequest.plaintext_crc32c]
 but this field is still false, discard the response and perform a limited
 number of retries.
      bool verified_plaintext_crc32c = 6;
      Specified by:
      getVerifiedPlaintextCrc32C in interface RawEncryptResponseOrBuilder
      Returns:
      The verifiedPlaintextCrc32c.

    • getVerifiedAdditionalAuthenticatedDataCrc32C

      public boolean getVerifiedAdditionalAuthenticatedDataCrc32C()
       Integrity verification field. A flag indicating whether
 [RawEncryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.RawEncryptRequest.additional_authenticated_data_crc32c]
 was received by
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used
 for the integrity verification of additional_authenticated_data. A false
 value of this field indicates either that //
 [RawEncryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.RawEncryptRequest.additional_authenticated_data_crc32c]
 was left unset or that it was not delivered to
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've
 set
 [RawEncryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.RawEncryptRequest.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 = 7;
      Specified by:
      getVerifiedAdditionalAuthenticatedDataCrc32C in interface RawEncryptResponseOrBuilder
      Returns:
      The verifiedAdditionalAuthenticatedDataCrc32c.

    • getVerifiedInitializationVectorCrc32C

      public boolean getVerifiedInitializationVectorCrc32C()
       Integrity verification field. A flag indicating whether
 [RawEncryptRequest.initialization_vector_crc32c][google.cloud.kms.v1.RawEncryptRequest.initialization_vector_crc32c]
 was received by
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used
 for the integrity verification of initialization_vector. A false value of
 this field indicates either that
 [RawEncryptRequest.initialization_vector_crc32c][google.cloud.kms.v1.RawEncryptRequest.initialization_vector_crc32c]
 was left unset or that it was not delivered to
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've
 set
 [RawEncryptRequest.initialization_vector_crc32c][google.cloud.kms.v1.RawEncryptRequest.initialization_vector_crc32c]
 but this field is still false, discard the response and perform a limited
 number of retries.
      bool verified_initialization_vector_crc32c = 10;
      Specified by:
      getVerifiedInitializationVectorCrc32C in interface RawEncryptResponseOrBuilder
      Returns:
      The verifiedInitializationVectorCrc32c.

    • 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 = 8;
      Specified by:
      getName in interface RawEncryptResponseOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.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 = 8;
      Specified by:
      getNameBytes in interface RawEncryptResponseOrBuilder
      Returns:
      The bytes for name.

    • 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 = 9;
      Specified by:
      getProtectionLevelValue in interface RawEncryptResponseOrBuilder
      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 = 9;
      Specified by:
      getProtectionLevel in interface RawEncryptResponseOrBuilder
      Returns:
      The protectionLevel.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static RawEncryptResponse.Builder newBuilder()

    • newBuilder

      public static RawEncryptResponse.Builder newBuilder(RawEncryptResponse prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static RawEncryptResponse getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<RawEncryptResponse> 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 RawEncryptResponse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder