Updates a HealthCheck 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.

Scopes

You will need authorization for at least one of the following scopes to make a valid call:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/compute

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: compute1 --scope <scope> region-health-checks patch ...

Required Scalar Arguments

  • <project> (string)
    • Project ID for this request.
  • <region> (string)
    • Name of the region scoping this request.
  • <health-check> (string)
    • Name of the HealthCheck resource to patch.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

HealthCheck:
  check-interval-sec: integer
  creation-timestamp: string
  description: string
  grpc-health-check:
    grpc-service-name: string
    port: integer
    port-name: string
    port-specification: string
  healthy-threshold: integer
  http2-health-check:
    host: string
    port: integer
    port-name: string
    port-specification: string
    proxy-header: string
    request-path: string
    response: string
  http-health-check:
    host: string
    port: integer
    port-name: string
    port-specification: string
    proxy-header: string
    request-path: string
    response: string
  https-health-check:
    host: string
    port: integer
    port-name: string
    port-specification: string
    proxy-header: string
    request-path: string
    response: string
  id: string
  kind: string
  log-config:
    enable: boolean
  name: string
  region: string
  self-link: string
  ssl-health-check:
    port: integer
    port-name: string
    port-specification: string
    proxy-header: string
    request: string
    response: string
  tcp-health-check:
    port: integer
    port-name: string
    port-specification: string
    proxy-header: string
    request: string
    response: string
  timeout-sec: integer
  type: string
  unhealthy-threshold: integer

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r . check-interval-sec=51
    • How often (in seconds) to send a health check. The default value is 5 seconds.
  • creation-timestamp=invidunt
    • [Output Only] Creation timestamp in 3339 text format.
  • description=gubergren
    • An optional description of this resource. Provide this property when you create the resource.
  • grpc-health-check grpc-service-name=sanctus
    • The gRPC service name for the health check. This field is optional. The value of grpc_service_name has the following meanings by convention: - Empty service_name means the overall status of all services at the backend. - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service. The grpc_service_name can only be ASCII.
  • port=15
    • The port number for the health check request. Must be specified if port_name and port_specification are not set or if port_specification is USE_FIXED_PORT. Valid values are 1 through 65535.
  • port-name=rebum.
    • Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. The port_name should conform to RFC1035.
  • port-specification=vero

    • Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, gRPC health check follows behavior specified in port and portName fields.
  • .. healthy-threshold=59

    • A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
  • http2-health-check host=lorem
    • The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
  • port=34
    • The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
  • port-name=lorem
    • Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
  • port-specification=duo
    • Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.
  • proxy-header=sadipscing
    • Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
  • request-path=justo
    • The request path of the HTTP/2 health check request. The default value is /.
  • response=eos

    • The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
  • ..http-health-check host=sadipscing

    • The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
  • port=0
    • The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
  • port-name=elitr
    • Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
  • port-specification=rebum.
    • Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP health check follows behavior specified in port and portName fields.
  • proxy-header=accusam
    • Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
  • request-path=consetetur
    • The request path of the HTTP health check request. The default value is /.
  • response=est

    • The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
  • ..https-health-check host=erat

    • The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
  • port=8
    • The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
  • port-name=sadipscing
    • Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
  • port-specification=aliquyam
    • Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTPS health check follows behavior specified in port and portName fields.
  • proxy-header=lorem
    • Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
  • request-path=amet
    • The request path of the HTTPS health check request. The default value is /.
  • response=ipsum

    • The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
  • .. id=ipsum

    • [Output Only] The unique identifier for the resource. This identifier is defined by the server.
  • kind=tempor
    • Type of the resource.
  • log-config enable=false

    • Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.
  • .. name=sit

    • 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. For example, a name that is 1-63 characters long, matches the regular expression [a-z]([-a-z0-9]*[a-z0-9])?, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash.
  • region=ea
    • [Output Only] Region where the health check resides. Not applicable to global health checks.
  • self-link=rebum.
    • [Output Only] Server-defined URL for the resource.
  • ssl-health-check port=38
    • The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
  • port-name=nonumy
    • Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
  • port-specification=amet
    • Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, SSL health check follows behavior specified in port and portName fields.
  • proxy-header=justo
    • Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
  • request=et
    • The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
  • response=eirmod

    • The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
  • ..tcp-health-check port=7

    • The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
  • port-name=diam
    • Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
  • port-specification=ipsum
    • Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, TCP health check follows behavior specified in port and portName fields.
  • proxy-header=nonumy
    • Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
  • request=ut
    • The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
  • response=dolor

    • The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
  • .. timeout-sec=38

    • How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
  • type=clita
    • Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. Exactly one of the protocol-specific health check field must be specified, which must match type field.
  • unhealthy-threshold=94
    • A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p request-id=string
    • An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.
  • -p access-token=string

    • OAuth access token.
  • -p alt=string

    • Data format for response.
  • -p callback=string

    • JSONP
  • -p fields=string

    • Selector specifying which fields to include in a partial response.
  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • -p oauth-token=string

    • OAuth 2.0 token for the current user.
  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.
  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").
  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").
  • -p user-ip=string

    • Legacy name for parameter that has been superseded by quotaUser.