Package com.google.cloud.kms.v1

Class EncryptResponse

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

  • Nested Class Summary

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

    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
     
    static final int
    PROTECTION_LEVEL_FIELD_NUMBER
     
    static final int
    VERIFIED_ADDITIONAL_AUTHENTICATED_DATA_CRC32C_FIELD_NUMBER
     
    static final int
    VERIFIED_PLAINTEXT_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)
     
    com.google.protobuf.ByteString
    getCiphertext()
    The encrypted data.
    com.google.protobuf.Int64Value
    getCiphertextCrc32C()
    Integrity verification field.
    com.google.protobuf.Int64ValueOrBuilder
    getCiphertextCrc32COrBuilder()
    Integrity verification field.
    static EncryptResponse
    getDefaultInstance()
     
    EncryptResponse
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getName()
    The resource name of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in encryption.
    com.google.protobuf.ByteString
    getNameBytes()
    The resource name of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in encryption.
    com.google.protobuf.Parser<EncryptResponse>
    getParserForType()
     
    ProtectionLevel
    getProtectionLevel()
    The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in encryption.
    int
    getProtectionLevelValue()
    The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in encryption.
    int
    getSerializedSize()
     
    boolean
    getVerifiedAdditionalAuthenticatedDataCrc32C()
    Integrity verification field.
    boolean
    getVerifiedPlaintextCrc32C()
    Integrity verification field.
    boolean
    hasCiphertextCrc32C()
    Integrity verification field.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static EncryptResponse.Builder
    newBuilder()
     
    static EncryptResponse.Builder
    newBuilder(EncryptResponse prototype)
     
    EncryptResponse.Builder
    newBuilderForType()
     
    protected EncryptResponse.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static EncryptResponse
    parseDelimitedFrom(InputStream input)
     
    static EncryptResponse
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EncryptResponse
    parseFrom(byte[] data)
     
    static EncryptResponse
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EncryptResponse
    parseFrom(com.google.protobuf.ByteString data)
     
    static EncryptResponse
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EncryptResponse
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static EncryptResponse
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EncryptResponse
    parseFrom(InputStream input)
     
    static EncryptResponse
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EncryptResponse
    parseFrom(ByteBuffer data)
     
    static EncryptResponse
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<EncryptResponse>
    parser()
     
    EncryptResponse.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:

    • 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:

    • 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 in
 encryption. Check this field to verify that the intended resource was used
 for encryption.
      string name = 1;
      Specified by:
      getName in interface EncryptResponseOrBuilder
      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 = 1;
      Specified by:
      getNameBytes in interface EncryptResponseOrBuilder
      Returns:
      The bytes for name.

    • getCiphertext

      public com.google.protobuf.ByteString getCiphertext()
       The encrypted data.
      bytes ciphertext = 2;
      Specified by:
      getCiphertext in interface EncryptResponseOrBuilder
      Returns:
      The ciphertext.

    • hasCiphertextCrc32C

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

    • getCiphertextCrc32C

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

    • getCiphertextCrc32COrBuilder

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

    • getVerifiedPlaintextCrc32C

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

    • getVerifiedAdditionalAuthenticatedDataCrc32C

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

    • 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 = 7;
      Specified by:
      getProtectionLevelValue in interface EncryptResponseOrBuilder
      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 = 7;
      Specified by:
      getProtectionLevel in interface EncryptResponseOrBuilder
      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 EncryptResponse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static EncryptResponse.Builder newBuilder()

    • newBuilder

      public static EncryptResponse.Builder newBuilder(EncryptResponse prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static EncryptResponse getDefaultInstance()

    • parser

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

    • getParserForType

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