Cloud Vision V1 Client - Class AsyncBatchAnnotateImagesRequest (1.8.0)

Reference documentation and code samples for the Cloud Vision V1 Client class AsyncBatchAnnotateImagesRequest.

Request for async image annotation for a list of images.

Generated from protobuf message google.cloud.vision.v1.AsyncBatchAnnotateImagesRequest

Namespace

Google \ Cloud \ Vision \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ requests array<Google\Cloud\Vision\V1\AnnotateImageRequest>

Required. Individual image annotation requests for this batch.

↳ output_config Google\Cloud\Vision\V1\OutputConfig

Required. The desired output location and metadata (e.g. format).

↳ parent string

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.

getRequests

Required. Individual image annotation requests for this batch.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setRequests

Required. Individual image annotation requests for this batch.

Parameter
NameDescription
var array<Google\Cloud\Vision\V1\AnnotateImageRequest>
Returns
TypeDescription
$this

getOutputConfig

Required. The desired output location and metadata (e.g. format).

Returns
TypeDescription
Google\Cloud\Vision\V1\OutputConfig|null

hasOutputConfig

clearOutputConfig

setOutputConfig

Required. The desired output location and metadata (e.g. format).

Parameter
NameDescription
var Google\Cloud\Vision\V1\OutputConfig
Returns
TypeDescription
$this

getParent

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.

Returns
TypeDescription
string

setParent

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
requests array<Google\Cloud\Vision\V1\AnnotateImageRequest>

Required. Individual image annotation requests for this batch.

outputConfig Google\Cloud\Vision\V1\OutputConfig

Required. The desired output location and metadata (e.g. format).

Returns
TypeDescription
Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest