Package software.amazon.awssdk.services.outposts.model

Class Order

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

Information about an order.

See Also:

  • Method Details

    • outpostId

      public final String outpostId()

      The ID of the Outpost in the order.

      Returns:
      The ID of the Outpost in the order.

    • orderId

      public final String orderId()

      The ID of the order.

      Returns:
      The ID of the order.

    • status

      public final OrderStatus status()

      The status of the order.

      • PREPARING - Order is received and being prepared.

      • IN_PROGRESS - Order is either being built, shipped, or installed. To get more details, see the line item status.

      • COMPLETED - Order is complete.

      • CANCELLED - Order is cancelled.

      • ERROR - Customer should contact support.

      The following status are deprecated: RECEIVED, PENDING, PROCESSING, INSTALLING, and FULFILLED.

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

      Returns:
      The status of the order.

      • PREPARING - Order is received and being prepared.

      • IN_PROGRESS - Order is either being built, shipped, or installed. To get more details, see the line item status.

      • COMPLETED - Order is complete.

      • CANCELLED - Order is cancelled.

      • ERROR - Customer should contact support.

      The following status are deprecated: RECEIVED, PENDING, PROCESSING, INSTALLING, and FULFILLED.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the order.

      • PREPARING - Order is received and being prepared.

      • IN_PROGRESS - Order is either being built, shipped, or installed. To get more details, see the line item status.

      • COMPLETED - Order is complete.

      • CANCELLED - Order is cancelled.

      • ERROR - Customer should contact support.

      The following status are deprecated: RECEIVED, PENDING, PROCESSING, INSTALLING, and FULFILLED.

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

      Returns:
      The status of the order.

      • PREPARING - Order is received and being prepared.

      • IN_PROGRESS - Order is either being built, shipped, or installed. To get more details, see the line item status.

      • COMPLETED - Order is complete.

      • CANCELLED - Order is cancelled.

      • ERROR - Customer should contact support.

      The following status are deprecated: RECEIVED, PENDING, PROCESSING, INSTALLING, and FULFILLED.

      See Also:

    • hasLineItems

      public final boolean hasLineItems()
      For responses, this returns true if the service returned a value for the LineItems property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • lineItems

      public final List<LineItem> lineItems()

      The line items for the order

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLineItems() method.

      Returns:
      The line items for the order

    • paymentOption

      public final PaymentOption paymentOption()

      The payment option for the order.

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

      Returns:
      The payment option for the order.
      See Also:

    • paymentOptionAsString

      public final String paymentOptionAsString()

      The payment option for the order.

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

      Returns:
      The payment option for the order.
      See Also:

    • orderSubmissionDate

      public final Instant orderSubmissionDate()

      The submission date for the order.

      Returns:
      The submission date for the order.

    • orderFulfilledDate

      public final Instant orderFulfilledDate()

      The fulfillment date of the order.

      Returns:
      The fulfillment date of the order.

    • paymentTerm

      public final PaymentTerm paymentTerm()

      The payment term.

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

      Returns:
      The payment term.
      See Also:

    • paymentTermAsString

      public final String paymentTermAsString()

      The payment term.

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

      Returns:
      The payment term.
      See Also:

    • orderType

      public final OrderType orderType()

      The type of order.

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

      Returns:
      The type of order.
      See Also:

    • orderTypeAsString

      public final String orderTypeAsString()

      The type of order.

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

      Returns:
      The type of order.
      See Also:

    • toBuilder

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

    • builder

      public static Order.Builder builder()

    • serializableBuilderClass

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