Class ValidationExceptionField

java.lang.Object
software.amazon.awssdk.services.marketplacecatalog.model.ValidationExceptionField
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ValidationExceptionField.Builder,ValidationExceptionField>
@Generated("software.amazon.awssdk:codegen") public final class ValidationExceptionField extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ValidationExceptionField.Builder,ValidationExceptionField>

Detailed information about a single request field that failed validation, including the field's location, the reason it failed, and a human-readable message.

See Also:

  • Method Details

    • reason

      public final ValidationExceptionReason reason()

      The reason the field failed validation.

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

      Returns:
      The reason the field failed validation.
      See Also:

    • reasonAsString

      public final String reasonAsString()

      The reason the field failed validation.

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

      Returns:
      The reason the field failed validation.
      See Also:

    • entityType

      public final String entityType()

      The entity type the failing field applies to, if the field is on a specific entity. For example, AmiProduct@1.0.

      Returns:
      The entity type the failing field applies to, if the field is on a specific entity. For example, AmiProduct@1.0.

    • entityId

      public final String entityId()

      The entity identifier the failing field applies to, if the field is on a specific entity.

      Returns:
      The entity identifier the failing field applies to, if the field is on a specific entity.

    • changeType

      public final String changeType()

      The change type the failing field applies to, if the field is part of a change request. For example, AddDeliveryOptions.

      Returns:
      The change type the failing field applies to, if the field is part of a change request. For example, AddDeliveryOptions.

    • field

      public final String field()

      The name of the request field that failed validation, expressed as a JSON path (for example, Details.DeliveryOptions[0].Type).

      Returns:
      The name of the request field that failed validation, expressed as a JSON path (for example, Details.DeliveryOptions[0].Type).

    • message

      public final String message()

      A human-readable message describing why the field failed validation.

      Returns:
      A human-readable message describing why the field failed validation.

    • toBuilder

      public ValidationExceptionField.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<ValidationExceptionField.Builder,ValidationExceptionField>
      Returns:
      a builder for type T

    • builder

      public static ValidationExceptionField.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ValidationExceptionField.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.