Class ShipmentOrderRequest

java.lang.Object

com.eqixiac.equinix.customerportal.model.json.creators.ShipmentOrderRequest

public class ShipmentOrderRequest
extends Object

Request body for scheduling an inbound or outbound shipment (POST /colocations/v2/orders/shipments, Shipment_Create).

type (INBOUND/OUTBOUND), requestedDateTime, cageId and details are required. details is one of InboundShipments_create or OutboundShipments_create; supply the corresponding typed creator (InboundShipmentDetails or OutboundShipmentDetails). The details parameter is typed as Object to accept either typed creator or, as an escape hatch, a free-form Map<String, Object>.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShipmentOrderRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ShipmentOrderRequest.Builder	builder(String type, String requestedDateTime, String cageId, Object details)	Returns a new builder for a shipment order request.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static ShipmentOrderRequest.Builder builder(String type,
 String requestedDateTime,
 String cageId,
 Object details)

Returns a new builder for a shipment order request.

Parameters:

type - the shipment type (INBOUND/OUTBOUND) (required)

requestedDateTime - the requested date/time (required)

cageId - the cage id (required)

details - the inbound/outbound shipment details (required); pass an InboundShipmentDetails, an OutboundShipmentDetails, or a free-form Map<String, Object>

Returns:

a new builder