Reference documentation and code samples for the Cloud Vision V1 Client class BatchAnnotateFilesRequest.
A list of requests to annotate files using the BatchAnnotateFiles API.
Generated from protobuf message google.cloud.vision.v1.BatchAnnotateFilesRequest
Namespace
Google \ Cloud \ Vision \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ requests |
array<Google\Cloud\Vision\V1\AnnotateFileRequest>
Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest. |
↳ parent |
string
Optional. Target project and location to make a call. Format: |
↳ 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. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setRequests
Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Vision\V1\AnnotateFileRequest>
|
| 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.
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 | |
|---|---|
| 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.
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
requests |
array<Google\Cloud\Vision\V1\AnnotateFileRequest>
Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Vision\V1\BatchAnnotateFilesRequest |
|