{-# 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.Images.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)
--
-- Run image detection and annotation for a batch of images.
--
-- /See:/ <https://cloud.google.com/vision/ Cloud Vision API Reference> for @vision.images.annotate@.
module Gogol.Vision.Images.Annotate
  ( -- * Resource
    VisionImagesAnnotateResource,

    -- ** Constructing a Request
    VisionImagesAnnotate (..),
    newVisionImagesAnnotate,
  )
where

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

-- | A resource alias for @vision.images.annotate@ method which the
-- 'VisionImagesAnnotate' request conforms to.
type VisionImagesAnnotateResource =
  "v1p2beta1"
    Core.:> "images: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]
              GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest
    Core.:> Core.Post
              '[Core.JSON]
              GoogleCloudVisionV1p2beta1BatchAnnotateImagesResponse

-- | Run image detection and annotation for a batch of images.
--
-- /See:/ 'newVisionImagesAnnotate' smart constructor.
data VisionImagesAnnotate = VisionImagesAnnotate
  { -- | V1 error format.
    VisionImagesAnnotate -> Maybe Xgafv
xgafv :: (Core.Maybe Xgafv),
    -- | OAuth access token.
    VisionImagesAnnotate -> Maybe Text
accessToken :: (Core.Maybe Core.Text),
    -- | JSONP
    VisionImagesAnnotate -> Maybe Text
callback :: (Core.Maybe Core.Text),
    -- | Multipart request metadata.
    VisionImagesAnnotate
-> GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest
payload :: GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest,
    -- | Legacy upload protocol for media (e.g. \"media\", \"multipart\").
    VisionImagesAnnotate -> Maybe Text
uploadType :: (Core.Maybe Core.Text),
    -- | Upload protocol for media (e.g. \"raw\", \"multipart\").
    VisionImagesAnnotate -> Maybe Text
uploadProtocol :: (Core.Maybe Core.Text)
  }
  deriving (VisionImagesAnnotate -> VisionImagesAnnotate -> Bool
(VisionImagesAnnotate -> VisionImagesAnnotate -> Bool)
-> (VisionImagesAnnotate -> VisionImagesAnnotate -> Bool)
-> Eq VisionImagesAnnotate
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: VisionImagesAnnotate -> VisionImagesAnnotate -> Bool
== :: VisionImagesAnnotate -> VisionImagesAnnotate -> Bool
$c/= :: VisionImagesAnnotate -> VisionImagesAnnotate -> Bool
/= :: VisionImagesAnnotate -> VisionImagesAnnotate -> Bool
Core.Eq, Int -> VisionImagesAnnotate -> ShowS
[VisionImagesAnnotate] -> ShowS
VisionImagesAnnotate -> String
(Int -> VisionImagesAnnotate -> ShowS)
-> (VisionImagesAnnotate -> String)
-> ([VisionImagesAnnotate] -> ShowS)
-> Show VisionImagesAnnotate
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> VisionImagesAnnotate -> ShowS
showsPrec :: Int -> VisionImagesAnnotate -> ShowS
$cshow :: VisionImagesAnnotate -> String
show :: VisionImagesAnnotate -> String
$cshowList :: [VisionImagesAnnotate] -> ShowS
showList :: [VisionImagesAnnotate] -> ShowS
Core.Show, (forall x. VisionImagesAnnotate -> Rep VisionImagesAnnotate x)
-> (forall x. Rep VisionImagesAnnotate x -> VisionImagesAnnotate)
-> Generic VisionImagesAnnotate
forall x. Rep VisionImagesAnnotate x -> VisionImagesAnnotate
forall x. VisionImagesAnnotate -> Rep VisionImagesAnnotate x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cfrom :: forall x. VisionImagesAnnotate -> Rep VisionImagesAnnotate x
from :: forall x. VisionImagesAnnotate -> Rep VisionImagesAnnotate x
$cto :: forall x. Rep VisionImagesAnnotate x -> VisionImagesAnnotate
to :: forall x. Rep VisionImagesAnnotate x -> VisionImagesAnnotate
Core.Generic)

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