GDC Hardware Management API

Service: gdchardwaremanagement.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://gdchardwaremanagement.googleapis.com

REST Resource: v1alpha.projects.locations

Methods
get GET /v1alpha/{name=projects/*/locations/*}
Gets information about a location.
list GET /v1alpha/{name=projects/*}/locations
Lists information about the supported locations for this service.

REST Resource: v1alpha.projects.locations.hardware

Methods
create POST /v1alpha/{parent=projects/*/locations/*}/hardware
Creates new hardware in a given project and location.
delete DELETE /v1alpha/{name=projects/*/locations/*/hardware/*}
Deletes hardware.
get GET /v1alpha/{name=projects/*/locations/*/hardware/*}
Gets hardware details.
list GET /v1alpha/{parent=projects/*/locations/*}/hardware
Lists hardware in a given project and location.
patch PATCH /v1alpha/{hardware.name=projects/*/locations/*/hardware/*}
Updates hardware parameters.

REST Resource: v1alpha.projects.locations.operations

Methods
cancel POST /v1alpha/{name=projects/*/locations/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1alpha/{name=projects/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1alpha/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1alpha/{name=projects/*/locations/*}/operations
Lists operations that match the specified filter in the request.

REST Resource: v1alpha.projects.locations.orders

Methods
create POST /v1alpha/{parent=projects/*/locations/*}/orders
Creates a new order in a given project and location.
delete DELETE /v1alpha/{name=projects/*/locations/*/orders/*}
Deletes an order.
get GET /v1alpha/{name=projects/*/locations/*/orders/*}
Gets details of an order.
list GET /v1alpha/{parent=projects/*/locations/*}/orders
Lists orders in a given project and location.
patch PATCH /v1alpha/{order.name=projects/*/locations/*/orders/*}
Updates the parameters of an order.
submit POST /v1alpha/{name=projects/*/locations/*/orders/*}:submit
Submits an order.

REST Resource: v1alpha.projects.locations.orders.changeLogEntries

Methods
get GET /v1alpha/{name=projects/*/locations/*/orders/*/changeLogEntries/*}
Gets details of a change to an order.
list GET /v1alpha/{parent=projects/*/locations/*/orders/*}/changeLogEntries
Lists the changes made to an order.

REST Resource: v1alpha.projects.locations.orders.comments

Methods
create POST /v1alpha/{parent=projects/*/locations/*/orders/*}/comments
Creates a new comment on an order.
get GET /v1alpha/{name=projects/*/locations/*/orders/*/comments/*}
Gets the content of a comment.
list GET /v1alpha/{parent=projects/*/locations/*/orders/*}/comments
Lists the comments on an order.
recordAction POST /v1alpha/{name=projects/*/locations/*/orders/*/comments/*}:recordAction
Record Action on a Comment.

REST Resource: v1alpha.projects.locations.orders.hardwareGroups

Methods
create POST /v1alpha/{parent=projects/*/locations/*/orders/*}/hardwareGroups
Creates a new hardware group in a given order.
delete DELETE /v1alpha/{name=projects/*/locations/*/orders/*/hardwareGroups/*}
Deletes a hardware group.
get GET /v1alpha/{name=projects/*/locations/*/orders/*/hardwareGroups/*}
Gets details of a hardware group.
list GET /v1alpha/{parent=projects/*/locations/*/orders/*}/hardwareGroups
Lists hardware groups in a given order.
patch PATCH /v1alpha/{hardwareGroup.name=projects/*/locations/*/orders/*/hardwareGroups/*}
Updates the parameters of a hardware group.

REST Resource: v1alpha.projects.locations.sites

Methods
create POST /v1alpha/{parent=projects/*/locations/*}/sites
Creates a new site in a given project and location.
delete DELETE /v1alpha/{name=projects/*/locations/*/sites/*}
Deletes a site.
get GET /v1alpha/{name=projects/*/locations/*/sites/*}
Gets details of a site.
list GET /v1alpha/{parent=projects/*/locations/*}/sites
Lists sites in a given project and location.
patch PATCH /v1alpha/{site.name=projects/*/locations/*/sites/*}
Updates the parameters of a site.

REST Resource: v1alpha.projects.locations.skus

Methods
get GET /v1alpha/{name=projects/*/locations/*/skus/*}
Gets details of an SKU.
list GET /v1alpha/{parent=projects/*/locations/*}/skus
Lists SKUs for a given project and location.

REST Resource: v1alpha.projects.locations.zones

Methods
create POST /v1alpha/{parent=projects/*/locations/*}/zones
Creates a new zone in a given project and location.
delete DELETE /v1alpha/{name=projects/*/locations/*/zones/*}
Deletes a zone.
get GET /v1alpha/{name=projects/*/locations/*/zones/*}
Gets details of a zone.
list GET /v1alpha/{parent=projects/*/locations/*}/zones
Lists zones in a given project and location.
patch PATCH /v1alpha/{zone.name=projects/*/locations/*/zones/*}
Updates the parameters of a zone.
signal POST /v1alpha/{name=projects/*/locations/*/zones/*}:signal
Signals the state of a zone.