Package google.cloud.gdchardwaremanagement.v1alpha

Index

GDCHardwareManagement

The GDC Hardware Management service.

CreateComment

rpc CreateComment(CreateCommentRequest) returns (Operation)

Creates a new comment on an order.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • gdchardwaremanagement.comments.create

For more information, see the IAM documentation.
CreateHardware

rpc CreateHardware(CreateHardwareRequest) returns (Operation)

Creates new hardware in a given project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • gdchardwaremanagement.hardware.create

For more information, see the IAM documentation.
CreateHardwareGroup

rpc CreateHardwareGroup(CreateHardwareGroupRequest) returns (Operation)

Creates a new hardware group in a given order.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • gdchardwaremanagement.hardwareGroups.create

For more information, see the IAM documentation.
CreateOrder

rpc CreateOrder(CreateOrderRequest) returns (Operation)

Creates a new order in a given project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • gdchardwaremanagement.orders.create

For more information, see the IAM documentation.
CreateSite

rpc CreateSite(CreateSiteRequest) returns (Operation)

Creates a new site in a given project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • gdchardwaremanagement.sites.create

For more information, see the IAM documentation.
CreateZone

rpc CreateZone(CreateZoneRequest) returns (Operation)

Creates a new zone in a given project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • gdchardwaremanagement.zones.create

For more information, see the IAM documentation.
DeleteHardware

rpc DeleteHardware(DeleteHardwareRequest) returns (Operation)

Deletes hardware.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • gdchardwaremanagement.hardware.delete

For more information, see the IAM documentation.
DeleteHardwareGroup

rpc DeleteHardwareGroup(DeleteHardwareGroupRequest) returns (Operation)

Deletes a hardware group.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • gdchardwaremanagement.hardwareGroups.delete

For more information, see the IAM documentation.
DeleteOrder

rpc DeleteOrder(DeleteOrderRequest) returns (Operation)

Deletes an order.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • gdchardwaremanagement.orders.delete

For more information, see the IAM documentation.
DeleteZone

rpc DeleteZone(DeleteZoneRequest) returns (Operation)

Deletes a zone.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • gdchardwaremanagement.zones.delete

For more information, see the IAM documentation.
GetChangeLogEntry

rpc GetChangeLogEntry(GetChangeLogEntryRequest) returns (ChangeLogEntry)

Gets details of a change to an order.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • gdchardwaremanagement.changeLogEntries.get

For more information, see the IAM documentation.
GetComment

rpc GetComment(GetCommentRequest) returns (Comment)

Gets the content of a comment.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • gdchardwaremanagement.comments.get

For more information, see the IAM documentation.
GetHardware

rpc GetHardware(GetHardwareRequest) returns (Hardware)

Gets hardware details.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • gdchardwaremanagement.hardware.get

For more information, see the IAM documentation.
GetHardwareGroup

rpc GetHardwareGroup(GetHardwareGroupRequest) returns (HardwareGroup)

Gets details of a hardware group.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • gdchardwaremanagement.hardwareGroups.get

For more information, see the IAM documentation.
GetOrder

rpc GetOrder(GetOrderRequest) returns (Order)

Gets details of an order.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • gdchardwaremanagement.orders.get

For more information, see the IAM documentation.
GetSite

rpc GetSite(GetSiteRequest) returns (Site)

Gets details of a site.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • gdchardwaremanagement.sites.get

For more information, see the IAM documentation.
GetSku

rpc GetSku(GetSkuRequest) returns (Sku)

Gets details of an SKU.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • gdchardwaremanagement.skus.get

For more information, see the IAM documentation.
GetZone

rpc GetZone(GetZoneRequest) returns (Zone)

Gets details of a zone.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • gdchardwaremanagement.zones.get

For more information, see the IAM documentation.
ListChangeLogEntries

rpc ListChangeLogEntries(ListChangeLogEntriesRequest) returns (ListChangeLogEntriesResponse)

Lists the changes made to an order.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • gdchardwaremanagement.changeLogEntries.list

For more information, see the IAM documentation.
ListComments

rpc ListComments(ListCommentsRequest) returns (ListCommentsResponse)

Lists the comments on an order.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • gdchardwaremanagement.comments.list

For more information, see the IAM documentation.
ListHardware

