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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceOrder.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Order.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasLineItems()For responses, this returns true if the service returned a value for the LineItems property.List<LineItem>lineItems()The line items for the orderInstantorderFulfilledDate()The fulfillment date of the order.StringorderId()The ID of the order.InstantorderSubmissionDate()The submission date for the order.OrderTypeorderType()The type of order.StringorderTypeAsString()The type of order.StringoutpostId()The ID of the Outpost in the order.PaymentOptionpaymentOption()The payment option for the order.StringpaymentOptionAsString()The payment option for the order.PaymentTermpaymentTerm()The payment term.StringpaymentTermAsString()The payment term.List<SdkField<?>>sdkFields()static Class<? extends Order.Builder>serializableBuilderClass()OrderStatusstatus()The status of the order.StringstatusAsString()The status of the order.Order.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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, andFULFILLED.If the service returns an enum value that is not available in the current SDK version,
statuswill returnOrderStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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, andFULFILLED. -
- See Also:
OrderStatus
-
-
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, andFULFILLED.If the service returns an enum value that is not available in the current SDK version,
statuswill returnOrderStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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, andFULFILLED. -
- See Also:
OrderStatus
-
-
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 theisEmpty()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,
paymentOptionwill returnPaymentOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompaymentOptionAsString().- Returns:
- The payment option for the order.
- See Also:
PaymentOption
-
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,
paymentOptionwill returnPaymentOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompaymentOptionAsString().- Returns:
- The payment option for the order.
- See Also:
PaymentOption
-
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,
paymentTermwill returnPaymentTerm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompaymentTermAsString().- Returns:
- The payment term.
- See Also:
PaymentTerm
-
paymentTermAsString
public final String paymentTermAsString()
The payment term.
If the service returns an enum value that is not available in the current SDK version,
paymentTermwill returnPaymentTerm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompaymentTermAsString().- Returns:
- The payment term.
- See Also:
PaymentTerm
-
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,
orderTypewill returnOrderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromorderTypeAsString().- Returns:
- The type of order.
- See Also:
OrderType
-
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,
orderTypewill returnOrderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromorderTypeAsString().- Returns:
- The type of order.
- See Also:
OrderType
-
toBuilder
public Order.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Order.Builder,Order>
-
builder
public static Order.Builder builder()
-
serializableBuilderClass
public static Class<? extends Order.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-