SettingsCheckStatus

The CheckStatus structure contains fields that describe a check result.


Properties

check Required

Information about this check.


errors Optional

List of CheckError that the check reported. If not set, the service is still using the {#member issues}. TODO


string
originator Optional

The service that performed the check. This field should allow easier triaging of health query errors. Only set if there is an originator available for this check.


status Required

The Status enumerated type defines the status result for a particular check.
OK : The check indicates a success.
WARNING : The check indicates a warning.
TIMEOUT : The check did not return in a timely manner.
ERROR : The check indicates an error.
RETRY : The check failed because of an intermittent error, for example a service is overloaded. The client can choose to retry the health check before considering the check as failed.

Possible values are: OKWARNINGTIMEOUTERRORRETRY

JSON Example

{
	"check": {
		"check": "string",
		"description": {
			"args": [
				"string"
			],
			"default_message": "string",
			"id": "string"
		},
		"name": {
			"args": [
				"string"
			],
			"default_message": "string",
			"id": "string"
		}
	},
	"status": "OK"
}

Feedback

Was this page helpful?