{-# 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.Vault.Operations.Get
-- 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 latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
--
-- /See:/ <https://developers.google.com/vault Google Vault API Reference> for @vault.operations.get@.
module Gogol.Vault.Operations.Get
  ( -- * Resource
    VaultOperationsGetResource,

    -- ** Constructing a Request
    VaultOperationsGet (..),
    newVaultOperationsGet,
  )
where

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

-- | A resource alias for @vault.operations.get@ method which the
-- 'VaultOperationsGet' request conforms to.
type VaultOperationsGetResource =
  "v1"
    Core.:> Core.Capture "name" Core.Text
    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.Get '[Core.JSON] Operation

-- | Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
--
-- /See:/ 'newVaultOperationsGet' smart constructor.
data VaultOperationsGet = VaultOperationsGet
  { -- | V1 error format.
    VaultOperationsGet -> Maybe Xgafv
xgafv :: (Core.Maybe Xgafv),
    -- | OAuth access token.
    VaultOperationsGet -> Maybe Text
accessToken :: (Core.Maybe Core.Text),
    -- | JSONP
    VaultOperationsGet -> Maybe Text
callback :: (Core.Maybe Core.Text),
    -- | The name of the operation resource.
    VaultOperationsGet -> Text
name :: Core.Text,
    -- | Legacy upload protocol for media (e.g. \"media\", \"multipart\").
    VaultOperationsGet -> Maybe Text
uploadType :: (Core.Maybe Core.Text),
    -- | Upload protocol for media (e.g. \"raw\", \"multipart\").
    VaultOperationsGet -> Maybe Text
uploadProtocol :: (Core.Maybe Core.Text)
  }
  deriving (VaultOperationsGet -> VaultOperationsGet -> Bool
(VaultOperationsGet -> VaultOperationsGet -> Bool)
-> (VaultOperationsGet -> VaultOperationsGet -> Bool)
-> Eq VaultOperationsGet
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: VaultOperationsGet -> VaultOperationsGet -> Bool
== :: VaultOperationsGet -> VaultOperationsGet -> Bool
$c/= :: VaultOperationsGet -> VaultOperationsGet -> Bool
/= :: VaultOperationsGet -> VaultOperationsGet -> Bool
Core.Eq, Int -> VaultOperationsGet -> ShowS
[VaultOperationsGet] -> ShowS
VaultOperationsGet -> String
(Int -> VaultOperationsGet -> ShowS)
-> (VaultOperationsGet -> String)
-> ([VaultOperationsGet] -> ShowS)
-> Show VaultOperationsGet
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> VaultOperationsGet -> ShowS
showsPrec :: Int -> VaultOperationsGet -> ShowS
$cshow :: VaultOperationsGet -> String
show :: VaultOperationsGet -> String
$cshowList :: [VaultOperationsGet] -> ShowS
showList :: [VaultOperationsGet] -> ShowS
Core.Show, (forall x. VaultOperationsGet -> Rep VaultOperationsGet x)
-> (forall x. Rep VaultOperationsGet x -> VaultOperationsGet)
-> Generic VaultOperationsGet
forall x. Rep VaultOperationsGet x -> VaultOperationsGet
forall x. VaultOperationsGet -> Rep VaultOperationsGet x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cfrom :: forall x. VaultOperationsGet -> Rep VaultOperationsGet x
from :: forall x. VaultOperationsGet -> Rep VaultOperationsGet x
$cto :: forall x. Rep VaultOperationsGet x -> VaultOperationsGet
to :: forall x. Rep VaultOperationsGet x -> VaultOperationsGet
Core.Generic)

-- | Creates a value of 'VaultOperationsGet' with the minimum fields required to make a request.
newVaultOperationsGet ::
  -- |  The name of the operation resource. See 'name'.
  Core.Text ->
  VaultOperationsGet
newVaultOperationsGet :: Text -> VaultOperationsGet
newVaultOperationsGet Text
name =
  VaultOperationsGet
    { xgafv :: Maybe Xgafv
xgafv = Maybe Xgafv
forall a. Maybe a
Core.Nothing,
      accessToken :: Maybe Text
accessToken = Maybe Text
forall a. Maybe a
Core.Nothing,
      callback :: Maybe Text
callback = Maybe Text
forall a. Maybe a
Core.Nothing,
      name :: Text
name = Text
name,
      uploadType :: Maybe Text
uploadType = Maybe Text
forall a. Maybe a
Core.Nothing,
      uploadProtocol :: Maybe Text
uploadProtocol = Maybe Text
forall a. Maybe a
Core.Nothing
    }

instance Core.GoogleRequest VaultOperationsGet where
  type Rs VaultOperationsGet = Operation
  type
    Scopes VaultOperationsGet =
      '[Ediscovery'FullControl, Ediscovery'Readonly]
  requestClient :: VaultOperationsGet -> GClient (Rs VaultOperationsGet)
requestClient VaultOperationsGet {Maybe Text
Maybe Xgafv
Text
xgafv :: VaultOperationsGet -> Maybe Xgafv
accessToken :: VaultOperationsGet -> Maybe Text
callback :: VaultOperationsGet -> Maybe Text
name :: VaultOperationsGet -> Text
uploadType :: VaultOperationsGet -> Maybe Text
uploadProtocol :: VaultOperationsGet -> Maybe Text
xgafv :: Maybe Xgafv
accessToken :: Maybe Text
callback :: Maybe Text
name :: Text
uploadType :: Maybe Text
uploadProtocol :: Maybe Text
..} =
    Text
-> Maybe Xgafv
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe AltJSON
-> ServiceConfig
-> GClient Operation
go
      Text
name
      Maybe Xgafv
xgafv
      Maybe Text
accessToken
      Maybe Text
callback
      Maybe Text
uploadType
      Maybe Text
uploadProtocol
      (AltJSON -> Maybe AltJSON
forall a. a -> Maybe a
Core.Just AltJSON
Core.AltJSON)
      ServiceConfig
vaultService
    where
      go :: Fn VaultOperationsGetResource
go =
        Proxy VaultOperationsGetResource
-> Request -> Fn VaultOperationsGetResource
forall {k} (fn :: k).
GoogleClient fn =>
Proxy fn -> Request -> Fn fn
Core.buildClient
          (Proxy VaultOperationsGetResource
forall {k} (t :: k). Proxy t
Core.Proxy :: Core.Proxy VaultOperationsGetResource)
          Request
forall a. Monoid a => a
Core.mempty