Method: projects.locations.hardware.signal

Signals the state of a hardware.

HTTP request

POST https://gdchardwaremanagement.googleapis.com/v1alpha/{name=projects/*/locations/*/hardware/*}:signal

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

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

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requestId": string,
  "stateSignal": enum (StateSignal),
  "operationType": enum (Type),
  "reTurnupRequired": boolean
}
Fields
requestId

string

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

enum (StateSignal)

Optional. Specifies the state signal to send for this hardware.
operationType

enum (Type)

Optional. Specifies the operation type to signal the state for. If the type is not specified, the signal is assumed to be for the initial provisioning.
reTurnupRequired

boolean

Optional. Indicates whether a re-turnup is needed when finalizing a repair process.

Response body

If successful, the response body contains an instance of Operation.

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.

StateSignal

Valid state signals for a hardware.

Enums
STATE_SIGNAL_UNSPECIFIED State signal of the hardware is unspecified.
READY_FOR_PROVISIONING Hardware is ready for provisioning.