rpc ListHardware(ListHardwareRequest) returns (ListHardwareResponse)

Lists hardware in a given project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • gdchardwaremanagement.hardware.list

For more information, see the IAM documentation.
ListHardwareGroups

rpc ListHardwareGroups(ListHardwareGroupsRequest) returns (ListHardwareGroupsResponse)

Lists hardware groups in a given order.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • gdchardwaremanagement.hardwareGroups.list

For more information, see the IAM documentation.
ListOrders

rpc ListOrders(ListOrdersRequest) returns (ListOrdersResponse)

Lists orders in a given project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • gdchardwaremanagement.orders.list

For more information, see the IAM documentation.
ListSites

rpc ListSites(ListSitesRequest) returns (ListSitesResponse)

Lists sites in a given project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • gdchardwaremanagement.sites.list

For more information, see the IAM documentation.
ListSkus

rpc ListSkus(ListSkusRequest) returns (ListSkusResponse)

Lists SKUs for a given project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • gdchardwaremanagement.skus.list

For more information, see the IAM documentation.
ListZones

rpc ListZones(ListZonesRequest) returns (ListZonesResponse)

Lists zones in a given project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • gdchardwaremanagement.zones.list

For more information, see the IAM documentation.
SubmitOrder

rpc SubmitOrder(SubmitOrderRequest) returns (Operation)

Submits an order.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • gdchardwaremanagement.orders.submit

For more information, see the IAM documentation.
UpdateHardware

rpc UpdateHardware(UpdateHardwareRequest) returns (Operation)

Updates hardware parameters.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • gdchardwaremanagement.hardware.update

For more information, see the IAM documentation.
UpdateHardwareGroup

rpc UpdateHardwareGroup(UpdateHardwareGroupRequest) returns (Operation)

Updates the parameters of a hardware group.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • gdchardwaremanagement.hardwareGroups.update

For more information, see the IAM documentation.
UpdateOrder

rpc UpdateOrder(UpdateOrderRequest) returns (Operation)

Updates the parameters of an order.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • gdchardwaremanagement.orders.update

For more information, see the IAM documentation.
UpdateSite

rpc UpdateSite(UpdateSiteRequest) returns (Operation)

Updates the parameters of a site.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • gdchardwaremanagement.sites.update

For more information, see the IAM documentation.
UpdateZone

rpc UpdateZone(UpdateZoneRequest) returns (Operation)

Updates the parameters of a zone.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • gdchardwaremanagement.zones.update

For more information, see the IAM documentation.

ChangeLogEntry

A log entry of a change made to an order.

Fields
name

string

Identifier. Name of this change log entry. Format: projects/{project}/locations/{location}/orders/{order}/changeLogEntries/{change_log_entry}
create_time

Timestamp

Output only. Time when this change log entry was created.
labels

map<string, string>

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

string

Output only. Content of this log entry.

Comment

A comment on an order.

Fields
name

string

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

Timestamp

Output only. Time when this comment was created.
labels

map<string, string>

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

string

Output only. Username of the author of this comment. This is auto-populated from the credentials used during creation of the comment.
text

string

Required. Text of this comment. The length of text must be <= 1000 characters.

Contact

Contact details of a point of contact.

Fields
given_name

string

Required. Given name of the contact.
family_name

string

Optional. Family name of the contact.
email

string

Required. Email of the contact.
phone

string

Required. Phone number of the contact.
time_zone

TimeZone

Optional. Time zone of the contact.
reachable_times[]

TimePeriod

Optional. The time periods when the contact is reachable. If this field is empty, the contact is reachable at all times.

CreateCommentRequest

A request to create a comment.

Fields
parent

string

Required. The order to create the comment on. Format: projects/{project}/locations/{location}/orders/{order}
comment_id

string

Optional. ID used to uniquely identify the Comment within its parent scope. This field should contain at most 63 characters and must start with lowercase characters. Only lowercase characters, numbers and - are accepted. The - character cannot be the first or the last one. A system generated ID will be used if the field is not set.

The comment.name field in the request will be ignored.
comment

Comment

Required. The comment to create.
request_id

string

Optional. An optional unique identifier for this request. See AIP-155.

CreateHardwareGroupRequest

A request to create a hardware group.

