List.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.Notes.Occurrences.List
-- 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)
--
-- Lists occurrences referencing the specified note. Provider projects can use this method to get all occurrences across consumer projects referencing the specified note.
--
-- /See:/ <https://cloud.google.com/container-analysis/api/reference/rest/ Container Analysis API Reference> for @containeranalysis.projects.locations.notes.occurrences.list@.
module Gogol.ContainerAnalysis.Projects.Locations.Notes.Occurrences.List
  ( -- * Resource
    ContainerAnalysisProjectsLocationsNotesOccurrencesListResource,

    -- ** Constructing a Request
    ContainerAnalysisProjectsLocationsNotesOccurrencesList (..),
    newContainerAnalysisProjectsLocationsNotesOccurrencesList,
  )
where

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

-- | A resource alias for @containeranalysis.projects.locations.notes.occurrences.list@ method which the
-- 'ContainerAnalysisProjectsLocationsNotesOccurrencesList' request conforms to.
type ContainerAnalysisProjectsLocationsNotesOccurrencesListResource =
  "v1"
    Core.:> Core.Capture "name" Core.Text
    Core.:> "occurrences"
    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 "pageSize" Core.Int32
    Core.:> Core.QueryParam "pageToken" 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] ListNoteOccurrencesResponse

-- | Lists occurrences referencing the specified note. Provider projects can use this method to get all occurrences across consumer projects referencing the specified note.
--
-- /See:/ 'newContainerAnalysisProjectsLocationsNotesOccurrencesList' smart constructor.
data ContainerAnalysisProjectsLocationsNotesOccurrencesList = ContainerAnalysisProjectsLocationsNotesOccurrencesList
  { -- | 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 note to list occurrences for in the form of @projects\/[PROVIDER_ID]\/notes\/[NOTE_ID]@.
    name :: Core.Text,
    -- | Number of occurrences to return in the list.
    pageSize :: (Core.Maybe Core.Int32),
    -- | Token to provide to skip to a particular spot in the list.
    pageToken :: (Core.Maybe 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 'ContainerAnalysisProjectsLocationsNotesOccurrencesList' with the minimum fields required to make a request.
newContainerAnalysisProjectsLocationsNotesOccurrencesList ::
  -- |  Required. The name of the note to list occurrences for in the form of @projects\/[PROVIDER_ID]\/notes\/[NOTE_ID]@. See 'name'.
  Core.Text ->
  ContainerAnalysisProjectsLocationsNotesOccurrencesList
newContainerAnalysisProjectsLocationsNotesOccurrencesList name =
  ContainerAnalysisProjectsLocationsNotesOccurrencesList
    { xgafv =
        Core.Nothing,
      accessToken = Core.Nothing,
      callback = Core.Nothing,
      filter = Core.Nothing,
      name = name,
      pageSize = Core.Nothing,
      pageToken = Core.Nothing,
      uploadType = Core.Nothing,
      uploadProtocol = Core.Nothing
    }

instance
  Core.GoogleRequest
    ContainerAnalysisProjectsLocationsNotesOccurrencesList
  where
  type
    Rs ContainerAnalysisProjectsLocationsNotesOccurrencesList =
      ListNoteOccurrencesResponse
  type
    Scopes ContainerAnalysisProjectsLocationsNotesOccurrencesList =
      '[CloudPlatform'FullControl]
  requestClient
    ContainerAnalysisProjectsLocationsNotesOccurrencesList {..} =
      go
        name
        xgafv
        accessToken
        callback
        filter
        pageSize
        pageToken
        uploadType
        uploadProtocol
        (Core.Just Core.AltJSON)
        containerAnalysisService
      where
        go =
          Core.buildClient
            ( Core.Proxy ::
                Core.Proxy
                  ContainerAnalysisProjectsLocationsNotesOccurrencesListResource
            )
            Core.mempty