# Copyright 2019 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # NOTE: This file is auto generated by the elixir code generator program. # Do not edit this file manually. defmodule GoogleApi.Compute.V1.Model.HealthCheck do @moduledoc """ Represents a Health Check resource. Google Compute Engine has two Health Check resources: * [Global](/compute/docs/reference/rest/latest/healthChecks) * [Regional](/compute/docs/reference/rest/latest/regionHealthChecks) Internal HTTP(S) load balancers use regional health checks. All other types of GCP load balancers and managed instance group auto-healing use global health checks. For more information, read Health Check Concepts. To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks. ## Attributes * `checkIntervalSec` (*type:* `integer()`, *default:* `nil`) - How often (in seconds) to send a health check. The default value is 5 seconds. * `creationTimestamp` (*type:* `String.t`, *default:* `nil`) - [Output Only] Creation timestamp in 3339 text format. * `description` (*type:* `String.t`, *default:* `nil`) - An optional description of this resource. Provide this property when you create the resource. * `healthyThreshold` (*type:* `integer()`, *default:* `nil`) - A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. * `http2HealthCheck` (*type:* `GoogleApi.Compute.V1.Model.HTTP2HealthCheck.t`, *default:* `nil`) - * `httpHealthCheck` (*type:* `GoogleApi.Compute.V1.Model.HTTPHealthCheck.t`, *default:* `nil`) - * `httpsHealthCheck` (*type:* `GoogleApi.Compute.V1.Model.HTTPSHealthCheck.t`, *default:* `nil`) - * `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#healthCheck`) - Type of the resource. * `name` (*type:* `String.t`, *default:* `nil`) - 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. 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. * `region` (*type:* `String.t`, *default:* `nil`) - [Output Only] Region where the health check resides. Not applicable to global health checks. * `selfLink` (*type:* `String.t`, *default:* `nil`) - [Output Only] Server-defined URL for the resource. * `sslHealthCheck` (*type:* `GoogleApi.Compute.V1.Model.SSLHealthCheck.t`, *default:* `nil`) - * `tcpHealthCheck` (*type:* `GoogleApi.Compute.V1.Model.TCPHealthCheck.t`, *default:* `nil`) - * `timeoutSec` (*type:* `integer()`, *default:* `nil`) - 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` (*type:* `String.t`, *default:* `nil`) - Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field. * `unhealthyThreshold` (*type:* `integer()`, *default:* `nil`) - A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. """ use GoogleApi.Gax.ModelBase @type t :: %__MODULE__{ :checkIntervalSec => integer(), :creationTimestamp => String.t(), :description => String.t(), :healthyThreshold => integer(), :http2HealthCheck => GoogleApi.Compute.V1.Model.HTTP2HealthCheck.t(), :httpHealthCheck => GoogleApi.Compute.V1.Model.HTTPHealthCheck.t(), :httpsHealthCheck => GoogleApi.Compute.V1.Model.HTTPSHealthCheck.t(), :id => String.t(), :kind => String.t(), :name => String.t(), :region => String.t(), :selfLink => String.t(), :sslHealthCheck => GoogleApi.Compute.V1.Model.SSLHealthCheck.t(), :tcpHealthCheck => GoogleApi.Compute.V1.Model.TCPHealthCheck.t(), :timeoutSec => integer(), :type => String.t(), :unhealthyThreshold => integer() } field(:checkIntervalSec) field(:creationTimestamp) field(:description) field(:healthyThreshold) field(:http2HealthCheck, as: GoogleApi.Compute.V1.Model.HTTP2HealthCheck) field(:httpHealthCheck, as: GoogleApi.Compute.V1.Model.HTTPHealthCheck) field(:httpsHealthCheck, as: GoogleApi.Compute.V1.Model.HTTPSHealthCheck) field(:id) field(:kind) field(:name) field(:region) field(:selfLink) field(:sslHealthCheck, as: GoogleApi.Compute.V1.Model.SSLHealthCheck) field(:tcpHealthCheck, as: GoogleApi.Compute.V1.Model.TCPHealthCheck) field(:timeoutSec) field(:type) field(:unhealthyThreshold) end defimpl Poison.Decoder, for: GoogleApi.Compute.V1.Model.HealthCheck do def decode(value, options) do GoogleApi.Compute.V1.Model.HealthCheck.decode(value, options) end end defimpl Poison.Encoder, for: GoogleApi.Compute.V1.Model.HealthCheck do def encode(value, options) do GoogleApi.Gax.ModelBase.encode(value, options) end end