region_composite_health_checks

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

Overview

Name	region_composite_health_checks
Type	Resource
Id	google.compute.region_composite_health_checks

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (uint64)	Output only. [Output Only] A unique identifier for this resource type. The server generates this identifier.
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 withRFC1035. 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 CompositeHealthCheck. An up-to-date fingerprint must be provided in order to patch the CompositeHealthCheck; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the CompositeHealthCheck.
healthDestination	string	URL to the destination resource. Must be set. Must be aForwardingRule. The ForwardingRule must have load balancing scheme INTERNAL orINTERNAL_MANAGED and must be regional and in the same region as the CompositeHealthCheck (cross-region deployment forINTERNAL_MANAGED is not supported). Can be mutated.
healthSources	array	URLs to the HealthSource resources whose results are AND'ed. I.e. he aggregated result is is HEALTHY only if all sources are HEALTHY. Must have at least 1. Must not have more than 10. Must be regional and in the same region as theCompositeHealthCheck. Can be mutated.
kind	string	Output only. [Output Only] Type of the resource. Alwayscompute#compositeHealthCheck for composite health checks. (default: compute#compositeHealthCheck)
region	string	Output only. [Output Only] URL of the region where the composite health check resides. This field applies only to the regional resource. 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.
selfLinkWithId	string	Output only. [Output Only] Server-defined URL with id for the resource.

list

Name	Datatype	Description
id	string	[Output Only] Unique identifier for the resource; defined by the server.
items	array	A list of CompositeHealthCheck resources.
kind	string	Output only. [Output Only] Type of the resource. Alwayscompute#compositeHealthCheck for composite health checks. (default: compute#compositeHealthCheckList)
nextPageToken	string	[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] Server-defined URL for this resource.
warning	object	[Output Only] Informational warning message.

aggregated_list

Name	Datatype	Description

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, region, compositeHealthCheck		Returns the specified CompositeHealthCheck resource in the given region.
list	select	project, region	returnPartialSuccess, filter, maxResults, pageToken, orderBy	Lists the CompositeHealthChecks for a project in the given region.
aggregated_list	select	project	returnPartialSuccess, maxResults, pageToken, filter, serviceProjectNumber, includeAllScopes, orderBy	Retrieves the list of all CompositeHealthCheck resources (all regional) available to the specified project. To prevent failure, it is recommended that you set the returnPartialSuccess parameter to true.
insert	insert	project, region	requestId	Create a CompositeHealthCheck in the specified project in the given region using the parameters that are included in the request.
patch	update	project, region, compositeHealthCheck	requestId	Updates the specified regional CompositeHealthCheck 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, compositeHealthCheck	requestId	Deletes the specified CompositeHealthCheck in the given region

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
compositeHealthCheck	string
project	string
region	string
filter	string
includeAllScopes	boolean
maxResults	integer (uint32)
orderBy	string
pageToken	string
requestId	string
returnPartialSuccess	boolean
serviceProjectNumber	string (int64)

SELECT examples

get

Returns the specified CompositeHealthCheck resource in the given region.

SELECT
id,
name,
creationTimestamp,
description,
fingerprint,
healthDestination,
healthSources,
kind,
region,
selfLink,
selfLinkWithId
FROM google.compute.region_composite_health_checks
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND compositeHealthCheck = '{{ compositeHealthCheck }}' -- required
;

list

Lists the CompositeHealthChecks for a project in the given region.

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

aggregated_list

Retrieves the list of all CompositeHealthCheck resources (all
regional) available to the specified project.

To prevent failure, it is recommended that you set the
returnPartialSuccess parameter to true.

SELECT
*
FROM google.compute.region_composite_health_checks
WHERE project = '{{ project }}' -- required
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND serviceProjectNumber = '{{ serviceProjectNumber }}'
AND includeAllScopes = '{{ includeAllScopes }}'
AND orderBy = '{{ orderBy }}'
;

INSERT examples

insert

Create a CompositeHealthCheck in the specified project in the given region
using the parameters that are included in the request.

INSERT INTO google.compute.region_composite_health_checks (
data__fingerprint,
data__name,
data__healthDestination,
data__description,
data__healthSources,
project,
region,
requestId
)
SELECT 
'{{ fingerprint }}',
'{{ name }}',
'{{ healthDestination }}',
'{{ description }}',
'{{ healthSources }}',
'{{ 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
;

Manifest

# Description fields are for documentation purposes
- name: region_composite_health_checks
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the region_composite_health_checks resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the region_composite_health_checks resource.
  - 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 CompositeHealthCheck. An up-to-date fingerprint
      must be provided in order to patch the CompositeHealthCheck; Otherwise,
      the request will fail with error 412 conditionNotMet. To see
      the latest fingerprint, make a get() request to retrieve the
      CompositeHealthCheck.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource. Provided by the client when the resource is created.
      The name must be 1-63 characters long, and comply withRFC1035.
      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: healthDestination
    value: "{{ healthDestination }}"
    description: |
      URL to the destination resource. Must be set. Must be aForwardingRule. The ForwardingRule must have
      load balancing scheme INTERNAL orINTERNAL_MANAGED and must be regional and in the same region
      as the CompositeHealthCheck (cross-region deployment forINTERNAL_MANAGED is not supported). Can be mutated.
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of this resource. Provide this property when you
      create the resource.
  - name: healthSources
    value:
      - "{{ healthSources }}"
    description: |
      URLs to the HealthSource resources whose results are AND'ed.
      I.e. he aggregated result is is HEALTHY only if all sources
      are HEALTHY. Must have at least 1. Must not have more than 10.
      Must be regional and in the same region as theCompositeHealthCheck. Can be mutated.
  - name: requestId
    value: "{{ requestId }}"

UPDATE examples

patch

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

UPDATE google.compute.region_composite_health_checks
SET 
data__fingerprint = '{{ fingerprint }}',
data__name = '{{ name }}',
data__healthDestination = '{{ healthDestination }}',
data__description = '{{ description }}',
data__healthSources = '{{ healthSources }}'
WHERE 
project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND compositeHealthCheck = '{{ compositeHealthCheck }}' --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 CompositeHealthCheck in the given region

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