Fields
parent

string

Required. The order to create the hardware group in. Format: projects/{project}/locations/{location}/orders/{order}
hardware_group_id

string

Optional. ID used to uniquely identify the HardwareGroup within its parent scope. This field should contain at most 63 characters and must start with lowercase characters. Only lowercase characters, numbers and - are accepted. The - character cannot be the first or the last one. A system generated ID will be used if the field is not set.

The hardware_group.name field in the request will be ignored.
hardware_group

HardwareGroup

Required. The hardware group to create.
request_id

string

Optional. An optional unique identifier for this request. See AIP-155.

CreateHardwareRequest

A request to create hardware.

Fields
parent

string

Required. The project and location to create hardware in. Format: projects/{project}/locations/{location}
hardware_id

string

Optional. ID used to uniquely identify the Hardware within its parent scope. This field should contain at most 63 characters and must start with lowercase characters. Only lowercase characters, numbers and - are accepted. The - character cannot be the first or the last one. A system generated ID will be used if the field is not set.

The hardware.name field in the request will be ignored.
hardware

Hardware

Required. The resource to create.

CreateOrderRequest

A request to create an order.

Fields
parent

string

Required. The project and location to create the order in. Format: projects/{project}/locations/{location}
order_id

string

Optional. ID used to uniquely identify the Order within its parent scope. This field should contain at most 63 characters and must start with lowercase characters. Only lowercase characters, numbers and - are accepted. The - character cannot be the first or the last one. A system generated ID will be used if the field is not set.

The order.name field in the request will be ignored.
order

Order

Required. The order to create.
request_id

string

Optional. An optional unique identifier for this request. See AIP-155.

CreateSiteRequest

A request to create a site.

Fields
parent

string

Required. The project and location to create the site in. Format: projects/{project}/locations/{location}
site_id

string

Optional. ID used to uniquely identify the Site within its parent scope. This field should contain at most 63 characters and must start with lowercase characters. Only lowercase characters, numbers and - are accepted. The - character cannot be the first or the last one. A system generated ID will be used if the field is not set.

The site.name field in the request will be ignored.
site

Site

Required. The site to create.
request_id

string

Optional. An optional unique identifier for this request. See AIP-155.

CreateZoneRequest

A request to create a zone.

Fields
parent

string

Required. The project and location to create the zone in. Format: projects/{project}/locations/{location}
zone_id

string

Optional. ID used to uniquely identify the Zone within its parent scope. This field should contain at most 63 characters and must start with lowercase characters. Only lowercase characters, numbers and - are accepted. The - character cannot be the first or the last one. A system generated ID will be used if the field is not set.

The zone.name field in the request will be ignored.
zone

Zone

Required. The zone to create.
request_id

string

Optional. An optional unique identifier for this request. See AIP-155.

DeleteHardwareGroupRequest

A request to delete a hardware group.

Fields
name

string

Required. The name of the hardware group. Format: projects/{project}/locations/{location}/orders/{order}/hardwareGroups/{hardware_group}
request_id

string

Optional. An optional unique identifier for this request. See AIP-155.

DeleteHardwareRequest

A request to delete hardware.

Fields
name

string

Required. The name of the hardware. Format: projects/{project}/locations/{location}/hardware/{hardware}
request_id

string

Optional. An optional unique identifier for this request. See AIP-155.

DeleteOrderRequest

A request to delete an order.

Fields
name

string

Required. The name of the order. Format: projects/{project}/locations/{location}/orders/{order}
request_id

string

Optional. An optional unique identifier for this request. See AIP-155.
force

bool

Optional. An option to delete any nested resources in the Order, such as a HardwareGroup. If true, any nested resources for this Order will also be deleted. Otherwise, the request will only succeed if the Order has no nested resources.

DeleteZoneRequest

A request to delete a zone.

Fields
name

string

Required. The name of the zone. Format: projects/{project}/locations/{location}/zones/{zone}
request_id

string

Optional. An optional unique identifier for this request. See AIP-155.

Dimensions

Represents the dimensions of an object.

Fields
width_inches

float

Required. Width in inches.
height_inches

float

Required. Height in inches.
depth_inches

float

Required. Depth in inches.

GetChangeLogEntryRequest

A request to get a change log entry.

