Class OrderSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<OrderSummary.Builder,
OrderSummary>
A summary of line items in your order.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic OrderSummary.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the LineItemCountsByStatus property.final Map
<LineItemStatus, Integer> The status of all line items in the order.The status of all line items in the order.final Instant
The fulfilment date for the order.final String
orderId()
The ID of the order.final Instant
The submission date for the order.final OrderType
The type of order.final String
The type of order.final String
The ID of the Outpost.static Class
<? extends OrderSummary.Builder> final OrderStatus
status()
The status of the order.final String
The status of the order.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
outpostId
The ID of the Outpost.
- Returns:
- The ID of the Outpost.
-
orderId
The ID of the order.
- Returns:
- The ID of the order.
-
orderType
The type of order.
If the service returns an enum value that is not available in the current SDK version,
orderType
will returnOrderType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromorderTypeAsString()
.- Returns:
- The type of order.
- See Also:
-
orderTypeAsString
The type of order.
If the service returns an enum value that is not available in the current SDK version,
orderType
will returnOrderType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromorderTypeAsString()
.- Returns:
- The type of order.
- See Also:
-
status
The status of the order.
-
PREPARING
- Order is received and is being prepared. -
IN_PROGRESS
- Order is either being built, shipped, or installed. For more information, see theLineItem
status. -
COMPLETED
- Order is complete. -
CANCELLED
- Order is cancelled. -
ERROR
- Customer should contact support.
The following statuses are deprecated:
RECEIVED
,PENDING
,PROCESSING
,INSTALLING
, andFULFILLED
.If the service returns an enum value that is not available in the current SDK version,
status
will 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 is being prepared. -
IN_PROGRESS
- Order is either being built, shipped, or installed. For more information, see theLineItem
status. -
COMPLETED
- Order is complete. -
CANCELLED
- Order is cancelled. -
ERROR
- Customer should contact support.
The following statuses are deprecated:
RECEIVED
,PENDING
,PROCESSING
,INSTALLING
, andFULFILLED
. -
- See Also:
-
-
statusAsString
The status of the order.
-
PREPARING
- Order is received and is being prepared. -
IN_PROGRESS
- Order is either being built, shipped, or installed. For more information, see theLineItem
status. -
COMPLETED
- Order is complete. -
CANCELLED
- Order is cancelled. -
ERROR
- Customer should contact support.
The following statuses are deprecated:
RECEIVED
,PENDING
,PROCESSING
,INSTALLING
, andFULFILLED
.If the service returns an enum value that is not available in the current SDK version,
status
will 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 is being prepared. -
IN_PROGRESS
- Order is either being built, shipped, or installed. For more information, see theLineItem
status. -
COMPLETED
- Order is complete. -
CANCELLED
- Order is cancelled. -
ERROR
- Customer should contact support.
The following statuses are deprecated:
RECEIVED
,PENDING
,PROCESSING
,INSTALLING
, andFULFILLED
. -
- See Also:
-
-
lineItemCountsByStatus
The status of all line items in 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
hasLineItemCountsByStatus()
method.- Returns:
- The status of all line items in the order.
-
hasLineItemCountsByStatus
public final boolean hasLineItemCountsByStatus()For responses, this returns true if the service returned a value for the LineItemCountsByStatus 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. -
lineItemCountsByStatusAsStrings
The status of all line items in 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
hasLineItemCountsByStatus()
method.- Returns:
- The status of all line items in the order.
-
orderSubmissionDate
The submission date for the order.
- Returns:
- The submission date for the order.
-
orderFulfilledDate
The fulfilment date for the order.
- Returns:
- The fulfilment date for the order.
-
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 interfaceToCopyableBuilder<OrderSummary.Builder,
OrderSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-