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.Images.AsyncBatchAnnotate

Contents

Resource
- Constructing a Request

Description

Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the google.longrunning.Operations interface. Operation.metadata contains OperationMetadata (metadata). Operation.response contains AsyncBatchAnnotateImagesResponse (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.

See: Cloud Vision API Reference for vision.projects.images.asyncBatchAnnotate.

Synopsis

type VisionProjectsImagesAsyncBatchAnnotateResource = "v1p2beta1" :> (Capture "parent" Text :> ("images:asyncBatchAnnotate" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] GoogleCloudVisionV1p2beta1AsyncBatchAnnotateImagesRequest :> Post '[JSON] Operation)))))))))
data VisionProjectsImagesAsyncBatchAnnotate = VisionProjectsImagesAsyncBatchAnnotate {
- xgafv :: Maybe Xgafv
- accessToken :: Maybe Text
- callback :: Maybe Text
- parent :: Text
- payload :: GoogleCloudVisionV1p2beta1AsyncBatchAnnotateImagesRequest
- uploadType :: Maybe Text
- uploadProtocol :: Maybe Text
}
newVisionProjectsImagesAsyncBatchAnnotate :: Text -> GoogleCloudVisionV1p2beta1AsyncBatchAnnotateImagesRequest -> VisionProjectsImagesAsyncBatchAnnotate

Resource

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

A resource alias for vision.projects.images.asyncBatchAnnotate method which the VisionProjectsImagesAsyncBatchAnnotate request conforms to.

Constructing a Request

data VisionProjectsImagesAsyncBatchAnnotate Source #

Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the google.longrunning.Operations interface. Operation.metadata contains OperationMetadata (metadata). Operation.response contains AsyncBatchAnnotateImagesResponse (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.

See: newVisionProjectsImagesAsyncBatchAnnotate smart constructor.

Constructors

VisionProjectsImagesAsyncBatchAnnotate

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 :: GoogleCloudVisionV1p2beta1AsyncBatchAnnotateImagesRequest
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 VisionProjectsImagesAsyncBatchAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Images.AsyncBatchAnnotate

Associated Types

type Rep VisionProjectsImagesAsyncBatchAnnotate

Instance details

Defined in Gogol.Vision.Projects.Images.AsyncBatchAnnotate

type Rep VisionProjectsImagesAsyncBatchAnnotate = D1 ('MetaData "VisionProjectsImagesAsyncBatchAnnotate" "Gogol.Vision.Projects.Images.AsyncBatchAnnotate" "gogol-vision-1.0.0-5I8flikCegP9Y27tYWivCE" 'False) (C1 ('MetaCons "VisionProjectsImagesAsyncBatchAnnotate" '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 GoogleCloudVisionV1p2beta1AsyncBatchAnnotateImagesRequest)) :*: (S1 ('MetaSel ('Just "uploadType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "uploadProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

Methods

from :: VisionProjectsImagesAsyncBatchAnnotate -> Rep VisionProjectsImagesAsyncBatchAnnotate x #

to :: Rep VisionProjectsImagesAsyncBatchAnnotate x -> VisionProjectsImagesAsyncBatchAnnotate #

Show VisionProjectsImagesAsyncBatchAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Images.AsyncBatchAnnotate

Methods

showsPrec :: Int -> VisionProjectsImagesAsyncBatchAnnotate -> ShowS #

show :: VisionProjectsImagesAsyncBatchAnnotate -> String #

showList :: [VisionProjectsImagesAsyncBatchAnnotate] -> ShowS #

Eq VisionProjectsImagesAsyncBatchAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Images.AsyncBatchAnnotate

Methods

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

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

GoogleRequest VisionProjectsImagesAsyncBatchAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Images.AsyncBatchAnnotate

Associated Types

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

Methods

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

type Rep VisionProjectsImagesAsyncBatchAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Images.AsyncBatchAnnotate

type Rep VisionProjectsImagesAsyncBatchAnnotate = D1 ('MetaData "VisionProjectsImagesAsyncBatchAnnotate" "Gogol.Vision.Projects.Images.AsyncBatchAnnotate" "gogol-vision-1.0.0-5I8flikCegP9Y27tYWivCE" 'False) (C1 ('MetaCons "VisionProjectsImagesAsyncBatchAnnotate" '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 GoogleCloudVisionV1p2beta1AsyncBatchAnnotateImagesRequest)) :*: (S1 ('MetaSel ('Just "uploadType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "uploadProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

type Rs VisionProjectsImagesAsyncBatchAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Images.AsyncBatchAnnotate

type Rs VisionProjectsImagesAsyncBatchAnnotate = Operation

type Scopes VisionProjectsImagesAsyncBatchAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Images.AsyncBatchAnnotate

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

newVisionProjectsImagesAsyncBatchAnnotate 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`.
-> GoogleCloudVisionV1p2beta1AsyncBatchAnnotateImagesRequest	Multipart request metadata. See `payload`.
-> VisionProjectsImagesAsyncBatchAnnotate

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