Record Class Warning

java.lang.Object
java.lang.Record
com.maxmind.minfraud.response.Warning
Record Components:
code - This provides a machine-readable code identifying the warning. Although more codes may be added in the future, the current codes are:
  • BILLING_CITY_NOT_FOUND – the billing city could not be found in our database.
  • BILLING_COUNTRY_NOT_FOUND – the billing country could not be found in our database.
  • BILLING_POSTAL_NOT_FOUND – the billing postal could not be found in our database.
  • INPUT_INVALID – the value associated with the key does not meet the required constraints, e.g., "United States" in a field that requires a two-letter country code.
  • INPUT_UNKNOWN – an unknown key was encountered in the request body.
  • IP_ADDRESS_NOT_FOUND – the IP address could not be geolocated.
  • SHIPPING_CITY_NOT_FOUND – the shipping city could not be found in our database.
  • SHIPPING_COUNTRY_NOT_FOUND – the shipping country could not be found in our database.
  • SHIPPING_POSTAL_NOT_FOUND – the shipping postal could not be found in our database.
warning - This field provides a human-readable explanation of the warning. The description may change at any time and should not be matched against.
inputPointer - This is a JSON Pointer to the input that the warning is associated with. For instance, if the warning was about the billing city, the value would be "/billing/city". See RFC 6901 for the JSON Pointer spec.
All Implemented Interfaces:
JsonSerializable
public record Warning(String code, String warning, String inputPointer) extends Record implements JsonSerializable
This class represents a warning returned by the web service.

  • Constructor Details

    • Warning

      public Warning(String code, String warning, String inputPointer)
      Creates an instance of a Warning record class.
      Parameters:
      code - the value for the code record component
      warning - the value for the warning record component
      inputPointer - the value for the inputPointer record component

  • Method Details

    • getCode

      @Deprecated(since="4.0.0", forRemoval=true) public String getCode()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use code() instead. This method will be removed in 5.0.0.
      This provides a machine-readable code identifying the warning. Although more codes may be added in the future, the current codes are:
      • BILLING_CITY_NOT_FOUND – the billing city could not be found in our database.
      • BILLING_COUNTRY_NOT_FOUND – the billing country could not be found in our database.
      • BILLING_POSTAL_NOT_FOUND – the billing postal could not be found in our database.
      • INPUT_INVALID – the value associated with the key does not meet the required constraints, e.g., "United States" in a field that requires a two-letter country code.
      • INPUT_UNKNOWN – an unknown key was encountered in the request body.
      • IP_ADDRESS_NOT_FOUND – the IP address could not be geolocated.
      • SHIPPING_CITY_NOT_FOUND – the shipping city could not be found in our database.
      • SHIPPING_COUNTRY_NOT_FOUND – the shipping country could not be found in our database.
      • SHIPPING_POSTAL_NOT_FOUND – the shipping postal could not be found in our database.
      Returns:
      The warning code.

    • getWarning

      @Deprecated(since="4.0.0", forRemoval=true) public String getWarning()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use warning() instead. This method will be removed in 5.0.0.
      Returns:
      This field provides a human-readable explanation of the warning. The description may change at any time and should not be matched against.

    • getInputPointer

      @Deprecated(since="4.0.0", forRemoval=true) public String getInputPointer()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use inputPointer() instead. This method will be removed in 5.0.0.
      Returns:
      This is a JSON Pointer to the input that the warning is associated with. For instance, if the warning was about the billing city, the value would be "/billing/city". See RFC 6901 for the JSON Pointer spec.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • code

      public String code()
      Returns the value of the code record component.
      Returns:
      the value of the code record component

    • warning

      public String warning()
      Returns the value of the warning record component.
      Returns:
      the value of the warning record component

    • inputPointer

      public String inputPointer()
      Returns the value of the inputPointer record component.
      Returns:
      the value of the inputPointer record component