region_health_sources

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

Overview

Name	region_health_sources
Type	Resource
Id	google.compute.region_health_sources

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 HealthSource. An up-to-date fingerprint must be provided in order to patch the HealthSource; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthSource.
healthAggregationPolicy	string	URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.
kind	string	Output only. [Output Only] Type of the resource. Alwayscompute#healthSource for health sources. (default: compute#healthSource)
region	string	Output only. [Output Only] URL of the region where the health source 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.
sourceType	string	Specifies the type of the HealthSource. The only allowed value is BACKEND_SERVICE. Must be specified when theHealthSource is created, and cannot be mutated. (BACKEND_SERVICE)
sources	array	URLs to the source resources. Must be size 1. Must be aBackendService if the sourceType is BACKEND_SERVICE. TheBackendService must have load balancing schemeINTERNAL or INTERNAL_MANAGED and must be regional and in the same region as the HealthSource (cross-region deployment for INTERNAL_MANAGED is not supported). TheBackendService may use only IGs, MIGs, or NEGs of typeGCE_VM_IP or GCE_VM_IP_PORT. TheBackendService may not use haPolicy. Can be mutated.

list

Name	Datatype	Description
id	string	[Output Only] Unique identifier for the resource; defined by the server.
items	array	A list of HealthSource resources.
kind	string	Output only. [Output Only] Type of the resource. Alwayscompute#healthSource for health sources. (default: compute#healthSourceList)
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, healthSource		Returns the specified HealthSource resource in the given region.
list	select	project, region	filter, maxResults, pageToken, orderBy, returnPartialSuccess	Lists the HealthSources for a project in the given region.
aggregated_list	select	project	returnPartialSuccess, includeAllScopes, orderBy, filter, serviceProjectNumber, maxResults, pageToken	Retrieves the list of all HealthSource resources (all regional) available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.
insert	insert	project, region	requestId	Create a HealthSource in the specified project in the given region using the parameters that are included in the request.
patch	update	project, region, healthSource	requestId	Updates the specified regional HealthSource 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, healthSource	requestId	Deletes the specified HealthSource 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
healthSource	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 HealthSource resource in the given region.

SELECT
id,
name,
creationTimestamp,
description,
fingerprint,
healthAggregationPolicy,
kind,
region,
selfLink,
selfLinkWithId,
sourceType,
sources
FROM google.compute.region_health_sources
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND healthSource = '{{ healthSource }}' -- required
;

list

Lists the HealthSources for a project in the given region.

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

aggregated_list

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

To prevent failure, Google recommends that you set the
returnPartialSuccess parameter to true.

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

INSERT examples

insert

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

INSERT INTO google.compute.region_health_sources (
data__fingerprint,
data__name,
data__healthAggregationPolicy,
data__description,
data__sourceType,
data__sources,
project,
region,
requestId
)
SELECT 
'{{ fingerprint }}',
'{{ name }}',
'{{ healthAggregationPolicy }}',
'{{ description }}',
'{{ sourceType }}',
'{{ sources }}',
'{{ 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_health_sources
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the region_health_sources resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the region_health_sources 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 HealthSource. An up-to-date fingerprint
      must be provided in order to patch the HealthSource; Otherwise, the request
      will fail with error 412 conditionNotMet. To see the latest
      fingerprint, make a get() request to retrieve the
      HealthSource.
  - 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: healthAggregationPolicy
    value: "{{ healthAggregationPolicy }}"
    description: |
      URL to the HealthAggregationPolicy resource. Must be set. Must
      be regional and in the same region as the HealthSource. Can be
      mutated.
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of this resource. Provide this property when you
      create the resource.
  - name: sourceType
    value: "{{ sourceType }}"
    description: |
      Specifies the type of the HealthSource. The only allowed value
      is BACKEND_SERVICE. Must be specified when theHealthSource is created, and cannot be mutated.
    valid_values: ['BACKEND_SERVICE']
  - name: sources
    value:
      - "{{ sources }}"
    description: |
      URLs to the source resources. Must be size 1. Must be aBackendService if
      the sourceType is BACKEND_SERVICE. TheBackendService must have load balancing schemeINTERNAL or INTERNAL_MANAGED and must be regional
      and in the same region as the HealthSource (cross-region
      deployment for INTERNAL_MANAGED is not supported). TheBackendService may use only IGs, MIGs, or NEGs of typeGCE_VM_IP or GCE_VM_IP_PORT. TheBackendService may not use haPolicy. Can be
      mutated.
  - name: requestId
    value: "{{ requestId }}"

UPDATE examples

patch

Updates the specified regional HealthSource 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_sources
SET 
data__fingerprint = '{{ fingerprint }}',
data__name = '{{ name }}',
data__healthAggregationPolicy = '{{ healthAggregationPolicy }}',
data__description = '{{ description }}',
data__sourceType = '{{ sourceType }}',
data__sources = '{{ sources }}'
WHERE 
project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND healthSource = '{{ healthSource }}' --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 HealthSource in the given region

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