health_check_services

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

Overview

Name	`health_check_services`
Type	Resource
Id	`google.compute.health_check_services`

Fields

The following fields are returned by SELECT queries:

get
list

Name	Datatype	Description
`id`	`string (uint64)`	Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`name`	`string`	Name of the resource. 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. (pattern: `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`)
`creationTimestamp`	`string`	Output only. [Output Only] Creation timestamp inRFC3339 text format.
`description`	`string`	An optional description of this resource. Provide this property when you create the resource.
`fingerprint`	`string (byte)`	Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService.
`healthChecks`	`array`	A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10 for regionalHealthCheckService, and not more than 1 for globalHealthCheckService.HealthCheck resources must haveportSpecification=USE_SERVING_PORT orportSpecification=USE_FIXED_PORT. For regional HealthCheckService, theHealthCheck must be regional and in the same region. For global HealthCheckService,HealthCheck must be global. Mix of regional and globalHealthChecks is not supported. Multiple regionalHealthChecks must belong to the same region. RegionalHealthChecks must belong to the same region as zones ofNetworkEndpointGroups. For globalHealthCheckService using globalINTERNET_IP_PORT NetworkEndpointGroups, the global HealthChecks must specify sourceRegions, and HealthChecks that specify sourceRegions can only be used with global INTERNET_IP_PORTNetworkEndpointGroups.
`healthStatusAggregationPolicy`	`string`	Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each pair in the health check service. - AND. If any health check of an endpoint reportsUNHEALTHY, then UNHEALTHY is theHealthState of the endpoint. If all health checks reportHEALTHY, the HealthState of the endpoint isHEALTHY. . This is only allowed with regional HealthCheckService. (AND, NO_AGGREGATION)
`kind`	`string`	Output only. [Output only] Type of the resource. Alwayscompute#healthCheckServicefor health check services. (default: compute#healthCheckService)
`networkEndpointGroups`	`array`	A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regionalHealthCheckService, NEGs must be in zones in the region of the HealthCheckService. For globalHealthCheckServices, the NetworkEndpointGroups must be global INTERNET_IP_PORT.
`notificationEndpoints`	`array`	A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regionalHealthCheckService,NotificationEndpoint must be regional and in the same region. For global HealthCheckService,NotificationEndpoint must be global.
`region`	`string`	Output only. [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
`selfLink`	`string`	Output only. [Output Only] Server-defined URL for the resource.

Name	Datatype	Description
`id`	`string`	Output only. [Output Only] Unique identifier for the resource; defined by the server.
`items`	`array`	Output only. A list of HealthCheckService resources.
`kind`	`string`	Output only. [Output Only] Type of the resource. Alwayscompute#healthCheckServicesList for lists of HealthCheckServices. (default: compute#healthCheckServicesList)
`nextPageToken`	`string`	Output only. [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
`selfLink`	`string`	Output only. [Output Only] Server-defined URL for this resource.
`warning`	`object`	[Output Only] Informational warning message.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`project`, `region`, `healthCheckService`		Returns the specified regional HealthCheckService resource.
`list`	`select`	`project`, `region`	`orderBy`, `filter`, `maxResults`, `pageToken`, `returnPartialSuccess`	Lists all the HealthCheckService resources that have been configured for the specified project in the given region.
`insert`	`insert`	`project`, `region`	`requestId`	Creates a regional HealthCheckService resource in the specified project and region using the data included in the request.
`patch`	`update`	`project`, `region`, `healthCheckService`	`requestId`	Updates the specified regional HealthCheckService resource with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.
`delete`	`delete`	`project`, `region`, `healthCheckService`	`requestId`	Deletes the specified regional HealthCheckService.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`healthCheckService`	`string`
`project`	`string`
`region`	`string`
`filter`	`string`
`maxResults`	`integer (uint32)`
`orderBy`	`string`
`pageToken`	`string`
`requestId`	`string`
`returnPartialSuccess`	`boolean`

`SELECT` examples

get
list

Returns the specified regional HealthCheckService resource.

SELECT
id,
name,
creationTimestamp,
description,
fingerprint,
healthChecks,
healthStatusAggregationPolicy,
kind,
networkEndpointGroups,
notificationEndpoints,
region,
selfLink
FROM google.compute.health_check_services
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND healthCheckService = '{{ healthCheckService }}' -- required
;

Lists all the HealthCheckService resources that have been
configured for the specified project in the given region.

SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.health_check_services
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
;

`INSERT` examples

insert
Manifest

Creates a regional HealthCheckService resource in the
specified project and region using the data included in the request.

INSERT INTO google.compute.health_check_services (
data__healthStatusAggregationPolicy,
data__healthChecks,
data__description,
data__networkEndpointGroups,
data__fingerprint,
data__name,
data__notificationEndpoints,
project,
region,
requestId
)
SELECT 
'{{ healthStatusAggregationPolicy }}',
'{{ healthChecks }}',
'{{ description }}',
'{{ networkEndpointGroups }}',
'{{ fingerprint }}',
'{{ name }}',
'{{ notificationEndpoints }}',
'{{ project }}',
'{{ region }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

# Description fields are for documentation purposes
- name: health_check_services
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the health_check_services resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the health_check_services resource.
  - name: healthStatusAggregationPolicy
    value: "{{ healthStatusAggregationPolicy }}"
    description: |
      Optional. Policy for how the results from multiple health checks
      for the same endpoint are aggregated. Defaults to NO_AGGREGATION
      if unspecified.
      - NO_AGGREGATION. An EndpointHealth message is
      returned for each  pair in the health check
      service.
      - AND. If any health check of an endpoint reportsUNHEALTHY, then UNHEALTHY is theHealthState of the endpoint. If all health checks reportHEALTHY, the HealthState of the endpoint isHEALTHY.
      .
      This is only allowed with regional HealthCheckService.
    valid_values: ['AND', 'NO_AGGREGATION']
  - name: healthChecks
    value:
      - "{{ healthChecks }}"
    description: |
      A list of URLs to the HealthCheck resources. Must have
      at least one HealthCheck, and not more than 10 for regionalHealthCheckService, and not more than 1 for globalHealthCheckService.HealthCheck resources must haveportSpecification=USE_SERVING_PORT orportSpecification=USE_FIXED_PORT. For
      regional HealthCheckService, theHealthCheck must be regional and in the same
      region. For global HealthCheckService,HealthCheck must be global. Mix of regional and globalHealthChecks is not supported. Multiple regionalHealthChecks must belong to the same region. RegionalHealthChecks must belong to the same region as zones ofNetworkEndpointGroups. For globalHealthCheckService using globalINTERNET_IP_PORT NetworkEndpointGroups, the
      global HealthChecks must specify sourceRegions,
      and HealthChecks that specify sourceRegions can
      only be used with global INTERNET_IP_PORTNetworkEndpointGroups.
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of this resource. Provide this property when you
      create the resource.
  - name: networkEndpointGroups
    value:
      - "{{ networkEndpointGroups }}"
    description: |
      A list of URLs to the NetworkEndpointGroup
      resources. Must not have more than 100.  For regionalHealthCheckService, NEGs must be in
      zones in the region of the HealthCheckService. For globalHealthCheckServices, the NetworkEndpointGroups
      must be global INTERNET_IP_PORT.
  - name: fingerprint
    value: "{{ fingerprint }}"
    description: |
      Fingerprint of this resource. A hash of the contents stored in this object.
      This field is used in optimistic locking. This field will be ignored when
      inserting a HealthCheckService. An up-to-date fingerprint must
      be provided in order to patch/update the HealthCheckService; Otherwise, the
      request will fail with error 412 conditionNotMet. To see the
      latest fingerprint, make a get() request to retrieve the
      HealthCheckService.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource. 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.
  - name: notificationEndpoints
    value:
      - "{{ notificationEndpoints }}"
    description: |
      A list of URLs to the NotificationEndpoint
      resources. Must not have more than 10.  A list of endpoints for
      receiving notifications of change in health status. For regionalHealthCheckService,NotificationEndpoint must be regional and in the
      same region. For global HealthCheckService,NotificationEndpoint must be global.
  - name: requestId
    value: "{{ requestId }}"

`UPDATE` examples

patch

Updates the specified regional HealthCheckService resource
with the data included in the request. This method supportsPATCH
semantics and uses theJSON merge
patch format and processing rules.

UPDATE google.compute.health_check_services
SET 
data__healthStatusAggregationPolicy = '{{ healthStatusAggregationPolicy }}',
data__healthChecks = '{{ healthChecks }}',
data__description = '{{ description }}',
data__networkEndpointGroups = '{{ networkEndpointGroups }}',
data__fingerprint = '{{ fingerprint }}',
data__name = '{{ name }}',
data__notificationEndpoints = '{{ notificationEndpoints }}'
WHERE 
project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND healthCheckService = '{{ healthCheckService }}' --required
AND requestId = '{{ requestId}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;

`DELETE` examples

delete

Deletes the specified regional HealthCheckService.

DELETE FROM google.compute.health_check_services
WHERE project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND healthCheckService = '{{ healthCheckService }}' --required
AND requestId = '{{ requestId }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​