GetVulnerabilitySummary.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.ContainerAnalysis.Projects.Locations.Occurrences.GetVulnerabilitySummary
-- 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 a summary of the number and severity of occurrences.
--
-- /See:/ <https://cloud.google.com/container-analysis/api/reference/rest/ Container Analysis API Reference> for @containeranalysis.projects.locations.occurrences.getVulnerabilitySummary@.
module Gogol.ContainerAnalysis.Projects.Locations.Occurrences.GetVulnerabilitySummary
  ( -- * Resource
    ContainerAnalysisProjectsLocationsOccurrencesGetVulnerabilitySummaryResource,

    -- ** Constructing a Request
    ContainerAnalysisProjectsLocationsOccurrencesGetVulnerabilitySummary (..),
    newContainerAnalysisProjectsLocationsOccurrencesGetVulnerabilitySummary,
  )
where

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

-- | A resource alias for @containeranalysis.projects.locations.occurrences.getVulnerabilitySummary@ method which the
-- 'ContainerAnalysisProjectsLocationsOccurrencesGetVulnerabilitySummary' request conforms to.
type ContainerAnalysisProjectsLocationsOccurrencesGetVulnerabilitySummaryResource =
  "v1"
    Core.:> Core.Capture "parent" Core.Text
    Core.:> "occurrences:vulnerabilitySummary"
    Core.:> Core.QueryParam "$.xgafv" Xgafv
    Core.:> Core.QueryParam "access_token" Core.Text
    Core.:> Core.QueryParam "callback" Core.Text
    Core.:> Core.QueryParam "filter" Core.Text
    Core.:> Core.QueryParam "uploadType" Core.Text
    Core.:> Core.QueryParam "upload_protocol" Core.Text
    Core.:> Core.QueryParam "alt" Core.AltJSON
    Core.:> Core.Get '[Core.JSON] VulnerabilityOccurrencesSummary

-- | Gets a summary of the number and severity of occurrences.
--
-- /See:/ 'newContainerAnalysisProjectsLocationsOccurrencesGetVulnerabilitySummary' smart constructor.
data ContainerAnalysisProjectsLocationsOccurrencesGetVulnerabilitySummary = ContainerAnalysisProjectsLocationsOccurrencesGetVulnerabilitySummary
  { -- | V1 error format.
    xgafv :: (Core.Maybe Xgafv),
    -- | OAuth access token.
    accessToken :: (Core.Maybe Core.Text),
    -- | JSONP
    callback :: (Core.Maybe Core.Text),
    -- | The filter expression.
    filter :: (Core.Maybe Core.Text),
    -- | Required. The name of the project to get a vulnerability summary for in the form of @projects\/[PROJECT_ID]@.
    parent :: 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 'ContainerAnalysisProjectsLocationsOccurrencesGetVulnerabilitySummary' with the minimum fields required to make a request.
newContainerAnalysisProjectsLocationsOccurrencesGetVulnerabilitySummary ::
  -- |  Required. The name of the project to get a vulnerability summary for in the form of @projects\/[PROJECT_ID]@. See 'parent'.
  Core.Text ->
  ContainerAnalysisProjectsLocationsOccurrencesGetVulnerabilitySummary
newContainerAnalysisProjectsLocationsOccurrencesGetVulnerabilitySummary
  parent =
    ContainerAnalysisProjectsLocationsOccurrencesGetVulnerabilitySummary
      { xgafv =
          Core.Nothing,
        accessToken = Core.Nothing,
        callback = Core.Nothing,
        filter = Core.Nothing,
        parent = parent,
        uploadType = Core.Nothing,
        uploadProtocol =
          Core.Nothing
      }

instance
  Core.GoogleRequest
    ContainerAnalysisProjectsLocationsOccurrencesGetVulnerabilitySummary
  where
  type
    Rs
      ContainerAnalysisProjectsLocationsOccurrencesGetVulnerabilitySummary =
      VulnerabilityOccurrencesSummary
  type
    Scopes
      ContainerAnalysisProjectsLocationsOccurrencesGetVulnerabilitySummary =
      '[CloudPlatform'FullControl]
  requestClient
    ContainerAnalysisProjectsLocationsOccurrencesGetVulnerabilitySummary {..} =
      go
        parent
        xgafv
        accessToken
        callback
        filter
        uploadType
        uploadProtocol
        (Core.Just Core.AltJSON)
        containerAnalysisService
      where
        go =
          Core.buildClient
            ( Core.Proxy ::
                Core.Proxy
                  ContainerAnalysisProjectsLocationsOccurrencesGetVulnerabilitySummaryResource
            )
            Core.mempty