https_health_checks

Creates, updates, deletes, gets or lists a https_health_checks resource.

Overview

Name	https_health_checks
Type	Resource
Id	google.compute.https_health_checks

Fields

Name	Datatype	Description
id	string	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
name	string	Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
description	string	An optional description of this resource. Provide this property when you create the resource.
checkIntervalSec	integer	How often (in seconds) to send a health check. The default value is 5 seconds.
creationTimestamp	string	[Output Only] Creation timestamp in RFC3339 text format.
healthyThreshold	integer	A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
host	string	The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
kind	string	Type of the resource.
port	integer	The TCP port number for the HTTPS health check request. The default value is 443.
requestPath	string	The request path of the HTTPS health check request. The default value is "/". Must comply with RFC3986.
selfLink	string	[Output Only] Server-defined URL for the resource.
timeoutSec	integer	How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
unhealthyThreshold	integer	A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	httpsHealthCheck, project	Returns the specified HttpsHealthCheck resource.
list	SELECT	project	Retrieves the list of HttpsHealthCheck resources available to the specified project.
insert	INSERT	project	Creates a HttpsHealthCheck resource in the specified project using the data included in the request.
delete	DELETE	httpsHealthCheck, project	Deletes the specified HttpsHealthCheck resource.
patch	UPDATE	httpsHealthCheck, project	Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
update	REPLACE	httpsHealthCheck, project	Updates a HttpsHealthCheck resource in the specified project using the data included in the request.

SELECT examples

Retrieves the list of HttpsHealthCheck resources available to the specified project.

SELECT
id,
name,
description,
checkIntervalSec,
creationTimestamp,
healthyThreshold,
host,
kind,
port,
requestPath,
selfLink,
timeoutSec,
unhealthyThreshold
FROM google.compute.https_health_checks
WHERE project = '{{ project }}';

INSERT example

Use the following StackQL query and manifest file to create a new https_health_checks resource.

All Properties

/*+ create */
INSERT INTO google.compute.https_health_checks (
project,
name,
description,
host,
requestPath,
port,
checkIntervalSec,
timeoutSec,
unhealthyThreshold,
healthyThreshold
)
SELECT 
'{{ project }}',
'{{ name }}',
'{{ description }}',
'{{ host }}',
'{{ requestPath }}',
'{{ port }}',
'{{ checkIntervalSec }}',
'{{ timeoutSec }}',
'{{ unhealthyThreshold }}',
'{{ healthyThreshold }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: kind
      value: string
    - name: id
      value: string
    - name: creationTimestamp
      value: string
    - name: name
      value: string
    - name: description
      value: string
    - name: host
      value: string
    - name: requestPath
      value: string
    - name: port
      value: integer
    - name: checkIntervalSec
      value: integer
    - name: timeoutSec
      value: integer
    - name: unhealthyThreshold
      value: integer
    - name: healthyThreshold
      value: integer
    - name: selfLink
      value: string

UPDATE example

Updates a https_health_checks resource.

/*+ update */
UPDATE google.compute.https_health_checks
SET 
name = '{{ name }}',
description = '{{ description }}',
host = '{{ host }}',
requestPath = '{{ requestPath }}',
port = '{{ port }}',
checkIntervalSec = '{{ checkIntervalSec }}',
timeoutSec = '{{ timeoutSec }}',
unhealthyThreshold = '{{ unhealthyThreshold }}',
healthyThreshold = '{{ healthyThreshold }}'
WHERE 
httpsHealthCheck = '{{ httpsHealthCheck }}'
AND project = '{{ project }}';

REPLACE example

Replaces all fields in the specified https_health_checks resource.

/*+ update */
REPLACE google.compute.https_health_checks
SET 
name = '{{ name }}',
description = '{{ description }}',
host = '{{ host }}',
requestPath = '{{ requestPath }}',
port = '{{ port }}',
checkIntervalSec = '{{ checkIntervalSec }}',
timeoutSec = '{{ timeoutSec }}',
unhealthyThreshold = '{{ unhealthyThreshold }}',
healthyThreshold = '{{ healthyThreshold }}'
WHERE 
httpsHealthCheck = '{{ httpsHealthCheck }}'
AND project = '{{ project }}';

DELETE example

Deletes the specified https_health_checks resource.

/*+ delete */
DELETE FROM google.compute.https_health_checks
WHERE httpsHealthCheck = '{{ httpsHealthCheck }}'
AND project = '{{ project }}';