Fields
name

string

Required. The name of the change log entry. Format: projects/{project}/locations/{location}/orders/{order}/changeLogEntries/{change_log_entry}

GetCommentRequest

A request to get a comment.

Fields
name

string

Required. The name of the comment. Format: projects/{project}/locations/{location}/orders/{order}/comments/{comment}

GetHardwareGroupRequest

A request to get a hardware group.

Fields
name

string

Required. The name of the hardware group. Format: projects/{project}/locations/{location}/orders/{order}/hardwareGroups/{hardware_group}

GetHardwareRequest

A request to get hardware.

Fields
name

string

Required. The name of the hardware. Format: projects/{project}/locations/{location}/hardware/{hardware}

GetOrderRequest

A request to get an order.

Fields
name

string

Required. Name of the resource

GetSiteRequest

A request to get a site.

Fields
name

string

Required. The name of the site. Format: projects/{project}/locations/{location}/sites/{site}

GetSkuRequest

A request to get an SKU.

Fields
name

string

Required. The name of the SKU. Format: projects/{project}/locations/{location}/skus/{sku}

GetZoneRequest

A request to get a zone.

Fields
name

string

Required. The name of the zone. Format: projects/{project}/locations/{location}/zones/{zone}

Hardware

An instance of hardware installed at a site.

Fields
name

string

Identifier. Name of this hardware. Format: projects/{project}/locations/{location}/hardware/{hardware}
display_name

string

Optional. Display name for this hardware.
create_time

Timestamp

Output only. Time when this hardware was created.
update_time

Timestamp

Output only. Time when this hardware was last updated.
labels

map<string, string>

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

string

Required. Name of the order that this hardware belongs to. Format: projects/{project}/locations/{location}/orders/{order}
hardware_group

string

Output only. Name for the hardware group that this hardware belongs to. Format: projects/{project}/locations/{location}/orders/{order}/hardwareGroups/{hardware_group}
site

string

Required. Name for the site that this hardware belongs to. Format: projects/{project}/locations/{location}/sites/{site}
state

State

Output only. Current state for this hardware.
ciq_uri

string

Output only. Link to the Customer Intake Questionnaire (CIQ) sheet for this Hardware.
config

HardwareConfig

Required. Configuration for this hardware.
estimated_installation_date

Date

Output only. Estimated installation date for this hardware.
physical_info

HardwarePhysicalInfo

Optional. Physical properties of this hardware.
installation_info

HardwareInstallationInfo

Optional. Information for installation of this hardware.
zone

string

Required. Name for the zone that this hardware belongs to. Format: projects/{project}/locations/{location}/zones/{zone}
requested_installation_date

Date

Optional. Requested installation date for this hardware. This is auto-populated when the order is accepted, if the hardware's HardwareGroup specifies this. It can also be filled in by the customer.
actual_installation_date

Date

Output only. Actual installation date for this hardware. Filled in by Google.

State

Valid states for hardware.

Enums
STATE_UNSPECIFIED State of the Hardware is unspecified.
ADDITIONAL_INFO_NEEDED More information is required from the customer to make progress.
BUILDING Google has initiated building hardware for this Hardware.
SHIPPING The hardware has been built and is being shipped.
INSTALLING The hardware is being installed.
INSTALLED The hardware has been installed.
FAILED An error occurred and customer intervention is required.

HardwareConfig

Configuration for GDC hardware.

Fields
sku

string

Required. Reference to the SKU for this hardware. This can point to a specific SKU revision in the form of resource_name@revision_id as defined in AIP-162. If no revision_id is specified, it refers to the latest revision.
power_supply

PowerSupply

Required. Power supply type for this hardware.
subscription_duration_months

int32

Optional. Subscription duration for the hardware in months.

HardwareGroup

A group of hardware that is part of the same order, has the same SKU, and is delivered to the same site.

Fields
name

string

Identifier. Name of this hardware group. Format: projects/{project}/locations/{location}/orders/{order}/hardwareGroups/{hardware_group}
create_time

Timestamp

Output only. Time when this hardware group was created.
update_time

Timestamp

Output only. Time when this hardware group was last updated.
labels

map<string, string>

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

int32

Required. Number of hardware in this HardwareGroup.
config

HardwareConfig

