lib/google_api/compute/v1/model/backend_service_failover_policy.ex

# 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.BackendServiceFailoverPolicy do
  @moduledoc """
  For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes).

  ## Attributes

  *   `disableConnectionDrainOnFailover` (*type:* `boolean()`, *default:* `nil`) - This can be set to true only if the protocol is TCP. The default is false.
  *   `dropTrafficIfUnhealthy` (*type:* `boolean()`, *default:* `nil`) - If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](/network/networklb-failover-overview). The default is false.
  *   `failoverRatio` (*type:* `number()`, *default:* `nil`) - The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio. For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](/network/networklb-failover-overview).
  """

  use GoogleApi.Gax.ModelBase

  @type t :: %__MODULE__{
          :disableConnectionDrainOnFailover => boolean() | nil,
          :dropTrafficIfUnhealthy => boolean() | nil,
          :failoverRatio => number() | nil
        }

  field(:disableConnectionDrainOnFailover)
  field(:dropTrafficIfUnhealthy)
  field(:failoverRatio)
end

defimpl Poison.Decoder, for: GoogleApi.Compute.V1.Model.BackendServiceFailoverPolicy do
  def decode(value, options) do
    GoogleApi.Compute.V1.Model.BackendServiceFailoverPolicy.decode(value, options)
  end
end

defimpl Poison.Encoder, for: GoogleApi.Compute.V1.Model.BackendServiceFailoverPolicy do
  def encode(value, options) do
    GoogleApi.Gax.ModelBase.encode(value, options)
  end
end