Cloud Vision V1 Client - Class AsyncBatchAnnotateImagesRequest (1.10.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
Name	Description
`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`.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

getRequests

Required. Individual image annotation requests for this batch.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setRequests

Required. Individual image annotation requests for this batch.

Parameter
Name	Description
`var`	`array<Google\Cloud\Vision\V1\AnnotateImageRequest>`

Returns
Type	Description
`$this`

getOutputConfig

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

Returns
Type	Description
`Google\Cloud\Vision\V1\OutputConfig\|null`

hasOutputConfig

clearOutputConfig

setOutputConfig

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

Parameter
Name	Description
`var`	`Google\Cloud\Vision\V1\OutputConfig`

Returns
Type	Description
`$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
Type	Description
`string`

setParent

Optional. Target project and location to make a call.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLabels

Optional. The labels with user-defined metadata for the request.

Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

Optional. The labels with user-defined metadata for the request.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`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
Type	Description
`Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest`