OrderSummary (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.outposts.model.OrderSummary

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<OrderSummary.Builder,OrderSummary>

@Generated(value="software.amazon.awssdk:codegen")
public final class OrderSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<OrderSummary.Builder,OrderSummary>

A summary of line items in your order.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface OrderSummary.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`OrderSummary.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static OrderSummary.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasLineItemCountsByStatus()` For responses, this returns true if the service returned a value for the LineItemCountsByStatus property.
`Map<LineItemStatus,Integer>`	`lineItemCountsByStatus()` The status of all line items in the order.
`Map<String,Integer>`	`lineItemCountsByStatusAsStrings()` The status of all line items in the order.
`Instant`	`orderFulfilledDate()` The fulfilment date for the order.
`String`	`orderId()` The ID of the order.
`Instant`	`orderSubmissionDate()` The submission date for the order.
`OrderType`	`orderType()` The type of order.
`String`	`orderTypeAsString()` The type of order.
`String`	`outpostId()` The ID of the Outpost.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends OrderSummary.Builder>`	`serializableBuilderClass()`
`OrderStatus`	`status()` The status of the order.
`String`	`statusAsString()` The status of the order.
`OrderSummary.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.
    
    Returns:
    
    The ID of the Outpost.
  - orderId
```
public final String orderId()
```
    The ID of the order.
    
    Returns:
    
    The ID of the order.
  - 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:
    
    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, 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:
    
    OrderType
  - status
```
public final OrderStatus 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 the LineItem status.
    - COMPLETED - Order is complete.
    - CANCELLED - Order is cancelled.
    - ERROR - Customer should contact support.
    The following statuses 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 is being prepared.
    
    IN_PROGRESS - Order is either being built, shipped, or installed. For more information, see the LineItem status.
    
    COMPLETED - Order is complete.
    
    CANCELLED - Order is cancelled.
    
    ERROR - Customer should contact support.
    
    The following statuses 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 is being prepared.
    - IN_PROGRESS - Order is either being built, shipped, or installed. For more information, see the LineItem status.
    - COMPLETED - Order is complete.
    - CANCELLED - Order is cancelled.
    - ERROR - Customer should contact support.
    The following statuses 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 is being prepared.
    
    IN_PROGRESS - Order is either being built, shipped, or installed. For more information, see the LineItem status.
    
    COMPLETED - Order is complete.
    
    CANCELLED - Order is cancelled.
    
    ERROR - Customer should contact support.
    
    The following statuses are deprecated: RECEIVED, PENDING, PROCESSING, INSTALLING, and FULFILLED.
    See Also:
    
    OrderStatus
  - lineItemCountsByStatus
```
public final Map<LineItemStatus,Integer> 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 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.
  - lineItemCountsByStatusAsStrings
```
public final Map<String,Integer> 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
```
public final Instant orderSubmissionDate()
```
    The submission date for the order.
    
    Returns:
    
    The submission date for the order.
  - orderFulfilledDate
```
public final Instant orderFulfilledDate()
```
    The fulfilment date for the order.
    
    Returns:
    
    The fulfilment date for the order.
  - toBuilder
```
public OrderSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<OrderSummary.Builder,OrderSummary>
  - builder
```
public static OrderSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends OrderSummary.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

Class OrderSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

outpostId

orderId

orderType

orderTypeAsString

status

statusAsString

lineItemCountsByStatus

hasLineItemCountsByStatus

lineItemCountsByStatusAsStrings

orderSubmissionDate

orderFulfilledDate

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields