Package com.google.cloud.kms.v1

Class DecapsulateRequest

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    DecapsulateRequest.Builder
    Request 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
    CIPHERTEXT_CRC32C_FIELD_NUMBER
     
    static final int
    CIPHERTEXT_FIELD_NUMBER
     
    static final int
    NAME_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)
     
    com.google.protobuf.ByteString
    getCiphertext()
    Required.
    com.google.protobuf.Int64Value
    getCiphertextCrc32C()
    Optional.
    com.google.protobuf.Int64ValueOrBuilder
    getCiphertextCrc32COrBuilder()
    Optional.
    static DecapsulateRequest
    getDefaultInstance()
     
    DecapsulateRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getName()
    Required.
    com.google.protobuf.ByteString
    getNameBytes()
    Required.
    com.google.protobuf.Parser<DecapsulateRequest>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    hasCiphertextCrc32C()
    Optional.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static DecapsulateRequest.Builder
    newBuilder()
     
    static DecapsulateRequest.Builder
    newBuilder(DecapsulateRequest prototype)
     
    DecapsulateRequest.Builder
    newBuilderForType()
     
    protected DecapsulateRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static DecapsulateRequest
    parseDelimitedFrom(InputStream input)
     
    static DecapsulateRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DecapsulateRequest
    parseFrom(byte[] data)
     
    static DecapsulateRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DecapsulateRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static DecapsulateRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DecapsulateRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static DecapsulateRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DecapsulateRequest
    parseFrom(InputStream input)
     
    static DecapsulateRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DecapsulateRequest
    parseFrom(ByteBuffer data)
     
    static DecapsulateRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<DecapsulateRequest>
    parser()
     
    DecapsulateRequest.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:

    • CIPHERTEXT_FIELD_NUMBER

      public static final int CIPHERTEXT_FIELD_NUMBER
      See Also:

    • CIPHERTEXT_CRC32C_FIELD_NUMBER

      public static final int CIPHERTEXT_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
 decapsulation.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getName in interface DecapsulateRequestOrBuilder
      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
 decapsulation.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getNameBytes in interface DecapsulateRequestOrBuilder
      Returns:
      The bytes for name.

    • getCiphertext

      public com.google.protobuf.ByteString getCiphertext()
       Required. The ciphertext produced from encapsulation with the
 named [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] public
 key(s).
      bytes ciphertext = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCiphertext in interface DecapsulateRequestOrBuilder
      Returns:
      The ciphertext.

    • hasCiphertextCrc32C

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

    • getCiphertextCrc32C

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

    • getCiphertextCrc32COrBuilder

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

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static DecapsulateRequest.Builder newBuilder()

    • newBuilder

      public static DecapsulateRequest.Builder newBuilder(DecapsulateRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static DecapsulateRequest getDefaultInstance()

    • parser

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

    • getParserForType

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