Package com.google.cloud.kms.v1

Class DecapsulateResponse

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    DecapsulateResponse.Builder
    Response message for [KeyManagementService.Decapsulate][google.cloud.kms.v1.KeyManagementService.Decapsulate].

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

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    PROTECTION_LEVEL_FIELD_NUMBER
     
    static final int
    SHARED_SECRET_CRC32C_FIELD_NUMBER
     
    static final int
    SHARED_SECRET_FIELD_NUMBER
     
    static final int
    VERIFIED_CIPHERTEXT_CRC32C_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, 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
    Description
    boolean
    equals(Object obj)
     
    static DecapsulateResponse
    getDefaultInstance()
     
    DecapsulateResponse
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getName()
    The resource name of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used for decapsulation.
    com.google.protobuf.ByteString
    getNameBytes()
    The resource name of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used for decapsulation.
    com.google.protobuf.Parser<DecapsulateResponse>
    getParserForType()
     
    ProtectionLevel
    getProtectionLevel()
    The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in decapsulation.
    int
    getProtectionLevelValue()
    The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in decapsulation.
    int
    getSerializedSize()
     
    com.google.protobuf.ByteString
    getSharedSecret()
    The decapsulated shared_secret originally encapsulated with the matching public key.
    long
    getSharedSecretCrc32C()
    Integrity verification field.
    boolean
    getVerifiedCiphertextCrc32C()
    Integrity verification field.
    int
    hashCode()
     
    boolean
    hasSharedSecretCrc32C()
    Integrity verification field.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static DecapsulateResponse.Builder
    newBuilder()
     
    static DecapsulateResponse.Builder
    newBuilder(DecapsulateResponse prototype)
     
    DecapsulateResponse.Builder
    newBuilderForType()
     
    protected DecapsulateResponse.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static DecapsulateResponse
    parseDelimitedFrom(InputStream input)
     
    static DecapsulateResponse
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DecapsulateResponse
    parseFrom(byte[] data)
     
    static DecapsulateResponse
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DecapsulateResponse
    parseFrom(com.google.protobuf.ByteString data)
     
    static DecapsulateResponse
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DecapsulateResponse
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static DecapsulateResponse
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DecapsulateResponse
    parseFrom(InputStream input)
     
    static DecapsulateResponse
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DecapsulateResponse
    parseFrom(ByteBuffer data)
     
    static DecapsulateResponse
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<DecapsulateResponse>
    parser()
     
    DecapsulateResponse.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    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.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • SHARED_SECRET_FIELD_NUMBER

      public static final int SHARED_SECRET_FIELD_NUMBER
      See Also:

    • SHARED_SECRET_CRC32C_FIELD_NUMBER

      public static final int SHARED_SECRET_CRC32C_FIELD_NUMBER
      See Also:

    • VERIFIED_CIPHERTEXT_CRC32C_FIELD_NUMBER

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

    • getName

      public String getName()
       The resource name of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used for
 decapsulation. Check this field to verify that the intended resource was
 used for decapsulation.
      string name = 1;
      Specified by:
      getName in interface DecapsulateResponseOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The resource name of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used for
 decapsulation. Check this field to verify that the intended resource was
 used for decapsulation.
      string name = 1;
      Specified by:
      getNameBytes in interface DecapsulateResponseOrBuilder
      Returns:
      The bytes for name.

    • getSharedSecret

      public com.google.protobuf.ByteString getSharedSecret()
       The decapsulated shared_secret originally encapsulated with the matching
 public key.
      bytes shared_secret = 2;
      Specified by:
      getSharedSecret in interface DecapsulateResponseOrBuilder
      Returns:
      The sharedSecret.

    • hasSharedSecretCrc32C

      public boolean hasSharedSecretCrc32C()
       Integrity verification field. A CRC32C checksum of the returned
 [DecapsulateResponse.shared_secret][google.cloud.kms.v1.DecapsulateResponse.shared_secret].
 An integrity check of
 [DecapsulateResponse.shared_secret][google.cloud.kms.v1.DecapsulateResponse.shared_secret]
 can be performed by computing the CRC32C checksum of
 [DecapsulateResponse.shared_secret][google.cloud.kms.v1.DecapsulateResponse.shared_secret]
 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: receiving this response message indicates that
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] is able to
 successfully decrypt the
 [ciphertext][google.cloud.kms.v1.DecapsulateRequest.ciphertext]. 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.
      optional int64 shared_secret_crc32c = 3;
      Specified by:
      hasSharedSecretCrc32C in interface DecapsulateResponseOrBuilder
      Returns:
      Whether the sharedSecretCrc32c field is set.

    • getSharedSecretCrc32C

      public long getSharedSecretCrc32C()
       Integrity verification field. A CRC32C checksum of the returned
 [DecapsulateResponse.shared_secret][google.cloud.kms.v1.DecapsulateResponse.shared_secret].
 An integrity check of
 [DecapsulateResponse.shared_secret][google.cloud.kms.v1.DecapsulateResponse.shared_secret]
 can be performed by computing the CRC32C checksum of
 [DecapsulateResponse.shared_secret][google.cloud.kms.v1.DecapsulateResponse.shared_secret]
 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: receiving this response message indicates that
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] is able to
 successfully decrypt the
 [ciphertext][google.cloud.kms.v1.DecapsulateRequest.ciphertext]. 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.
      optional int64 shared_secret_crc32c = 3;
      Specified by:
      getSharedSecretCrc32C in interface DecapsulateResponseOrBuilder
      Returns:
      The sharedSecretCrc32c.

    • getVerifiedCiphertextCrc32C

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

    • getProtectionLevelValue

      public int getProtectionLevelValue()
       The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in
 decapsulation.
      .google.cloud.kms.v1.ProtectionLevel protection_level = 5;
      Specified by:
      getProtectionLevelValue in interface DecapsulateResponseOrBuilder
      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
 decapsulation.
      .google.cloud.kms.v1.ProtectionLevel protection_level = 5;
      Specified by:
      getProtectionLevel in interface DecapsulateResponseOrBuilder
      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 DecapsulateResponse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static DecapsulateResponse.Builder newBuilder()

    • newBuilder

      public static DecapsulateResponse.Builder newBuilder(DecapsulateResponse prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static DecapsulateResponse getDefaultInstance()

    • parser

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

    • getParserForType

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