Class OrderingRequirement

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

A requirement that must be met before an order can be submitted for a quote.

See Also:

  • Method Details

    • statusMessage

      public final String statusMessage()

      A message about the ordering requirement.

      Returns:
      A message about the ordering requirement.

    • orderingRequirementType

      public final OrderingRequirementType orderingRequirementType()

      The type of ordering requirement. Indicates which check failed or passed.

      • OUTPOST_ACTIVE_CHECK_ERROR - The Outpost must be in an active state.

      • MAXIMUM_ALLOWED_ORDERS_CHECK_ERROR - The maximum number of allowed orders has been reached.

      • VALID_ZIP_CODE_CHECK_ERROR - The site address must have a valid zip code.

      • RACK_PHYSICAL_PROPERTIES_CHECK_ERROR - The rack physical properties do not meet requirements.

      • OPERATING_ADDRESS_EXISTENCE_CHECK_ERROR - The site must have an operating address.

      • SHIPPING_ADDRESS_EXISTENCE_CHECK_ERROR - The site must have a shipping address.

      • COUNTRY_CODE_MISMATCH_CHECK_ERROR - The country code on the quote does not match the Outpost site country.

      • OUTPOST_GENERATION_MISMATCH_ERROR - The Outpost generation does not match the requested configuration.

      • OUTPOST_ID_MISSING_ON_QUOTE_ERROR - The quote must be associated with an Outpost before submitting an order.

      • ENTERPRISE_SUPPORT_ERROR - Enterprise Support is required.

      • SHIPPING_ADDRESS_MISSING_CONTACT_NAME_ERROR - The shipping address must have a contact name.

      • SHIPPING_ADDRESS_MISSING_CONTACT_NUMBER_ERROR - The shipping address must have a contact phone number.

      • SHIPPING_ADDRESS_MISSING_CONTACT_INFO_ERROR - The shipping address must have contact information.

      • OUTPOST_STATE_CHANGED_ERROR - The Outpost state has changed since the quote was created.

      • OUTPOST_NOT_FOUND_ERROR - The Outpost associated with the quote was not found.

      • OUTPOST_RENEWAL_REQUIRED_ERROR - The Outpost requires a renewal before a new order can be submitted.

      • UNSUPPORTED - The requirement type is not recognized.

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

      Returns:
      The type of ordering requirement. Indicates which check failed or passed.

      • OUTPOST_ACTIVE_CHECK_ERROR - The Outpost must be in an active state.

      • MAXIMUM_ALLOWED_ORDERS_CHECK_ERROR - The maximum number of allowed orders has been reached.

      • VALID_ZIP_CODE_CHECK_ERROR - The site address must have a valid zip code.

      • RACK_PHYSICAL_PROPERTIES_CHECK_ERROR - The rack physical properties do not meet requirements.

      • OPERATING_ADDRESS_EXISTENCE_CHECK_ERROR - The site must have an operating address.

      • SHIPPING_ADDRESS_EXISTENCE_CHECK_ERROR - The site must have a shipping address.

      • COUNTRY_CODE_MISMATCH_CHECK_ERROR - The country code on the quote does not match the Outpost site country.

      • OUTPOST_GENERATION_MISMATCH_ERROR - The Outpost generation does not match the requested configuration.

      • OUTPOST_ID_MISSING_ON_QUOTE_ERROR - The quote must be associated with an Outpost before submitting an order.

      • ENTERPRISE_SUPPORT_ERROR - Enterprise Support is required.

      • SHIPPING_ADDRESS_MISSING_CONTACT_NAME_ERROR - The shipping address must have a contact name.

      • SHIPPING_ADDRESS_MISSING_CONTACT_NUMBER_ERROR - The shipping address must have a contact phone number.

      • SHIPPING_ADDRESS_MISSING_CONTACT_INFO_ERROR - The shipping address must have contact information.

      • OUTPOST_STATE_CHANGED_ERROR - The Outpost state has changed since the quote was created.

      • OUTPOST_NOT_FOUND_ERROR - The Outpost associated with the quote was not found.

      • OUTPOST_RENEWAL_REQUIRED_ERROR - The Outpost requires a renewal before a new order can be submitted.

      • UNSUPPORTED - The requirement type is not recognized.

      See Also:

    • orderingRequirementTypeAsString

      public final String orderingRequirementTypeAsString()

      The type of ordering requirement. Indicates which check failed or passed.

      • OUTPOST_ACTIVE_CHECK_ERROR - The Outpost must be in an active state.

      • MAXIMUM_ALLOWED_ORDERS_CHECK_ERROR - The maximum number of allowed orders has been reached.

      • VALID_ZIP_CODE_CHECK_ERROR - The site address must have a valid zip code.

      • RACK_PHYSICAL_PROPERTIES_CHECK_ERROR - The rack physical properties do not meet requirements.

      • OPERATING_ADDRESS_EXISTENCE_CHECK_ERROR - The site must have an operating address.

      • SHIPPING_ADDRESS_EXISTENCE_CHECK_ERROR - The site must have a shipping address.

      • COUNTRY_CODE_MISMATCH_CHECK_ERROR - The country code on the quote does not match the Outpost site country.

      • OUTPOST_GENERATION_MISMATCH_ERROR - The Outpost generation does not match the requested configuration.

      • OUTPOST_ID_MISSING_ON_QUOTE_ERROR - The quote must be associated with an Outpost before submitting an order.

      • ENTERPRISE_SUPPORT_ERROR - Enterprise Support is required.

      • SHIPPING_ADDRESS_MISSING_CONTACT_NAME_ERROR - The shipping address must have a contact name.

      • SHIPPING_ADDRESS_MISSING_CONTACT_NUMBER_ERROR - The shipping address must have a contact phone number.

      • SHIPPING_ADDRESS_MISSING_CONTACT_INFO_ERROR - The shipping address must have contact information.

      • OUTPOST_STATE_CHANGED_ERROR - The Outpost state has changed since the quote was created.

      • OUTPOST_NOT_FOUND_ERROR - The Outpost associated with the quote was not found.

      • OUTPOST_RENEWAL_REQUIRED_ERROR - The Outpost requires a renewal before a new order can be submitted.

      • UNSUPPORTED - The requirement type is not recognized.

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

      Returns:
      The type of ordering requirement. Indicates which check failed or passed.

      • OUTPOST_ACTIVE_CHECK_ERROR - The Outpost must be in an active state.

      • MAXIMUM_ALLOWED_ORDERS_CHECK_ERROR - The maximum number of allowed orders has been reached.

      • VALID_ZIP_CODE_CHECK_ERROR - The site address must have a valid zip code.

      • RACK_PHYSICAL_PROPERTIES_CHECK_ERROR - The rack physical properties do not meet requirements.

      • OPERATING_ADDRESS_EXISTENCE_CHECK_ERROR - The site must have an operating address.

      • SHIPPING_ADDRESS_EXISTENCE_CHECK_ERROR - The site must have a shipping address.

      • COUNTRY_CODE_MISMATCH_CHECK_ERROR - The country code on the quote does not match the Outpost site country.

      • OUTPOST_GENERATION_MISMATCH_ERROR - The Outpost generation does not match the requested configuration.

      • OUTPOST_ID_MISSING_ON_QUOTE_ERROR - The quote must be associated with an Outpost before submitting an order.

      • ENTERPRISE_SUPPORT_ERROR - Enterprise Support is required.

      • SHIPPING_ADDRESS_MISSING_CONTACT_NAME_ERROR - The shipping address must have a contact name.

      • SHIPPING_ADDRESS_MISSING_CONTACT_NUMBER_ERROR - The shipping address must have a contact phone number.

      • SHIPPING_ADDRESS_MISSING_CONTACT_INFO_ERROR - The shipping address must have contact information.

      • OUTPOST_STATE_CHANGED_ERROR - The Outpost state has changed since the quote was created.

      • OUTPOST_NOT_FOUND_ERROR - The Outpost associated with the quote was not found.

      • OUTPOST_RENEWAL_REQUIRED_ERROR - The Outpost requires a renewal before a new order can be submitted.

      • UNSUPPORTED - The requirement type is not recognized.

      See Also:

    • status

      public final OrderingRequirementStatus status()

      The status of the ordering requirement. Valid values are PASS, FAIL, and EXEMPT.

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

      Returns:
      The status of the ordering requirement. Valid values are PASS, FAIL, and EXEMPT.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the ordering requirement. Valid values are PASS, FAIL, and EXEMPT.

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

      Returns:
      The status of the ordering requirement. Valid values are PASS, FAIL, and EXEMPT.
      See Also:

    • toBuilder

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

    • builder

      public static OrderingRequirement.Builder builder()

    • serializableBuilderClass

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