Interface MacVerifyResponseOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    MacVerifyResponse, MacVerifyResponse.Builder

    public interface MacVerifyResponseOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getName()
      The resource name of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used for verification.
      com.google.protobuf.ByteString getNameBytes()
      The resource name of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used for verification.
      ProtectionLevel getProtectionLevel()
      The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used for verification.
      int getProtectionLevelValue()
      The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used for verification.
      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.
      boolean getVerifiedDataCrc32C()
      Integrity verification field.
      boolean getVerifiedMacCrc32C()
      Integrity verification field.
      boolean getVerifiedSuccessIntegrity()
      Integrity verification field.
      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • Method Detail

      • getName

        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;
        Returns:
        The name.
      • getNameBytes

        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;
        Returns:
        The bytes for name.
      • getSuccess

        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;
        Returns:
        The success.
      • getVerifiedDataCrc32C

        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;
        Returns:
        The verifiedDataCrc32c.
      • getVerifiedMacCrc32C

        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;
        Returns:
        The verifiedMacCrc32c.
      • getVerifiedSuccessIntegrity

        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;
        Returns:
        The verifiedSuccessIntegrity.
      • getProtectionLevelValue

        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;
        Returns:
        The enum numeric value on the wire for protectionLevel.
      • getProtectionLevel

        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;
        Returns:
        The protectionLevel.