Class Order

java.lang.Object
software.amazon.awssdk.services.privatenetworks.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:

  • Method Details

    • acknowledgmentStatus

      public final AcknowledgmentStatus acknowledgmentStatus()

      The acknowledgement status of the order.

      If the service returns an enum value that is not available in the current SDK version, acknowledgmentStatus will return AcknowledgmentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from acknowledgmentStatusAsString().

      Returns:
      The acknowledgement status of the order.
      See Also:

    • acknowledgmentStatusAsString

      public final String acknowledgmentStatusAsString()

      The acknowledgement status of the order.

      If the service returns an enum value that is not available in the current SDK version, acknowledgmentStatus will return AcknowledgmentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from acknowledgmentStatusAsString().

      Returns:
      The acknowledgement status of the order.
      See Also:

    • createdAt

      public final Instant createdAt()

      The creation time of the order.

      Returns:
      The creation time of the order.

    • networkArn

      public final String networkArn()

      The Amazon Resource Name (ARN) of the network associated with this order.

      Returns:
      The Amazon Resource Name (ARN) of the network associated with this order.

    • networkSiteArn

      public final String networkSiteArn()

      The Amazon Resource Name (ARN) of the network site associated with this order.

      Returns:
      The Amazon Resource Name (ARN) of the network site associated with this order.

    • orderArn

      public final String orderArn()

      The Amazon Resource Name (ARN) of the order.

      Returns:
      The Amazon Resource Name (ARN) of the order.

    • hasOrderedResources

      public final boolean hasOrderedResources()
      For responses, this returns true if the service returned a value for the OrderedResources 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.

    • orderedResources

      public final List<OrderedResourceDefinition> orderedResources()

      A list of the network resources placed 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 hasOrderedResources() method.

      Returns:
      A list of the network resources placed in the order.

    • shippingAddress

      public final Address shippingAddress()

      The shipping address of the order.

      Returns:
      The shipping address of the order.

    • hasTrackingInformation

      public final boolean hasTrackingInformation()
      For responses, this returns true if the service returned a value for the TrackingInformation 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.

    • trackingInformation

      public final List<TrackingInformation> trackingInformation()

      The tracking information of 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 hasTrackingInformation() method.

      Returns:
      The tracking information of the order.

    • toBuilder

      public Order.Builder 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 interface ToCopyableBuilder<Order.Builder,Order>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.