region_health_aggregation_policies

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

Overview

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

Fields

The following fields are returned by SELECT queries:

get
list
aggregated_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. 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 HealthAggregationPolicy. An up-to-date fingerprint must be provided in order to patch the HealthAggregationPolicy; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthAggregationPolicy.
`healthyPercentThreshold`	`integer (uint32)`	Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the threshold (as a percentage) of healthy endpoints required in order to consider the aggregated health result HEALTHY. Defaults to 60. Must be in range [0, 100]. Not applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional, and will be set to the default if unspecified. Note that both this threshold and minHealthyThreshold must be satisfied in order for HEALTHY to be the aggregated result. "Endpoints" refers to network endpoints within a Network Endpoint Group or instances within an Instance Group.
`kind`	`string`	Output only. [Output Only] Type of the resource. Alwayscompute#healthAggregationPolicy for health aggregation policies. (default: compute#healthAggregationPolicy)
`minHealthyThreshold`	`integer (uint32)`	Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the minimum number of healthy endpoints required in order to consider the aggregated health result HEALTHY. Defaults to 1. Must be positive. Not applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional, and will be set to the default if unspecified. Note that both this threshold and healthyPercentThreshold must be satisfied in order for HEALTHY to be the aggregated result. "Endpoints" refers to network endpoints within a Network Endpoint Group or instances within an Instance Group.
`policyType`	`string`	Specifies the type of the healthAggregationPolicy. The only allowed value for global resources is DNS_PUBLIC_IP_POLICY. The only allowed value for regional resources is BACKEND_SERVICE_POLICY. Must be specified when the healthAggregationPolicy is created, and cannot be mutated. (BACKEND_SERVICE_POLICY, DNS_PUBLIC_IP_POLICY)
`region`	`string`	Output only. [Output Only] URL of the region where the health aggregation policy 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.

Name	Datatype	Description
`id`	`string`	[Output Only] Unique identifier for the resource; defined by the server.
`items`	`array`	A list of HealthAggregationPolicy resources.
`kind`	`string`	Output only. [Output Only] Type of the resource. Alwayscompute#healthAggregationPolicy for health aggregation policies. (default: compute#healthAggregationPolicyList)
`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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`project`, `region`, `healthAggregationPolicy`		Returns the specified HealthAggregationPolicy resource in the given region.
`list`	`select`	`project`, `region`	`maxResults`, `pageToken`, `filter`, `orderBy`, `returnPartialSuccess`	Lists the HealthAggregationPolicies for a project in the given region.
`aggregated_list`	`select`	`project`	`includeAllScopes`, `orderBy`, `maxResults`, `pageToken`, `filter`, `serviceProjectNumber`, `returnPartialSuccess`	Retrieves the list of all HealthAggregationPolicy resources, regional and global, 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 HealthAggregationPolicy in the specified project in the given region using the parameters that are included in the request.
`patch`	`update`	`project`, `region`, `healthAggregationPolicy`	`requestId`	Updates the specified regional HealthAggregationPolicy 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`, `healthAggregationPolicy`	`requestId`	Deletes the specified HealthAggregationPolicy 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
`healthAggregationPolicy`	`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
list
aggregated_list

Returns the specified HealthAggregationPolicy resource in the given region.

SELECT
id,
name,
creationTimestamp,
description,
fingerprint,
healthyPercentThreshold,
kind,
minHealthyThreshold,
policyType,
region,
selfLink,
selfLinkWithId
FROM google.compute.region_health_aggregation_policies
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND healthAggregationPolicy = '{{ healthAggregationPolicy }}' -- required
;

Lists the HealthAggregationPolicies for a project in the given region.

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

Retrieves the list of all HealthAggregationPolicy resources,
regional and global, available to the specified project.

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

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

`INSERT` examples

insert
Manifest

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

INSERT INTO google.compute.region_health_aggregation_policies (
data__name,
data__healthyPercentThreshold,
data__fingerprint,
data__description,
data__minHealthyThreshold,
data__policyType,
project,
region,
requestId
)
SELECT 
'{{ name }}',
{{ healthyPercentThreshold }},
'{{ fingerprint }}',
'{{ description }}',
{{ minHealthyThreshold }},
'{{ policyType }}',
'{{ 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: region_health_aggregation_policies
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the region_health_aggregation_policies resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the region_health_aggregation_policies resource.
  - 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: healthyPercentThreshold
    value: {{ healthyPercentThreshold }}
    description: |
      Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the threshold (as a
      percentage) of healthy endpoints required in order to consider the
      aggregated health result HEALTHY. Defaults to 60. Must be in
      range [0, 100]. Not applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional,
      and will be set to the default if unspecified. Note that both this
      threshold and minHealthyThreshold must be satisfied in order
      for HEALTHY to be the aggregated result. "Endpoints" refers to network
      endpoints within a Network Endpoint Group or instances within an Instance
      Group.
  - 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 HealthAggregationPolicy. An up-to-date fingerprint
      must be provided in order to patch the HealthAggregationPolicy; Otherwise,
      the request will fail with error 412 conditionNotMet. To see
      the latest fingerprint, make a get() request to retrieve the
      HealthAggregationPolicy.
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of this resource. Provide this property when you
      create the resource.
  - name: minHealthyThreshold
    value: {{ minHealthyThreshold }}
    description: |
      Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the minimum number of
      healthy endpoints required in order to consider the aggregated health
      result HEALTHY. Defaults to 1. Must be positive. Not
      applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional,
      and will be set to the default if unspecified. Note that both this
      threshold and healthyPercentThreshold must be satisfied in
      order for HEALTHY to be the aggregated result. "Endpoints" refers to
      network endpoints within a Network Endpoint Group or instances within an
      Instance Group.
  - name: policyType
    value: "{{ policyType }}"
    description: |
      Specifies the type of the healthAggregationPolicy. The only allowed value
      for global resources is DNS_PUBLIC_IP_POLICY. The only allowed
      value for regional resources is BACKEND_SERVICE_POLICY. Must
      be specified when the healthAggregationPolicy is created, and cannot be
      mutated.
    valid_values: ['BACKEND_SERVICE_POLICY', 'DNS_PUBLIC_IP_POLICY']
  - name: requestId
    value: "{{ requestId }}"

`UPDATE` examples

patch

Updates the specified regional HealthAggregationPolicy
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_health_aggregation_policies
SET 
data__name = '{{ name }}',
data__healthyPercentThreshold = {{ healthyPercentThreshold }},
data__fingerprint = '{{ fingerprint }}',
data__description = '{{ description }}',
data__minHealthyThreshold = {{ minHealthyThreshold }},
data__policyType = '{{ policyType }}'
WHERE 
project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND healthAggregationPolicy = '{{ healthAggregationPolicy }}' --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 HealthAggregationPolicy in the given region.

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

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​