Required. Configuration for hardware in this HardwareGroup.
site

string

Required. Name of the site where the hardware in this HardwareGroup will be delivered. Format: projects/{project}/locations/{location}/sites/{site}
state

State

Output only. Current state of this HardwareGroup.
zone

string

Optional. Name of the zone that the hardware in this HardwareGroup belongs to. Format: projects/{project}/locations/{location}/zones/{zone}
requested_installation_date

Date

Optional. Requested installation date for the hardware in this HardwareGroup. Filled in by the customer.

State

Valid states of a HardwareGroup.

Enums
STATE_UNSPECIFIED State of the HardwareGroup is unspecified.
ADDITIONAL_INFO_NEEDED More information is required from the customer to make progress.
BUILDING Google has initiated building hardware for this HardwareGroup.
SHIPPING The hardware has been built and is being shipped.
INSTALLING The hardware is being installed.
PARTIALLY_INSTALLED Some hardware in the HardwareGroup have been installed.
INSTALLED All hardware in the HardwareGroup have been installed.
FAILED An error occurred and customer intervention is required.

HardwareInstallationInfo

Information for installation of a Hardware.

Fields
rack_location

string

Optional. Location of the rack in the site e.g. Floor 2, Room 201, Row 7, Rack 3.
power_distance_meters

int32

Required. Distance from the power outlet in meters.
switch_distance_meters

int32

Required. Distance from the network switch in meters.
rack_unit_dimensions

Dimensions

Required. Dimensions of the rack unit.
rack_space

RackSpace

Required. Rack space allocated for the hardware.
rack_type

RackType

Required. Type of the rack.

RackType

Valid rack types.

Enums
RACK_TYPE_UNSPECIFIED Rack type is unspecified.
TWO_POST Two post rack.
FOUR_POST Four post rack.

HardwareLocation

Represents the location of one or many hardware.

Fields
site

string

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

string

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

RackSpace

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

HardwarePhysicalInfo

Physical properties of a hardware.

Fields
power_receptacle

PowerReceptacleType

Required. The power receptacle type.
voltage

Voltage

Required. Voltage of the power supply.
amperes

Amperes

Required. Amperes of the power supply.

Amperes

Valid amperes values.

Enums
AMPERES_UNSPECIFIED Amperes is unspecified.
AMPERES_15 15A.

NetworkUplinkType

Valid network uplink types.

Enums
RJ_45 RJ-45.

PowerReceptacleType

Valid power receptacle types.

Enums
POWER_RECEPTACLE_TYPE_UNSPECIFIED Facility plug type is unspecified.
NEMA_5_15 NEMA 5-15.
C_13 C13.
STANDARD_EU Standard european receptacle.

Voltage

Valid voltage values.

Enums
VOLTAGE_UNSPECIFIED Voltage is unspecified.
VOLTAGE_110 120V.
VOLTAGE_220 220V.

ListChangeLogEntriesRequest

A request to list change log entries.

Fields
parent

string

Required. The order to list change log entries for. Format: projects/{project}/locations/{location}/orders/{order}
page_size

int32

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token

string

Optional. A token identifying a page of results the server should return.
filter

string

Optional. Filtering condition. See AIP-160.
order_by

string

Optional. Hint for how to order the results.

ListChangeLogEntriesResponse

A list of change log entries.

Fields
change_log_entries[]

ChangeLogEntry

The list of change log entries.
next_page_token

string

A token identifying a page of results the server should return.
unreachable[]

string

Locations that could not be reached.

ListCommentsRequest

A request to list comments.

Fields
parent

string

Required. The order to list comments on. Format: projects/{project}/locations/{location}/orders/{order}
page_size

int32

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token

string

Optional. A token identifying a page of results the server should return.
filter

string

Optional. Filtering condition. See AIP-160.
order_by

string

Optional. Hint for how to order the results.

ListCommentsResponse

A request to list comments.

Fields
comments[]

Comment

The list of comments.
next_page_token

string

A token identifying a page of results the server should return.
unreachable[]

string

Locations that could not be reached.

ListHardwareGroupsRequest

A request to list hardware groups.

Fields
parent

string

Required. The order to list hardware groups in. Format: projects/{project}/locations/{location}/orders/{order}
page_size

