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)
Safe Haskell	None
Language	GHC2021

Gogol.Vision.Projects.Files.AsyncBatchAnnotate

Contents

Resource
- Constructing a Request

Description

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: Cloud Vision API Reference for vision.projects.files.asyncBatchAnnotate.

Synopsis

type VisionProjectsFilesAsyncBatchAnnotateResource = "v1p2beta1" :> (Capture "parent" Text :> ("files:asyncBatchAnnotate" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest :> Post '[JSON] Operation)))))))))
data VisionProjectsFilesAsyncBatchAnnotate = VisionProjectsFilesAsyncBatchAnnotate {
- xgafv :: Maybe Xgafv
- accessToken :: Maybe Text
- callback :: Maybe Text
- parent :: Text
- payload :: GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest
- uploadType :: Maybe Text
- uploadProtocol :: Maybe Text
}
newVisionProjectsFilesAsyncBatchAnnotate :: Text -> GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest -> VisionProjectsFilesAsyncBatchAnnotate

Resource

type VisionProjectsFilesAsyncBatchAnnotateResource = "v1p2beta1" :> (Capture "parent" Text :> ("files:asyncBatchAnnotate" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest :> Post '[JSON] Operation))))))))) Source #

A resource alias for vision.projects.files.asyncBatchAnnotate method which the VisionProjectsFilesAsyncBatchAnnotate request conforms to.

Constructing a Request

data VisionProjectsFilesAsyncBatchAnnotate Source #

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: newVisionProjectsFilesAsyncBatchAnnotate smart constructor.

Constructors

VisionProjectsFilesAsyncBatchAnnotate

Fields

xgafv :: Maybe Xgafv
V1 error format.
accessToken :: Maybe Text
OAuth access token.
callback :: Maybe Text
JSONP
parent :: 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.
payload :: GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest
Multipart request metadata.
uploadType :: Maybe Text
Legacy upload protocol for media (e.g. "media", "multipart").
uploadProtocol :: Maybe Text
Upload protocol for media (e.g. "raw", "multipart").

Instances

Instances details

Generic VisionProjectsFilesAsyncBatchAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Files.AsyncBatchAnnotate

Associated Types

type Rep VisionProjectsFilesAsyncBatchAnnotate

Instance details

Defined in Gogol.Vision.Projects.Files.AsyncBatchAnnotate

type Rep VisionProjectsFilesAsyncBatchAnnotate = D1 ('MetaData "VisionProjectsFilesAsyncBatchAnnotate" "Gogol.Vision.Projects.Files.AsyncBatchAnnotate" "gogol-vision-1.0.0-5I8flikCegP9Y27tYWivCE" 'False) (C1 ('MetaCons "VisionProjectsFilesAsyncBatchAnnotate" 'PrefixI 'True) ((S1 ('MetaSel ('Just "xgafv") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "callback") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "parent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "payload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest)) :*: (S1 ('MetaSel ('Just "uploadType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "uploadProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

Methods

from :: VisionProjectsFilesAsyncBatchAnnotate -> Rep VisionProjectsFilesAsyncBatchAnnotate x #

to :: Rep VisionProjectsFilesAsyncBatchAnnotate x -> VisionProjectsFilesAsyncBatchAnnotate #

Show VisionProjectsFilesAsyncBatchAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Files.AsyncBatchAnnotate

Methods

showsPrec :: Int -> VisionProjectsFilesAsyncBatchAnnotate -> ShowS #

show :: VisionProjectsFilesAsyncBatchAnnotate -> String #

showList :: [VisionProjectsFilesAsyncBatchAnnotate] -> ShowS #

Eq VisionProjectsFilesAsyncBatchAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Files.AsyncBatchAnnotate

Methods

(==) :: VisionProjectsFilesAsyncBatchAnnotate -> VisionProjectsFilesAsyncBatchAnnotate -> Bool #

(/=) :: VisionProjectsFilesAsyncBatchAnnotate -> VisionProjectsFilesAsyncBatchAnnotate -> Bool #

GoogleRequest VisionProjectsFilesAsyncBatchAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Files.AsyncBatchAnnotate

Associated Types

type Rs VisionProjectsFilesAsyncBatchAnnotate
Instance details Defined in Gogol.Vision.Projects.Files.AsyncBatchAnnotate type Rs VisionProjectsFilesAsyncBatchAnnotate = Operation
type Scopes VisionProjectsFilesAsyncBatchAnnotate
Instance details Defined in Gogol.Vision.Projects.Files.AsyncBatchAnnotate type Scopes VisionProjectsFilesAsyncBatchAnnotate = '[CloudPlatform'FullControl, CloudVision'FullControl]

Methods

requestClient :: VisionProjectsFilesAsyncBatchAnnotate -> GClient (Rs VisionProjectsFilesAsyncBatchAnnotate) #

type Rep VisionProjectsFilesAsyncBatchAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Files.AsyncBatchAnnotate

type Rep VisionProjectsFilesAsyncBatchAnnotate = D1 ('MetaData "VisionProjectsFilesAsyncBatchAnnotate" "Gogol.Vision.Projects.Files.AsyncBatchAnnotate" "gogol-vision-1.0.0-5I8flikCegP9Y27tYWivCE" 'False) (C1 ('MetaCons "VisionProjectsFilesAsyncBatchAnnotate" 'PrefixI 'True) ((S1 ('MetaSel ('Just "xgafv") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "callback") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "parent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "payload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest)) :*: (S1 ('MetaSel ('Just "uploadType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "uploadProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

type Rs VisionProjectsFilesAsyncBatchAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Files.AsyncBatchAnnotate

type Rs VisionProjectsFilesAsyncBatchAnnotate = Operation

type Scopes VisionProjectsFilesAsyncBatchAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Files.AsyncBatchAnnotate

type Scopes VisionProjectsFilesAsyncBatchAnnotate = '[CloudPlatform'FullControl, CloudVision'FullControl]

newVisionProjectsFilesAsyncBatchAnnotate Source #

Arguments

:: 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`. See `parent`.
-> GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest	Multipart request metadata. See `payload`.
-> VisionProjectsFilesAsyncBatchAnnotate

Creates a value of VisionProjectsFilesAsyncBatchAnnotate with the minimum fields required to make a request.