GetHealth.hs

{-# LANGUAGE DataKinds #-}
{-# LANGUAGE DerivingStrategies #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE ImportQualifiedPost #-}
{-# LANGUAGE LambdaCase #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE PatternSynonyms #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-duplicate-exports #-}
{-# OPTIONS_GHC -fno-warn-name-shadowing #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- |
-- Module      : Gogol.Compute.BackendServices.GetHealth
-- Copyright   : (c) 2015-2025 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+gogol@gmail.com>
--               Toni Cebrián <toni@tonicebrian.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Gets the most recent health check results for this BackendService. Example request body: { \"group\": \"\/zones\/us-east1-b\/instanceGroups\/lb-backend-example\" }
--
-- /See:/ <https://cloud.google.com/compute/ Compute Engine API Reference> for @compute.backendServices.getHealth@.
module Gogol.Compute.BackendServices.GetHealth
  ( -- * Resource
    ComputeBackendServicesGetHealthResource,

    -- ** Constructing a Request
    ComputeBackendServicesGetHealth (..),
    newComputeBackendServicesGetHealth,
  )
where

import Gogol.Compute.Types
import Gogol.Prelude qualified as Core

-- | A resource alias for @compute.backendServices.getHealth@ method which the
-- 'ComputeBackendServicesGetHealth' request conforms to.
type ComputeBackendServicesGetHealthResource =
  "compute"
    Core.:> "v1"
    Core.:> "projects"
    Core.:> Core.Capture "project" Core.Text
    Core.:> "global"
    Core.:> "backendServices"
    Core.:> Core.Capture "backendService" Core.Text
    Core.:> "getHealth"
    Core.:> Core.QueryParam "$.xgafv" Xgafv
    Core.:> Core.QueryParam "access_token" Core.Text
    Core.:> Core.QueryParam "callback" Core.Text
    Core.:> Core.QueryParam "uploadType" Core.Text
    Core.:> Core.QueryParam "upload_protocol" Core.Text
    Core.:> Core.QueryParam "alt" Core.AltJSON
    Core.:> Core.ReqBody '[Core.JSON] ResourceGroupReference
    Core.:> Core.Post '[Core.JSON] BackendServiceGroupHealth

-- | Gets the most recent health check results for this BackendService. Example request body: { \"group\": \"\/zones\/us-east1-b\/instanceGroups\/lb-backend-example\" }
--
-- /See:/ 'newComputeBackendServicesGetHealth' smart constructor.
data ComputeBackendServicesGetHealth = ComputeBackendServicesGetHealth
  { -- | V1 error format.
    xgafv :: (Core.Maybe Xgafv),
    -- | OAuth access token.
    accessToken :: (Core.Maybe Core.Text),
    -- | Name of the BackendService resource to which the queried instance belongs.
    backendService :: Core.Text,
    -- | JSONP
    callback :: (Core.Maybe Core.Text),
    -- | Multipart request metadata.
    payload :: ResourceGroupReference,
    project :: Core.Text,
    -- | Legacy upload protocol for media (e.g. \"media\", \"multipart\").
    uploadType :: (Core.Maybe Core.Text),
    -- | Upload protocol for media (e.g. \"raw\", \"multipart\").
    uploadProtocol :: (Core.Maybe Core.Text)
  }
  deriving (Core.Eq, Core.Show, Core.Generic)

-- | Creates a value of 'ComputeBackendServicesGetHealth' with the minimum fields required to make a request.
newComputeBackendServicesGetHealth ::
  -- |  Name of the BackendService resource to which the queried instance belongs. See 'backendService'.
  Core.Text ->
  -- |  Multipart request metadata. See 'payload'.
  ResourceGroupReference ->
  -- |  See 'project'.
  Core.Text ->
  ComputeBackendServicesGetHealth
newComputeBackendServicesGetHealth backendService payload project =
  ComputeBackendServicesGetHealth
    { xgafv = Core.Nothing,
      accessToken = Core.Nothing,
      backendService = backendService,
      callback = Core.Nothing,
      payload = payload,
      project = project,
      uploadType = Core.Nothing,
      uploadProtocol = Core.Nothing
    }

instance Core.GoogleRequest ComputeBackendServicesGetHealth where
  type Rs ComputeBackendServicesGetHealth = BackendServiceGroupHealth
  type
    Scopes ComputeBackendServicesGetHealth =
      '[CloudPlatform'FullControl, Compute'FullControl, Compute'Readonly]
  requestClient ComputeBackendServicesGetHealth {..} =
    go
      project
      backendService
      xgafv
      accessToken
      callback
      uploadType
      uploadProtocol
      (Core.Just Core.AltJSON)
      payload
      computeService
    where
      go =
        Core.buildClient
          (Core.Proxy :: Core.Proxy ComputeBackendServicesGetHealthResource)
          Core.mempty