ImageAnnotator

google.cloud.vision.v1. ImageAnnotator

Represents an ImageAnnotator

Constructor

new ImageAnnotator(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new ImageAnnotator service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

asyncBatchAnnotateFiles(request, callback) → {undefined}

Calls AsyncBatchAnnotateFiles.

Parameters:
Name Type Description
request google.cloud.vision.v1.IAsyncBatchAnnotateFilesRequest

AsyncBatchAnnotateFilesRequest message or plain object

callback google.cloud.vision.v1.ImageAnnotator.AsyncBatchAnnotateFilesCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

asyncBatchAnnotateFiles(request) → {Promise.<google.longrunning.Operation>}

Calls AsyncBatchAnnotateFiles.

Parameters:
Name Type Description
request google.cloud.vision.v1.IAsyncBatchAnnotateFilesRequest

AsyncBatchAnnotateFilesRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

asyncBatchAnnotateImages(request, callback) → {undefined}

Calls AsyncBatchAnnotateImages.

Parameters:
Name Type Description
request google.cloud.vision.v1.IAsyncBatchAnnotateImagesRequest

AsyncBatchAnnotateImagesRequest message or plain object

callback google.cloud.vision.v1.ImageAnnotator.AsyncBatchAnnotateImagesCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

asyncBatchAnnotateImages(request) → {Promise.<google.longrunning.Operation>}

Calls AsyncBatchAnnotateImages.

Parameters:
Name Type Description
request google.cloud.vision.v1.IAsyncBatchAnnotateImagesRequest

AsyncBatchAnnotateImagesRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

batchAnnotateFiles(request, callback) → {undefined}

Calls BatchAnnotateFiles.

Parameters:
Name Type Description
request google.cloud.vision.v1.IBatchAnnotateFilesRequest

BatchAnnotateFilesRequest message or plain object

callback google.cloud.vision.v1.ImageAnnotator.BatchAnnotateFilesCallback

Node-style callback called with the error, if any, and BatchAnnotateFilesResponse

Returns:
Type Description
undefined

batchAnnotateFiles(request) → {Promise.<google.cloud.vision.v1.BatchAnnotateFilesResponse>}

Calls BatchAnnotateFiles.

Parameters:
Name Type Description
request google.cloud.vision.v1.IBatchAnnotateFilesRequest

BatchAnnotateFilesRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.vision.v1.BatchAnnotateFilesResponse>

Promise

batchAnnotateImages(request, callback) → {undefined}

Calls BatchAnnotateImages.

Parameters:
Name Type Description
request google.cloud.vision.v1.IBatchAnnotateImagesRequest

BatchAnnotateImagesRequest message or plain object

callback google.cloud.vision.v1.ImageAnnotator.BatchAnnotateImagesCallback

Node-style callback called with the error, if any, and BatchAnnotateImagesResponse

Returns:
Type Description
undefined

batchAnnotateImages(request) → {Promise.<google.cloud.vision.v1.BatchAnnotateImagesResponse>}

Calls BatchAnnotateImages.

Parameters:
Name Type Description
request google.cloud.vision.v1.IBatchAnnotateImagesRequest

BatchAnnotateImagesRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.vision.v1.BatchAnnotateImagesResponse>

Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {ImageAnnotator}

Creates new ImageAnnotator service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Returns:
Type Description
ImageAnnotator

RPC service. Useful where requests and/or responses are streamed.

Type Definitions

AsyncBatchAnnotateFilesCallback(error, responseopt)

Callback as used by asyncBatchAnnotateFiles.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

AsyncBatchAnnotateImagesCallback(error, responseopt)

Callback as used by asyncBatchAnnotateImages.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

BatchAnnotateFilesCallback(error, responseopt)

Callback as used by batchAnnotateFiles.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.vision.v1.BatchAnnotateFilesResponse <optional>

BatchAnnotateFilesResponse

BatchAnnotateImagesCallback(error, responseopt)

Callback as used by batchAnnotateImages.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.vision.v1.BatchAnnotateImagesResponse <optional>

BatchAnnotateImagesResponse