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(value="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 and Description
static interface	Order.Builder

Method Summary

Modifier and Type	Method and Description
static Order.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLineItems() For responses, this returns true if the service returned a value for the LineItems property.
List<LineItem>	lineItems() The line items for the order
Instant	orderFulfilledDate() The fulfillment date of the order.
String	orderId() The ID of the order.
Instant	orderSubmissionDate() The submission date for the order.
String	outpostId() The ID of the Outpost in the order.
PaymentOption	paymentOption() The payment option for the order.
String	paymentOptionAsString() The payment option for the order.
List<SdkField<?>>	sdkFields()
static Class<? extends Order.Builder>	serializableBuilderClass()
OrderStatus	status() The status of the order.
String	statusAsString() The status of the order.
Order.Builder	toBuilder()
String	toString() 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, 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:

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, 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:

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 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:

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, 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:

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.

toBuilder

public Order.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Order.Builder,Order>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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