Class FinancialRecordError

java.lang.Object
software.amazon.awssdk.services.payments.model.FinancialRecordError
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FinancialRecordError.Builder,FinancialRecordError>

@Generated("software.amazon.awssdk:codegen") public final class FinancialRecordError extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FinancialRecordError.Builder,FinancialRecordError>

The reason that one of the records requested from BatchGetFinancialRecord couldn't be returned. The other records in the request are unaffected.

See Also:
  • Method Details

    • key

      public final FinancialRecordKey key()

      The key of the record that couldn't be retrieved, as you requested it.

      Returns:
      The key of the record that couldn't be retrieved, as you requested it.
    • code

      public final BatchErrorCode code()

      The error code that indicates why the retrieval failed. The following values are valid:

      • NOT_FOUND – No financial record on your account matches the key.

      • INTERNAL_ERROR – An internal error occurred while processing this record. The other records in the request are unaffected. You can retry this record.

      If the service returns an enum value that is not available in the current SDK version, code will return BatchErrorCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from codeAsString().

      Returns:
      The error code that indicates why the retrieval failed. The following values are valid:

      • NOT_FOUND – No financial record on your account matches the key.

      • INTERNAL_ERROR – An internal error occurred while processing this record. The other records in the request are unaffected. You can retry this record.

      See Also:
    • codeAsString

      public final String codeAsString()

      The error code that indicates why the retrieval failed. The following values are valid:

      • NOT_FOUND – No financial record on your account matches the key.

      • INTERNAL_ERROR – An internal error occurred while processing this record. The other records in the request are unaffected. You can retry this record.

      If the service returns an enum value that is not available in the current SDK version, code will return BatchErrorCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from codeAsString().

      Returns:
      The error code that indicates why the retrieval failed. The following values are valid:

      • NOT_FOUND – No financial record on your account matches the key.

      • INTERNAL_ERROR – An internal error occurred while processing this record. The other records in the request are unaffected. You can retry this record.

      See Also:
    • message

      public final String message()

      A description of why the operation couldn't retrieve this record. The wording can change at any time and isn't localized, so don't parse this value. To handle the error in your code, use code instead.

      Returns:
      A description of why the operation couldn't retrieve this record. The wording can change at any time and isn't localized, so don't parse this value. To handle the error in your code, use code instead.
    • toBuilder

      public FinancialRecordError.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<FinancialRecordError.Builder,FinancialRecordError>
      Returns:
      a builder for type T
    • builder

      public static FinancialRecordError.Builder builder()
    • serializableBuilderClass

      public static Class<? extends FinancialRecordError.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.