Method: projects.locations.zones.signal

• HTTP request
• Path parameters
• Request body
  • JSON representation
• Response body
• Authorization scopes
• IAM Permissions
• StateSignal
• ProvisioningStateSignal
• Try it!

Signals the state of a zone.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

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

Request body

The request body contains data with the following structure:

JSON representation
{ "requestId": string, "stateSignal": enum (StateSignal), "provisioningStateSignal": enum (ProvisioningStateSignal), "step": string, "details": string }

Fields
requestId	string Optional. An optional unique identifier for this request. See AIP-155.
stateSignal	enum (StateSignal) Optional. The state signal to send for this zone. Either stateSignal or provisioningStateSignal must be set, but not both.
provisioningStateSignal	enum (ProvisioningStateSignal) Optional. The provisioning state signal to send for this zone. Either stateSignal or provisioningStateSignal must be set, but not both.
step	string Optional. The step being executed. Provides a finer grained status when the stateSignal is FACTORY_TURNUP_CHECKS_STARTED or FACTORY_TURNUP_CHECKS_FAILED.
details	string Optional. Additional details, such as an error message when stateSignal is FACTORY_TURNUP_CHECKS_FAILED.

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

For more information, see the IAM documentation.

StateSignal

Valid state signals for a zone.

Enums
STATE_SIGNAL_UNSPECIFIED	State signal of the zone is unspecified.
FACTORY_TURNUP_CHECKS_STARTED	Factory turnup checks have started.
FACTORY_TURNUP_CHECKS_PASSED	The Zone is ready for site turnup.
READY_FOR_SITE_TURNUP	The Zone is ready for site turnup. Deprecated, but not deleted. This item is deprecated!
FACTORY_TURNUP_CHECKS_FAILED	The Zone failed in factory turnup checks.
VERIFY_CLUSTER_INTENT_PRESENCE	Verify that a valid cluster intent is present.

ProvisioningStateSignal

Valid provisioning state signals for a zone.

Enums
PROVISIONING_STATE_SIGNAL_UNSPECIFIED	Provisioning state signal is unspecified.
PROVISIONING_IN_PROGRESS	Provisioning is in progress.
PROVISIONING_COMPLETE	Provisioning is complete.