REST Resource: projects.locations.orders

Resource: Order

An order for GDC hardware.

JSON representation 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "state": enum (State),
  "organizationContact": {
    object (OrganizationContact)
  },
  "targetWorkloads": [
    string
  ],
  "customerMotivation": string,
  "fulfillmentTime": string,
  "regionCode": string,
  "orderFormUri": string,
  "type": enum (Type),
  "submitTime": string,
  "billingId": string,
  "existingHardware": [
    {
      object (HardwareLocation)
    }
  ],
  "deploymentType": enum (DeploymentType),
  "actualInstallationDate": {
    object (Date)
  },
  "estimatedInstallationDate": {
    object (Date)
  }
}
Fields
name

string

Identifier. Name of this order. Format: projects/{project}/locations/{location}/orders/{order}
displayName

string

Optional. Display name of this order.
createTime

string (Timestamp format)

Output only. Time when this order was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. Time when this order was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Optional. Labels associated with this order as key value pairs. For more information about labels, see Create and manage labels.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
state

enum (State)

Output only. State of this order. On order creation, state will be set to DRAFT.
organizationContact

object (OrganizationContact)

Required. Customer contact information.
targetWorkloads[]

string

Optional. Customer specified workloads of interest targeted by this order. This must contain <= 20 elements and the length of each element must be <= 50 characters.
customerMotivation

string

Required. Information about the customer's motivation for this order. The length of this field must be <= 1000 characters.
fulfillmentTime

string (Timestamp format)

Required. Customer specified deadline by when this order should be fulfilled.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
regionCode

string

Required. Unicode CLDR region code where this order will be deployed. For a list of valid CLDR region codes, see the Language Subtag Registry.
orderFormUri

string

Output only. Link to the order form.
type

enum (Type)

Output only. Type of this Order.
submitTime

string (Timestamp format)

Output only. Time when the order was submitted. Is auto-populated to the current time when an order is submitted.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
billingId

string

Output only. The Google Cloud Billing ID to be charged for this order.
existingHardware[]

object (HardwareLocation)

Optional. Existing hardware to be removed as part of this order. Note: any hardware removed will be recycled unless otherwise agreed.
deploymentType

enum (DeploymentType)

Output only. The deployment type of this order.
actualInstallationDate

object (Date)

Output only. Actual installation date for this order.
estimatedInstallationDate

object (Date)

Output only. Estimated installation date for this order.

State

Valid states of an order.

Enums
STATE_UNSPECIFIED State of the order is unspecified.
DRAFT Order is being drafted by the customer and has not been submitted yet.
SUBMITTED Order has been submitted to Google.
INFO_COMPLETE All information required from the customer for fulfillment of the order is complete.
ACCEPTED Order has been accepted by Google.
ADDITIONAL_INFO_NEEDED Order needs more information from the customer.
BUILDING Google has initiated building hardware for the order.
SHIPPING The hardware has been built and is being shipped.
INSTALLING The hardware is being installed.
FAILED An error occurred in processing the order and customer intervention is required.
PARTIALLY_COMPLETED Order has been partially completed i.e., some hardware have been delivered and installed.
COMPLETED Order has been completed.
CANCELLED Order has been cancelled.

Type

Valid types of an Order.

Enums
TYPE_UNSPECIFIED Type of the order is unspecified.
PAID Paid by the customer.
POC Proof of concept for the customer.
UNPAID Not billed.

HardwareLocation

Represents the location of one or many hardware.

JSON representation 
{
  "site": string,
  "rackLocation": string,
  "rackSpace": [
    {
      object (RackSpace)
    }
  ]
}
Fields
site

string

Required. Name of the site where the hardware are present. Format: projects/{project}/locations/{location}/sites/{site}
rackLocation

string

Required. Location of the rack in the site e.g. Floor 2, Room 201, Row 7, Rack 3.
rackSpace[]

object (RackSpace)

Optional. Spaces occupied by the hardware in the rack. If unset, this location is assumed to be the entire rack.

DeploymentType

Valid types of a deployment.

Enums
DEPLOYMENT_TYPE_UNSPECIFIED Deployment type is unspecified.
FULL_PRODUCTION Prod deployment with SLOs.
PROOF_OF_CONCEPT Deployment with best-effort support and no SLOs.
INTERNAL Internal deployment with best-effort support and no SLOs.
CUSTOMER_LAB Customer lab deployment that we support as though it's prod.

Methods

create

 Creates a new order in a given project and location.

delete

 Deletes an order.

get

 Gets details of an order.

list

 Lists orders in a given project and location.

patch

 Updates the parameters of an order.

submit

 Submits an order.