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.Locations.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.locations.files.asyncBatchAnnotate.

Synopsis

type VisionProjectsLocationsFilesAsyncBatchAnnotateResource = "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 VisionProjectsLocationsFilesAsyncBatchAnnotate = VisionProjectsLocationsFilesAsyncBatchAnnotate {
- xgafv :: Maybe Xgafv
- accessToken :: Maybe Text
- callback :: Maybe Text
- parent :: Text
- payload :: GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest
- uploadType :: Maybe Text
- uploadProtocol :: Maybe Text
}
newVisionProjectsLocationsFilesAsyncBatchAnnotate :: Text -> GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest -> VisionProjectsLocationsFilesAsyncBatchAnnotate

Resource

type VisionProjectsLocationsFilesAsyncBatchAnnotateResource = "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.locations.files.asyncBatchAnnotate method which the VisionProjectsLocationsFilesAsyncBatchAnnotate request conforms to.

Constructing a Request

data VisionProjectsLocationsFilesAsyncBatchAnnotate 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: newVisionProjectsLocationsFilesAsyncBatchAnnotate smart constructor.

Constructors

VisionProjectsLocationsFilesAsyncBatchAnnotate

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 VisionProjectsLocationsFilesAsyncBatchAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Locations.Files.AsyncBatchAnnotate

Associated Types

type Rep VisionProjectsLocationsFilesAsyncBatchAnnotate

Instance details

Defined in Gogol.Vision.Projects.Locations.Files.AsyncBatchAnnotate

type Rep VisionProjectsLocationsFilesAsyncBatchAnnotate = D1 ('MetaData "VisionProjectsLocationsFilesAsyncBatchAnnotate" "Gogol.Vision.Projects.Locations.Files.AsyncBatchAnnotate" "gogol-vision-1.0.0-5I8flikCegP9Y27tYWivCE" 'False) (C1 ('MetaCons "VisionProjectsLocationsFilesAsyncBatchAnnotate" '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 :: VisionProjectsLocationsFilesAsyncBatchAnnotate -> Rep VisionProjectsLocationsFilesAsyncBatchAnnotate x #

to :: Rep VisionProjectsLocationsFilesAsyncBatchAnnotate x -> VisionProjectsLocationsFilesAsyncBatchAnnotate #

Show VisionProjectsLocationsFilesAsyncBatchAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Locations.Files.AsyncBatchAnnotate

Methods

showsPrec :: Int -> VisionProjectsLocationsFilesAsyncBatchAnnotate -> ShowS #

show :: VisionProjectsLocationsFilesAsyncBatchAnnotate -> String #

showList :: [VisionProjectsLocationsFilesAsyncBatchAnnotate] -> ShowS #

Eq VisionProjectsLocationsFilesAsyncBatchAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Locations.Files.AsyncBatchAnnotate

Methods

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

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

GoogleRequest VisionProjectsLocationsFilesAsyncBatchAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Locations.Files.AsyncBatchAnnotate

Associated Types

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

Methods

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

type Rep VisionProjectsLocationsFilesAsyncBatchAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Locations.Files.AsyncBatchAnnotate

type Rep VisionProjectsLocationsFilesAsyncBatchAnnotate = D1 ('MetaData "VisionProjectsLocationsFilesAsyncBatchAnnotate" "Gogol.Vision.Projects.Locations.Files.AsyncBatchAnnotate" "gogol-vision-1.0.0-5I8flikCegP9Y27tYWivCE" 'False) (C1 ('MetaCons "VisionProjectsLocationsFilesAsyncBatchAnnotate" '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 VisionProjectsLocationsFilesAsyncBatchAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Locations.Files.AsyncBatchAnnotate

type Rs VisionProjectsLocationsFilesAsyncBatchAnnotate = Operation

type Scopes VisionProjectsLocationsFilesAsyncBatchAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Locations.Files.AsyncBatchAnnotate

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

newVisionProjectsLocationsFilesAsyncBatchAnnotate 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`.
-> VisionProjectsLocationsFilesAsyncBatchAnnotate

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