int32

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token

string

Optional. A token identifying a page of results the server should return.
filter

string

Optional. Filtering condition. See AIP-160.
order_by

string

Optional. Hint for how to order the results.

ListHardwareGroupsResponse

A list of hardware groups.

Fields
hardware_groups[]

HardwareGroup

The list of hardware groups.
next_page_token

string

A token identifying a page of results the server should return.
unreachable[]

string

Locations that could not be reached.

ListHardwareRequest

A request to list hardware.

Fields
parent

string

Required. The project and location to list hardware in. Format: projects/{project}/locations/{location}
page_size

int32

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token

string

Optional. A token identifying a page of results the server should return.
filter

string

Optional. Filtering condition. See AIP-160.
order_by

string

Optional. Hint for how to order the results.

ListHardwareResponse

A list of hardware.

Fields
hardware[]

Hardware

The list of hardware.
next_page_token

string

A token identifying a page of results the server should return.
unreachable[]

string

Locations that could not be reached.

ListOrdersRequest

A request to list orders.

Fields
parent

string

Required. The project and location to list orders in. Format: projects/{project}/locations/{location}
page_size

int32

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token

string

Optional. A token identifying a page of results the server should return.
filter

string

Optional. Filtering condition. See AIP-160.
order_by

string

Optional. Hint for how to order the results.

ListOrdersResponse

A list of orders.

Fields
orders[]

Order

The list of orders.
next_page_token

string

A token identifying a page of results the server should return.
unreachable[]

string

Locations that could not be reached.

ListSitesRequest

A request to list sites.

Fields
parent

string

Required. The project and location to list sites in. Format: projects/{project}/locations/{location}
page_size

int32

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token

string

Optional. A token identifying a page of results the server should return.
filter

string

Optional. Filtering condition. See AIP-160.
order_by

string

Optional. Hint for how to order the results.

ListSitesResponse

A list of sites.

Fields
sites[]

Site

The list of sites.
next_page_token

string

A token identifying a page of results the server should return.
unreachable[]

string

Locations that could not be reached.

ListSkusRequest

A request to list SKUs.

Fields
parent

string

Required. The project and location to list SKUs in. Format: projects/{project}/locations/{location}
page_size

int32

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token

string

Optional. A token identifying a page of results the server should return.
filter

string

Optional. Filtering condition. See AIP-160.
order_by

string

Optional. Hint for how to order the results.

ListSkusResponse

A list of SKUs.

Fields
skus[]

Sku

The list of SKUs.
next_page_token

string

A token identifying a page of results the server should return.
unreachable[]

string

Locations that could not be reached.

ListZonesRequest

A request to list zones.

Fields
parent

string

Required. The project and location to list zones in. Format: projects/{project}/locations/{location}
page_size

int32

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token

string

Optional. A token identifying a page of results the server should return.
filter

string

Optional. Filtering condition. See AIP-160.
order_by

string

Optional. Hint for how to order the results.

ListZonesResponse

A list of zones.

Fields
zones[]

Zone

The list of zones.
next_page_token

string

A token identifying a page of results the server should return.
unreachable[]

string

Locations that could not be reached.

OperationMetadata

Represents the metadata of a long-running operation.

Fields
create_time

Timestamp

Output only. The time the operation was created.
end_time

Timestamp

Output only. The time the operation finished running.
target

string

Output only. Server-defined resource path for the target of the operation.
verb

string

Output only. The verb executed by the operation.
status_message

string

Output only. Human-readable status of the operation, if any.
requested_cancellation

bool

Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have [Operation.error][] value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
api_version

string

Output only. API version used to start the operation.

Order

An order for GDC hardware.

Fields
name

string

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

string

Optional. Display name of this order.
create_time

Timestamp

Output only. Time when this order was created.
update_time

Timestamp

Output only. Time when this order was last updated.
labels

map<string, string>

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

State

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

OrganizationContact

Required. Customer contact information.
target_workloads[]

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.
customer_motivation

string

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

Timestamp

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

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.
order_form_uri

string

Output only. Link to the order form.
type

Type

Output only. Type of this Order.
submit_time

Timestamp

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

string

Required. The Google Cloud Billing ID to be charged for this order.
existing_hardware[]

HardwareLocation

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

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.
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.

