software.amazon.awssdk.services.outposts.model.Order Maven / Gradle / Ivy
Show all versions of outposts Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.outposts.model;
import java.io.Serializable;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Information about an order.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Order implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField OUTPOST_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("OutpostId").getter(getter(Order::outpostId)).setter(setter(Builder::outpostId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OutpostId").build()).build();
private static final SdkField ORDER_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("OrderId").getter(getter(Order::orderId)).setter(setter(Builder::orderId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OrderId").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
.getter(getter(Order::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final SdkField> LINE_ITEMS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("LineItems")
.getter(getter(Order::lineItems))
.setter(setter(Builder::lineItems))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LineItems").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(LineItem::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField PAYMENT_OPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PaymentOption").getter(getter(Order::paymentOptionAsString)).setter(setter(Builder::paymentOption))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PaymentOption").build()).build();
private static final SdkField ORDER_SUBMISSION_DATE_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("OrderSubmissionDate").getter(getter(Order::orderSubmissionDate))
.setter(setter(Builder::orderSubmissionDate))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OrderSubmissionDate").build())
.build();
private static final SdkField ORDER_FULFILLED_DATE_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("OrderFulfilledDate").getter(getter(Order::orderFulfilledDate))
.setter(setter(Builder::orderFulfilledDate))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OrderFulfilledDate").build())
.build();
private static final SdkField PAYMENT_TERM_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PaymentTerm").getter(getter(Order::paymentTermAsString)).setter(setter(Builder::paymentTerm))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PaymentTerm").build()).build();
private static final SdkField ORDER_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("OrderType").getter(getter(Order::orderTypeAsString)).setter(setter(Builder::orderType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OrderType").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(OUTPOST_ID_FIELD,
ORDER_ID_FIELD, STATUS_FIELD, LINE_ITEMS_FIELD, PAYMENT_OPTION_FIELD, ORDER_SUBMISSION_DATE_FIELD,
ORDER_FULFILLED_DATE_FIELD, PAYMENT_TERM_FIELD, ORDER_TYPE_FIELD));
private static final long serialVersionUID = 1L;
private final String outpostId;
private final String orderId;
private final String status;
private final List lineItems;
private final String paymentOption;
private final Instant orderSubmissionDate;
private final Instant orderFulfilledDate;
private final String paymentTerm;
private final String orderType;
private Order(BuilderImpl builder) {
this.outpostId = builder.outpostId;
this.orderId = builder.orderId;
this.status = builder.status;
this.lineItems = builder.lineItems;
this.paymentOption = builder.paymentOption;
this.orderSubmissionDate = builder.orderSubmissionDate;
this.orderFulfilledDate = builder.orderFulfilledDate;
this.paymentTerm = builder.paymentTerm;
this.orderType = builder.orderType;
}
/**
*
* The ID of the Outpost in the order.
*
*
* @return The ID of the Outpost in the order.
*/
public final String outpostId() {
return outpostId;
}
/**
*
* The ID of the order.
*
*
* @return The ID of the order.
*/
public final String orderId() {
return orderId;
}
/**
*
* 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, {@link #status} will
* return {@link OrderStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return 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 OrderStatus
*/
public final OrderStatus status() {
return OrderStatus.fromValue(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, {@link #status} will
* return {@link OrderStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return 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 OrderStatus
*/
public final String statusAsString() {
return status;
}
/**
* 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 {@code 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.
*/
public final boolean hasLineItems() {
return lineItems != null && !(lineItems instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasLineItems} method.
*
*
* @return The line items for the order
*/
public final List lineItems() {
return lineItems;
}
/**
*
* The payment option for the order.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #paymentOption}
* will return {@link PaymentOption#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #paymentOptionAsString}.
*
*
* @return The payment option for the order.
* @see PaymentOption
*/
public final PaymentOption paymentOption() {
return PaymentOption.fromValue(paymentOption);
}
/**
*
* The payment option for the order.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #paymentOption}
* will return {@link PaymentOption#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #paymentOptionAsString}.
*
*
* @return The payment option for the order.
* @see PaymentOption
*/
public final String paymentOptionAsString() {
return paymentOption;
}
/**
*
* The submission date for the order.
*
*
* @return The submission date for the order.
*/
public final Instant orderSubmissionDate() {
return orderSubmissionDate;
}
/**
*
* The fulfillment date of the order.
*
*
* @return The fulfillment date of the order.
*/
public final Instant orderFulfilledDate() {
return orderFulfilledDate;
}
/**
*
* The payment term.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #paymentTerm} will
* return {@link PaymentTerm#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #paymentTermAsString}.
*
*
* @return The payment term.
* @see PaymentTerm
*/
public final PaymentTerm paymentTerm() {
return PaymentTerm.fromValue(paymentTerm);
}
/**
*
* The payment term.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #paymentTerm} will
* return {@link PaymentTerm#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #paymentTermAsString}.
*
*
* @return The payment term.
* @see PaymentTerm
*/
public final String paymentTermAsString() {
return paymentTerm;
}
/**
*
* The type of order.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #orderType} will
* return {@link OrderType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #orderTypeAsString}.
*
*
* @return The type of order.
* @see OrderType
*/
public final OrderType orderType() {
return OrderType.fromValue(orderType);
}
/**
*
* The type of order.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #orderType} will
* return {@link OrderType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #orderTypeAsString}.
*
*
* @return The type of order.
* @see OrderType
*/
public final String orderTypeAsString() {
return orderType;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(outpostId());
hashCode = 31 * hashCode + Objects.hashCode(orderId());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasLineItems() ? lineItems() : null);
hashCode = 31 * hashCode + Objects.hashCode(paymentOptionAsString());
hashCode = 31 * hashCode + Objects.hashCode(orderSubmissionDate());
hashCode = 31 * hashCode + Objects.hashCode(orderFulfilledDate());
hashCode = 31 * hashCode + Objects.hashCode(paymentTermAsString());
hashCode = 31 * hashCode + Objects.hashCode(orderTypeAsString());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof Order)) {
return false;
}
Order other = (Order) obj;
return Objects.equals(outpostId(), other.outpostId()) && Objects.equals(orderId(), other.orderId())
&& Objects.equals(statusAsString(), other.statusAsString()) && hasLineItems() == other.hasLineItems()
&& Objects.equals(lineItems(), other.lineItems())
&& Objects.equals(paymentOptionAsString(), other.paymentOptionAsString())
&& Objects.equals(orderSubmissionDate(), other.orderSubmissionDate())
&& Objects.equals(orderFulfilledDate(), other.orderFulfilledDate())
&& Objects.equals(paymentTermAsString(), other.paymentTermAsString())
&& Objects.equals(orderTypeAsString(), other.orderTypeAsString());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("Order").add("OutpostId", outpostId()).add("OrderId", orderId()).add("Status", statusAsString())
.add("LineItems", hasLineItems() ? lineItems() : null).add("PaymentOption", paymentOptionAsString())
.add("OrderSubmissionDate", orderSubmissionDate()).add("OrderFulfilledDate", orderFulfilledDate())
.add("PaymentTerm", paymentTermAsString()).add("OrderType", orderTypeAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "OutpostId":
return Optional.ofNullable(clazz.cast(outpostId()));
case "OrderId":
return Optional.ofNullable(clazz.cast(orderId()));
case "Status":
return Optional.ofNullable(clazz.cast(statusAsString()));
case "LineItems":
return Optional.ofNullable(clazz.cast(lineItems()));
case "PaymentOption":
return Optional.ofNullable(clazz.cast(paymentOptionAsString()));
case "OrderSubmissionDate":
return Optional.ofNullable(clazz.cast(orderSubmissionDate()));
case "OrderFulfilledDate":
return Optional.ofNullable(clazz.cast(orderFulfilledDate()));
case "PaymentTerm":
return Optional.ofNullable(clazz.cast(paymentTermAsString()));
case "OrderType":
return Optional.ofNullable(clazz.cast(orderTypeAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function