Class MacVerifyResponse

  • All Implemented Interfaces:
    MacVerifyResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class MacVerifyResponse
    extends com.google.protobuf.GeneratedMessageV3
    implements MacVerifyResponseOrBuilder
     Response message for
     [KeyManagementService.MacVerify][google.cloud.kms.v1.KeyManagementService.MacVerify].
     
    Protobuf type google.cloud.kms.v1.MacVerifyResponse
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  MacVerifyResponse.Builder
      Response message for [KeyManagementService.MacVerify][google.cloud.kms.v1.KeyManagementService.MacVerify].
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Field Detail

      • VERIFIED_DATA_CRC32C_FIELD_NUMBER

        public static final int VERIFIED_DATA_CRC32C_FIELD_NUMBER
        See Also:
        Constant Field Values
      • VERIFIED_MAC_CRC32C_FIELD_NUMBER

        public static final int VERIFIED_MAC_CRC32C_FIELD_NUMBER
        See Also:
        Constant Field Values
      • VERIFIED_SUCCESS_INTEGRITY_FIELD_NUMBER

        public static final int VERIFIED_SUCCESS_INTEGRITY_FIELD_NUMBER
        See Also:
        Constant Field Values
      • PROTECTION_LEVEL_FIELD_NUMBER

        public static final int PROTECTION_LEVEL_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getName

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

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

        public boolean getSuccess()
         This field indicates whether or not the verification operation for
         [MacVerifyRequest.mac][google.cloud.kms.v1.MacVerifyRequest.mac] over
         [MacVerifyRequest.data][google.cloud.kms.v1.MacVerifyRequest.data] was
         successful.
         
        bool success = 2;
        Specified by:
        getSuccess in interface MacVerifyResponseOrBuilder
        Returns:
        The success.
      • getVerifiedDataCrc32C

        public boolean getVerifiedDataCrc32C()
         Integrity verification field. A flag indicating whether
         [MacVerifyRequest.data_crc32c][google.cloud.kms.v1.MacVerifyRequest.data_crc32c]
         was received by
         [KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used
         for the integrity verification of the
         [data][google.cloud.kms.v1.MacVerifyRequest.data]. A false value of this
         field indicates either that
         [MacVerifyRequest.data_crc32c][google.cloud.kms.v1.MacVerifyRequest.data_crc32c]
         was left unset or that it was not delivered to
         [KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've
         set
         [MacVerifyRequest.data_crc32c][google.cloud.kms.v1.MacVerifyRequest.data_crc32c]
         but this field is still false, discard the response and perform a limited
         number of retries.
         
        bool verified_data_crc32c = 3;
        Specified by:
        getVerifiedDataCrc32C in interface MacVerifyResponseOrBuilder
        Returns:
        The verifiedDataCrc32c.
      • getVerifiedMacCrc32C

        public boolean getVerifiedMacCrc32C()
         Integrity verification field. A flag indicating whether
         [MacVerifyRequest.mac_crc32c][google.cloud.kms.v1.MacVerifyRequest.mac_crc32c]
         was received by
         [KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used
         for the integrity verification of the
         [data][google.cloud.kms.v1.MacVerifyRequest.mac]. A false value of this
         field indicates either that
         [MacVerifyRequest.mac_crc32c][google.cloud.kms.v1.MacVerifyRequest.mac_crc32c]
         was left unset or that it was not delivered to
         [KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've
         set
         [MacVerifyRequest.mac_crc32c][google.cloud.kms.v1.MacVerifyRequest.mac_crc32c]
         but this field is still false, discard the response and perform a limited
         number of retries.
         
        bool verified_mac_crc32c = 4;
        Specified by:
        getVerifiedMacCrc32C in interface MacVerifyResponseOrBuilder
        Returns:
        The verifiedMacCrc32c.
      • getVerifiedSuccessIntegrity

        public boolean getVerifiedSuccessIntegrity()
         Integrity verification field. This value is used for the integrity
         verification of [MacVerifyResponse.success]. If the value of this field
         contradicts the value of [MacVerifyResponse.success], discard the response
         and perform a limited number of retries.
         
        bool verified_success_integrity = 5;
        Specified by:
        getVerifiedSuccessIntegrity in interface MacVerifyResponseOrBuilder
        Returns:
        The verifiedSuccessIntegrity.
      • getProtectionLevelValue

        public int getProtectionLevelValue()
         The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the
         [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used for
         verification.
         
        .google.cloud.kms.v1.ProtectionLevel protection_level = 6;
        Specified by:
        getProtectionLevelValue in interface MacVerifyResponseOrBuilder
        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 for
         verification.
         
        .google.cloud.kms.v1.ProtectionLevel protection_level = 6;
        Specified by:
        getProtectionLevel in interface MacVerifyResponseOrBuilder
        Returns:
        The protectionLevel.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • 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.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • 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 MacVerifyResponse parseFrom​(ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

        public static MacVerifyResponse parseFrom​(com.google.protobuf.ByteString data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

        public static MacVerifyResponse parseFrom​(com.google.protobuf.CodedInputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException
        Throws:
        IOException
      • newBuilderForType

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

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

        protected MacVerifyResponse.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<MacVerifyResponse> 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.GeneratedMessageV3
      • getDefaultInstanceForType

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