OrganizationContact

Contact information of the customer organization.

Fields
address

PostalAddress

Required. The organization's address.
email

string

Optional. The organization's email.
phone

string

Optional. The organization's phone number.
contacts[]

Contact

Required. The individual points of contact in the organization at this location.

PowerSupply

The power supply options.

Enums
POWER_SUPPLY_UNSPECIFIED Power supply is unspecified.
POWER_SUPPLY_AC AC power supply.
POWER_SUPPLY_DC DC power supply.

RackSpace

Represents contiguous space in a rack.

Fields
start_rack_unit

int32

Required. First rack unit of the rack space (inclusive).
end_rack_unit

int32

Required. Last rack unit of the rack space (inclusive).

Site

A physical site where hardware will be installed.

Fields
name

string

Identifier. Name of the site. Format: projects/{project}/locations/{location}/sites/{site}
display_name

string

Optional. Display name of this Site.
description

string

Optional. Description of this Site.
create_time

Timestamp

Output only. Time when this site was created.
update_time

Timestamp

Output only. Time when this site was last updated.
labels

map<string, string>

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

OrganizationContact

Required. Contact information for this site.
google_maps_pin_uri

string

Required. A URL to the Google Maps address location of the site. An example value is https://goo.gl/maps/xxxxxxxxx.
access_times[]

TimePeriod

Optional. The time periods when the site is accessible. If this field is empty, the site is accessible at all times.
notes

string

Optional. Any additional notes for this Site. Please include information about: - security or access restrictions - any regulations affecting the technicians visiting the site - any special process or approval required to move the equipment - whether a representative will be available during site visits

Sku

A stock keeping unit (SKU) of GDC hardware.

Fields
name

string

Identifier. Name of this SKU. Format: projects/{project}/locations/{location}/skus/{sku}
display_name

string

Output only. Display name of this SKU.
create_time

Timestamp

Output only. Time when this SKU was created.
update_time

Timestamp

Output only. Time when this SKU was last updated.
config

SkuConfig

Output only. Configuration for this SKU.
instances[]

SkuInstance

Output only. Available instances of this SKU. This field should be used for checking availability of a SKU.
description

string

Output only. Description of this SKU.
revision_id

string

Output only. The SKU revision ID. A new revision is created whenever config is updated. The format is an 8-character hexadecimal string.
is_active

bool

Output only. Flag to indicate whether or not this revision is active. Only an active revision can be used in a new Order.
type

Type

Output only. Type of this SKU.
vcpu_count

int32

Output only. The vCPU count associated with this SKU.

Type

Valid types of a SKU.

Enums
TYPE_UNSPECIFIED Type of the SKU is unspecified. This is not an allowed value.
RACK Rack SKU.
SERVER Server SKU.

SkuConfig

Configuration for a SKU.

Fields
cpu

string

Information about CPU configuration.
gpu

string

Information about GPU configuration.
ram

string

Information about RAM configuration.
storage

string

Information about storage configuration.

SkuInstance

A specific instance of the SKU.

Fields
region_code

string

The Unicode CLDR region code where this instance is available.
power_supply

PowerSupply

Power supply type for this instance.
billing_sku

string

Reference to the corresponding SKU in the Cloud Billing API. The estimated price information can be retrieved using that API. Format: services/{service}/skus/{sku}
billing_sku_per_vcpu

string

Reference to the corresponding SKU per vCPU in the Cloud Billing API. The estimated price information can be retrieved using that API. Format: services/{service}/skus/{sku}
subscription_duration_months

int32

Subscription duration for the hardware in months.

SubmitOrderRequest

A request to submit an order.

Fields
name

string

Required. The name of the order. Format: projects/{project}/locations/{location}/orders/{order}
request_id

string

Optional. An optional unique identifier for this request. See AIP-155.

Subnet

Represents a subnet.

Fields
address_range

string

Required. Address range for this subnet in CIDR notation.
default_gateway_ip_address

string

Required. Default gateway for this subnet.

TimePeriod

Represents a time period in a week.

Fields
start_time

TimeOfDay

Required. The start of the time period.
end_time

TimeOfDay

Required. The end of the time period.
days[]

DayOfWeek

Required. The days of the week that the time period is active.

UpdateHardwareGroupRequest

