GoogleApi.Compute.V1.Model.HealthCheckService (google_api_compute v0.41.0) View Source

Represents a Health-Check as a Service resource.


  • creationTimestamp (type: String.t, default: nil) - [Output Only] Creation timestamp in RFC3339 text format.
  • description (type: String.t, default: nil) - An optional description of this resource. Provide this property when you create the resource.
  • fingerprint (type: String.t, default: nil) - 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 (type: list(String.t), default: nil) - A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NEGs.
  • healthStatusAggregationPolicy (type: String.t, default: nil) - 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 reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health checks report HEALTHY, the HealthState of the endpoint is HEALTHY. .
  • id (type: String.t, default: nil) - [Output Only] The unique identifier for the resource. This identifier is defined by the server.
  • kind (type: String.t, default: compute#healthCheckService) - [Output only] Type of the resource. Always compute#healthCheckServicefor health check services.
  • name (type: String.t, default: nil) - 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.
  • networkEndpointGroups (type: list(String.t), default: nil) - A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService.
  • notificationEndpoints (type: list(String.t), default: nil) - 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 regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.
  • region (type: String.t, default: nil) - [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 (type: String.t, default: nil) - [Output Only] Server-defined URL for the resource.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.Compute.V1.Model.HealthCheckService{
  creationTimestamp: String.t() | nil,
  description: String.t() | nil,
  fingerprint: String.t() | nil,
  healthChecks: [String.t()] | nil,
  healthStatusAggregationPolicy: String.t() | nil,
  id: String.t() | nil,
  kind: String.t() | nil,
  name: String.t() | nil,
  networkEndpointGroups: [String.t()] | nil,
  notificationEndpoints: [String.t()] | nil,
  region: String.t() | nil,
  selfLink: String.t() | nil

Link to this section Functions


decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.