{-# 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.Vision.Projects.Locations.Files.AsyncBatchAnnotate
-- 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)
--
-- Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the @google.longrunning.Operations@ interface. @Operation.metadata@ contains @OperationMetadata@ (metadata). @Operation.response@ contains @AsyncBatchAnnotateFilesResponse@ (results).
--
-- /See:/ <https://cloud.google.com/vision/ Cloud Vision API Reference> for @vision.projects.locations.files.asyncBatchAnnotate@.
module Gogol.Vision.Projects.Locations.Files.AsyncBatchAnnotate
  ( -- * Resource
    VisionProjectsLocationsFilesAsyncBatchAnnotateResource,

    -- ** Constructing a Request
    VisionProjectsLocationsFilesAsyncBatchAnnotate (..),
    newVisionProjectsLocationsFilesAsyncBatchAnnotate,
  )
where

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

-- | A resource alias for @vision.projects.locations.files.asyncBatchAnnotate@ method which the
-- 'VisionProjectsLocationsFilesAsyncBatchAnnotate' request conforms to.
type VisionProjectsLocationsFilesAsyncBatchAnnotateResource =
  "v1p2beta1"
    Core.:> Core.Capture "parent" Core.Text
    Core.:> "files:asyncBatchAnnotate"
    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]
              GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest
    Core.:> Core.Post '[Core.JSON] Operation

-- | Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the @google.longrunning.Operations@ interface. @Operation.metadata@ contains @OperationMetadata@ (metadata). @Operation.response@ contains @AsyncBatchAnnotateFilesResponse@ (results).
--
-- /See:/ 'newVisionProjectsLocationsFilesAsyncBatchAnnotate' smart constructor.
data VisionProjectsLocationsFilesAsyncBatchAnnotate = VisionProjectsLocationsFilesAsyncBatchAnnotate
  { -- | V1 error format.
    VisionProjectsLocationsFilesAsyncBatchAnnotate -> Maybe Xgafv
xgafv :: (Core.Maybe Xgafv),
    -- | OAuth access token.
    VisionProjectsLocationsFilesAsyncBatchAnnotate -> Maybe Text
accessToken :: (Core.Maybe Core.Text),
    -- | JSONP
    VisionProjectsLocationsFilesAsyncBatchAnnotate -> Maybe Text
callback :: (Core.Maybe Core.Text),
    -- | Optional. Target project and location to make a call. Format: @projects\/{project-id}\/locations\/{location-id}@. If no parent is specified, a region will be chosen automatically. Supported location-ids: @us@: USA country only, @asia@: East asia areas, like Japan, Taiwan, @eu@: The European Union. Example: @projects\/project-A\/locations\/eu@.
    VisionProjectsLocationsFilesAsyncBatchAnnotate -> Text
parent :: Core.Text,
    -- | Multipart request metadata.
    VisionProjectsLocationsFilesAsyncBatchAnnotate
-> GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest
payload :: GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest,
    -- | Legacy upload protocol for media (e.g. \"media\", \"multipart\").
    VisionProjectsLocationsFilesAsyncBatchAnnotate -> Maybe Text
uploadType :: (Core.Maybe Core.Text),
    -- | Upload protocol for media (e.g. \"raw\", \"multipart\").
    VisionProjectsLocationsFilesAsyncBatchAnnotate -> Maybe Text
uploadProtocol :: (Core.Maybe Core.Text)
  }
  deriving (VisionProjectsLocationsFilesAsyncBatchAnnotate
-> VisionProjectsLocationsFilesAsyncBatchAnnotate -> Bool
(VisionProjectsLocationsFilesAsyncBatchAnnotate
 -> VisionProjectsLocationsFilesAsyncBatchAnnotate -> Bool)
-> (VisionProjectsLocationsFilesAsyncBatchAnnotate
    -> VisionProjectsLocationsFilesAsyncBatchAnnotate -> Bool)
-> Eq VisionProjectsLocationsFilesAsyncBatchAnnotate
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: VisionProjectsLocationsFilesAsyncBatchAnnotate
-> VisionProjectsLocationsFilesAsyncBatchAnnotate -> Bool
== :: VisionProjectsLocationsFilesAsyncBatchAnnotate
-> VisionProjectsLocationsFilesAsyncBatchAnnotate -> Bool
$c/= :: VisionProjectsLocationsFilesAsyncBatchAnnotate
-> VisionProjectsLocationsFilesAsyncBatchAnnotate -> Bool
/= :: VisionProjectsLocationsFilesAsyncBatchAnnotate
-> VisionProjectsLocationsFilesAsyncBatchAnnotate -> Bool
Core.Eq, Int -> VisionProjectsLocationsFilesAsyncBatchAnnotate -> ShowS
[VisionProjectsLocationsFilesAsyncBatchAnnotate] -> ShowS
VisionProjectsLocationsFilesAsyncBatchAnnotate -> String
(Int -> VisionProjectsLocationsFilesAsyncBatchAnnotate -> ShowS)
-> (VisionProjectsLocationsFilesAsyncBatchAnnotate -> String)
-> ([VisionProjectsLocationsFilesAsyncBatchAnnotate] -> ShowS)
-> Show VisionProjectsLocationsFilesAsyncBatchAnnotate
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> VisionProjectsLocationsFilesAsyncBatchAnnotate -> ShowS
showsPrec :: Int -> VisionProjectsLocationsFilesAsyncBatchAnnotate -> ShowS
$cshow :: VisionProjectsLocationsFilesAsyncBatchAnnotate -> String
show :: VisionProjectsLocationsFilesAsyncBatchAnnotate -> String
$cshowList :: [VisionProjectsLocationsFilesAsyncBatchAnnotate] -> ShowS
showList :: [VisionProjectsLocationsFilesAsyncBatchAnnotate] -> ShowS
Core.Show, (forall x.
 VisionProjectsLocationsFilesAsyncBatchAnnotate
 -> Rep VisionProjectsLocationsFilesAsyncBatchAnnotate x)
-> (forall x.
    Rep VisionProjectsLocationsFilesAsyncBatchAnnotate x
    -> VisionProjectsLocationsFilesAsyncBatchAnnotate)
-> Generic VisionProjectsLocationsFilesAsyncBatchAnnotate
forall x.
Rep VisionProjectsLocationsFilesAsyncBatchAnnotate x
-> VisionProjectsLocationsFilesAsyncBatchAnnotate
forall x.
VisionProjectsLocationsFilesAsyncBatchAnnotate
-> Rep VisionProjectsLocationsFilesAsyncBatchAnnotate x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cfrom :: forall x.
VisionProjectsLocationsFilesAsyncBatchAnnotate
-> Rep VisionProjectsLocationsFilesAsyncBatchAnnotate x
from :: forall x.
VisionProjectsLocationsFilesAsyncBatchAnnotate
-> Rep VisionProjectsLocationsFilesAsyncBatchAnnotate x
$cto :: forall x.
Rep VisionProjectsLocationsFilesAsyncBatchAnnotate x
-> VisionProjectsLocationsFilesAsyncBatchAnnotate
to :: forall x.
Rep VisionProjectsLocationsFilesAsyncBatchAnnotate x
-> VisionProjectsLocationsFilesAsyncBatchAnnotate
Core.Generic)

-- | Creates a value of 'VisionProjectsLocationsFilesAsyncBatchAnnotate' with the minimum fields required to make a request.
newVisionProjectsLocationsFilesAsyncBatchAnnotate ::
  -- |  Optional. Target project and location to make a call. Format: @projects\/{project-id}\/locations\/{location-id}@. If no parent is specified, a region will be chosen automatically. Supported location-ids: @us@: USA country only, @asia@: East asia areas, like Japan, Taiwan, @eu@: The European Union. Example: @projects\/project-A\/locations\/eu@. See 'parent'.
  Core.Text ->
  -- |  Multipart request metadata. See 'payload'.
  GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest ->
  VisionProjectsLocationsFilesAsyncBatchAnnotate
newVisionProjectsLocationsFilesAsyncBatchAnnotate :: Text
-> GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest
-> VisionProjectsLocationsFilesAsyncBatchAnnotate
newVisionProjectsLocationsFilesAsyncBatchAnnotate Text
parent GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest
payload =
  VisionProjectsLocationsFilesAsyncBatchAnnotate
    { 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,
      parent :: Text
parent = Text
parent,
      payload :: GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest
payload = GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest
payload,
      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
    VisionProjectsLocationsFilesAsyncBatchAnnotate
  where
  type Rs VisionProjectsLocationsFilesAsyncBatchAnnotate = Operation
  type
    Scopes VisionProjectsLocationsFilesAsyncBatchAnnotate =
      '[CloudPlatform'FullControl, CloudVision'FullControl]
  requestClient :: VisionProjectsLocationsFilesAsyncBatchAnnotate
-> GClient (Rs VisionProjectsLocationsFilesAsyncBatchAnnotate)
requestClient VisionProjectsLocationsFilesAsyncBatchAnnotate {Maybe Text
Maybe Xgafv
Text
GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest
xgafv :: VisionProjectsLocationsFilesAsyncBatchAnnotate -> Maybe Xgafv
accessToken :: VisionProjectsLocationsFilesAsyncBatchAnnotate -> Maybe Text
callback :: VisionProjectsLocationsFilesAsyncBatchAnnotate -> Maybe Text
parent :: VisionProjectsLocationsFilesAsyncBatchAnnotate -> Text
payload :: VisionProjectsLocationsFilesAsyncBatchAnnotate
-> GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest
uploadType :: VisionProjectsLocationsFilesAsyncBatchAnnotate -> Maybe Text
uploadProtocol :: VisionProjectsLocationsFilesAsyncBatchAnnotate -> Maybe Text
xgafv :: Maybe Xgafv
accessToken :: Maybe Text
callback :: Maybe Text
parent :: Text
payload :: GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest
uploadType :: Maybe Text
uploadProtocol :: Maybe Text
..} =
    Text
-> Maybe Xgafv
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe AltJSON
-> GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest
-> ServiceConfig
-> GClient Operation
go
      Text
parent
      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)
      GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest
payload
      ServiceConfig
visionService
    where
      go :: Fn VisionProjectsLocationsFilesAsyncBatchAnnotateResource
go =
        Proxy VisionProjectsLocationsFilesAsyncBatchAnnotateResource
-> Request
-> Fn VisionProjectsLocationsFilesAsyncBatchAnnotateResource
forall {k} (fn :: k).
GoogleClient fn =>
Proxy fn -> Request -> Fn fn
Core.buildClient
          ( Proxy VisionProjectsLocationsFilesAsyncBatchAnnotateResource
forall {k} (t :: k). Proxy t
Core.Proxy ::
              Core.Proxy VisionProjectsLocationsFilesAsyncBatchAnnotateResource
          )
          Request
forall a. Monoid a => a
Core.mempty