A request to update a hardware group.

Fields
update_mask

FieldMask

Required. A mask to specify the fields in the HardwareGroup to overwrite with this update. The fields specified in the update_mask are relative to the hardware group, not the full request. A field will be overwritten if it is in the mask. If you don't provide a mask then all fields will be overwritten.
hardware_group

HardwareGroup

Required. The hardware group to update.
request_id

string

Optional. An optional unique identifier for this request. See AIP-155.

UpdateHardwareRequest

A request to update hardware.

Fields
update_mask

FieldMask

Required. A mask to specify the fields in the Hardware to overwrite with this update. The fields specified in the update_mask are relative to the hardware, not the full request. A field will be overwritten if it is in the mask. If you don't provide a mask then all fields will be overwritten.
hardware

Hardware

Required. The hardware to update.
request_id

string

Optional. An optional unique identifier for this request. See AIP-155.

UpdateOrderRequest

A request to update an order.

Fields
update_mask

FieldMask

Required. A mask to specify the fields in the Order to overwrite with this update. The fields specified in the update_mask are relative to the order, not the full request. A field will be overwritten if it is in the mask. If you don't provide a mask then all fields will be overwritten.
order

Order

Required. The order to update.
request_id

string

Optional. An optional unique identifier for this request. See AIP-155.

UpdateSiteRequest

A request to update a site.

Fields
update_mask

FieldMask

Required. A mask to specify the fields in the Site to overwrite with this update. The fields specified in the update_mask are relative to the site, not the full request. A field will be overwritten if it is in the mask. If you don't provide a mask then all fields will be overwritten.
site

Site

Required. The site to update.
request_id

string

Optional. An optional unique identifier for this request. See AIP-155.

UpdateZoneRequest

A request to update a zone.

Fields
update_mask

FieldMask

Required. A mask to specify the fields in the Zone to overwrite with this update. The fields specified in the update_mask are relative to the zone, not the full request. A field will be overwritten if it is in the mask. If you don't provide a mask then all fields will be overwritten.
zone

Zone

Required. The zone to update.
request_id

string

Optional. An optional unique identifier for this request. See AIP-155.

Zone

A zone holding a set of hardware.

Fields
name

string

Identifier. Name of this zone. Format: projects/{project}/locations/{location}/zones/{zone}
create_time

Timestamp

Output only. Time when this zone was created.
update_time

Timestamp

Output only. Time when this zone was last updated.
labels

map<string, string>

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

string

Optional. Human friendly display name of this zone.
state

State

Output only. Current state for this zone.
contacts[]

Contact

Required. The points of contact.
ciq_uri

string

Output only. Link to the Customer Intake Questionnaire (CIQ) sheet for this zone.
network_config

ZoneNetworkConfig

Optional. Networking configuration for this zone.

State

Valid states for a zone.

Enums
STATE_UNSPECIFIED State of the Zone is unspecified.
ADDITIONAL_INFO_NEEDED More information is required from the customer to make progress.
PREPARING Google is preparing the Zone.
ACTIVE The Zone is available to use.
CANCELLED The Zone has been cancelled.

ZoneNetworkConfig

Networking configuration for a zone.

Fields
machine_mgmt_ipv4_range

string

Required. An IPv4 address block for machine management. Should be a private RFC1918 or public CIDR block large enough to allocate at least one address per machine in the Zone. Should be in management_ipv4_subnet, and disjoint with other address ranges.
kubernetes_node_ipv4_range

string

Required. An IPv4 address block for kubernetes nodes. Should be a private RFC1918 or public CIDR block large enough to allocate at least one address per machine in the Zone. Should be in kubernetes_ipv4_subnet, and disjoint with other address ranges.
kubernetes_control_plane_ipv4_range

string

Required. An IPv4 address block for kubernetes control plane. Should be a private RFC1918 or public CIDR block large enough to allocate at least one address per cluster in the Zone. Should be in kubernetes_ipv4_subnet, and disjoint with other address ranges.
management_ipv4_subnet

Subnet

Required. An IPv4 subnet for the management network.
kubernetes_ipv4_subnet

Subnet

Optional. An IPv4 subnet for the kubernetes network. If unspecified, the kubernetes subnet will be the same as the management subnet.