{-# 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.Files.Annotate
-- 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)
--
-- Service that performs image detection and annotation for a batch of files. Now only \"application\/pdf\", \"image\/tiff\" and \"image\/gif\" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.
--
-- /See:/ <https://cloud.google.com/vision/ Cloud Vision API Reference> for @vision.files.annotate@.
module Gogol.Vision.Files.Annotate
  ( -- * Resource
    VisionFilesAnnotateResource,

    -- ** Constructing a Request
    VisionFilesAnnotate (..),
    newVisionFilesAnnotate,
  )
where

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

-- | A resource alias for @vision.files.annotate@ method which the
-- 'VisionFilesAnnotate' request conforms to.
type VisionFilesAnnotateResource =
  "v1p2beta1"
    Core.:> "files:annotate"
    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]
              GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest
    Core.:> Core.Post
              '[Core.JSON]
              GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse

-- | Service that performs image detection and annotation for a batch of files. Now only \"application\/pdf\", \"image\/tiff\" and \"image\/gif\" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.
--
-- /See:/ 'newVisionFilesAnnotate' smart constructor.
data VisionFilesAnnotate = VisionFilesAnnotate
  { -- | V1 error format.
    VisionFilesAnnotate -> Maybe Xgafv
xgafv :: (Core.Maybe Xgafv),
    -- | OAuth access token.
    VisionFilesAnnotate -> Maybe Text
accessToken :: (Core.Maybe Core.Text),
    -- | JSONP
    VisionFilesAnnotate -> Maybe Text
callback :: (Core.Maybe Core.Text),
    -- | Multipart request metadata.
    VisionFilesAnnotate
-> GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest
payload :: GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest,
    -- | Legacy upload protocol for media (e.g. \"media\", \"multipart\").
    VisionFilesAnnotate -> Maybe Text
uploadType :: (Core.Maybe Core.Text),
    -- | Upload protocol for media (e.g. \"raw\", \"multipart\").
    VisionFilesAnnotate -> Maybe Text
uploadProtocol :: (Core.Maybe Core.Text)
  }
  deriving (VisionFilesAnnotate -> VisionFilesAnnotate -> Bool
(VisionFilesAnnotate -> VisionFilesAnnotate -> Bool)
-> (VisionFilesAnnotate -> VisionFilesAnnotate -> Bool)
-> Eq VisionFilesAnnotate
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: VisionFilesAnnotate -> VisionFilesAnnotate -> Bool
== :: VisionFilesAnnotate -> VisionFilesAnnotate -> Bool
$c/= :: VisionFilesAnnotate -> VisionFilesAnnotate -> Bool
/= :: VisionFilesAnnotate -> VisionFilesAnnotate -> Bool
Core.Eq, Int -> VisionFilesAnnotate -> ShowS
[VisionFilesAnnotate] -> ShowS
VisionFilesAnnotate -> String
(Int -> VisionFilesAnnotate -> ShowS)
-> (VisionFilesAnnotate -> String)
-> ([VisionFilesAnnotate] -> ShowS)
-> Show VisionFilesAnnotate
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> VisionFilesAnnotate -> ShowS
showsPrec :: Int -> VisionFilesAnnotate -> ShowS
$cshow :: VisionFilesAnnotate -> String
show :: VisionFilesAnnotate -> String
$cshowList :: [VisionFilesAnnotate] -> ShowS
showList :: [VisionFilesAnnotate] -> ShowS
Core.Show, (forall x. VisionFilesAnnotate -> Rep VisionFilesAnnotate x)
-> (forall x. Rep VisionFilesAnnotate x -> VisionFilesAnnotate)
-> Generic VisionFilesAnnotate
forall x. Rep VisionFilesAnnotate x -> VisionFilesAnnotate
forall x. VisionFilesAnnotate -> Rep VisionFilesAnnotate x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cfrom :: forall x. VisionFilesAnnotate -> Rep VisionFilesAnnotate x
from :: forall x. VisionFilesAnnotate -> Rep VisionFilesAnnotate x
$cto :: forall x. Rep VisionFilesAnnotate x -> VisionFilesAnnotate
to :: forall x. Rep VisionFilesAnnotate x -> VisionFilesAnnotate
Core.Generic)

-- | Creates a value of 'VisionFilesAnnotate' with the minimum fields required to make a request.
newVisionFilesAnnotate ::
  -- |  Multipart request metadata. See 'payload'.
  GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest ->
  VisionFilesAnnotate
newVisionFilesAnnotate :: GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest
-> VisionFilesAnnotate
newVisionFilesAnnotate GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest
payload =
  VisionFilesAnnotate
    { 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,
      payload :: GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest
payload = GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest
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 VisionFilesAnnotate where
  type
    Rs VisionFilesAnnotate =
      GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse
  type
    Scopes VisionFilesAnnotate =
      '[CloudPlatform'FullControl, CloudVision'FullControl]
  requestClient :: VisionFilesAnnotate -> GClient (Rs VisionFilesAnnotate)
requestClient VisionFilesAnnotate {Maybe Text
Maybe Xgafv
GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest
xgafv :: VisionFilesAnnotate -> Maybe Xgafv
accessToken :: VisionFilesAnnotate -> Maybe Text
callback :: VisionFilesAnnotate -> Maybe Text
payload :: VisionFilesAnnotate
-> GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest
uploadType :: VisionFilesAnnotate -> Maybe Text
uploadProtocol :: VisionFilesAnnotate -> Maybe Text
xgafv :: Maybe Xgafv
accessToken :: Maybe Text
callback :: Maybe Text
payload :: GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest
uploadType :: Maybe Text
uploadProtocol :: Maybe Text
..} =
    Maybe Xgafv
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe AltJSON
-> GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest
-> ServiceConfig
-> GClient GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse
go
      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)
      GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest
payload
      ServiceConfig
visionService
    where
      go :: Fn VisionFilesAnnotateResource
go =
        Proxy VisionFilesAnnotateResource
-> Request -> Fn VisionFilesAnnotateResource
forall {k} (fn :: k).
GoogleClient fn =>
Proxy fn -> Request -> Fn fn
Core.buildClient
          (Proxy VisionFilesAnnotateResource
forall {k} (t :: k). Proxy t
Core.Proxy :: Core.Proxy VisionFilesAnnotateResource)
          Request
forall a. Monoid a => a
Core.mempty