Google Cloud Vision v1 API - Class ImageAnnotator.ImageAnnotatorClient (3.3.0-beta01)

public class ImageAnnotatorClient : ClientBase<ImageAnnotator.ImageAnnotatorClient>

Reference documentation and code samples for the Google Cloud Vision v1 API class ImageAnnotator.ImageAnnotatorClient.

Client for ImageAnnotator

Inheritance

Object > ClientBase > ClientBase<ImageAnnotator.ImageAnnotatorClient> > ImageAnnotator.ImageAnnotatorClient

Inherited Members

ClientBase<ImageAnnotator.ImageAnnotatorClient>.WithHost(String)

ClientBase.CallInvoker

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Vision.V1

Assembly

Google.Cloud.Vision.V1.dll

Constructors

ImageAnnotatorClient()

protected ImageAnnotatorClient()

Protected parameterless constructor to allow creation of test doubles.

ImageAnnotatorClient(CallInvoker)

public ImageAnnotatorClient(CallInvoker callInvoker)

Creates a new client for ImageAnnotator that uses a custom CallInvoker.

Parameter
Name	Description
`callInvoker`	`CallInvoker` The callInvoker to use to make remote calls.

ImageAnnotatorClient(ChannelBase)

public ImageAnnotatorClient(ChannelBase channel)

Creates a new client for ImageAnnotator

Parameter
Name	Description
`channel`	`ChannelBase` The channel to use to make remote calls.

ImageAnnotatorClient(ClientBase.ClientBaseConfiguration)

protected ImageAnnotatorClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
`configuration`	`ClientBase.ClientBaseConfiguration` The client configuration.

Methods

AsyncBatchAnnotateFiles(AsyncBatchAnnotateFilesRequest, CallOptions)

public virtual Operation AsyncBatchAnnotateFiles(AsyncBatchAnnotateFilesRequest request, CallOptions options)

Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the google.longrunning.Operations interface. Operation.metadata contains OperationMetadata (metadata). Operation.response contains AsyncBatchAnnotateFilesResponse (results).

Parameters
Name	Description
`request`	`AsyncBatchAnnotateFilesRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

AsyncBatchAnnotateFiles(AsyncBatchAnnotateFilesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation AsyncBatchAnnotateFiles(AsyncBatchAnnotateFilesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters
Name	Description
`request`	`AsyncBatchAnnotateFilesRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

AsyncBatchAnnotateFilesAsync(AsyncBatchAnnotateFilesRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> AsyncBatchAnnotateFilesAsync(AsyncBatchAnnotateFilesRequest request, CallOptions options)

Parameters
Name	Description
`request`	`AsyncBatchAnnotateFilesRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

AsyncBatchAnnotateFilesAsync(AsyncBatchAnnotateFilesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> AsyncBatchAnnotateFilesAsync(AsyncBatchAnnotateFilesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters
Name	Description
`request`	`AsyncBatchAnnotateFilesRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

AsyncBatchAnnotateImages(AsyncBatchAnnotateImagesRequest, CallOptions)

public virtual Operation AsyncBatchAnnotateImages(AsyncBatchAnnotateImagesRequest request, CallOptions options)

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.

Parameters
Name	Description
`request`	`AsyncBatchAnnotateImagesRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

AsyncBatchAnnotateImages(AsyncBatchAnnotateImagesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation AsyncBatchAnnotateImages(AsyncBatchAnnotateImagesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Run asynchronous image detection and annotation for a list of images.

This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.

Parameters
Name	Description
`request`	`AsyncBatchAnnotateImagesRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

AsyncBatchAnnotateImagesAsync(AsyncBatchAnnotateImagesRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> AsyncBatchAnnotateImagesAsync(AsyncBatchAnnotateImagesRequest request, CallOptions options)

Run asynchronous image detection and annotation for a list of images.

This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.

Parameters
Name	Description
`request`	`AsyncBatchAnnotateImagesRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

AsyncBatchAnnotateImagesAsync(AsyncBatchAnnotateImagesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> AsyncBatchAnnotateImagesAsync(AsyncBatchAnnotateImagesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Run asynchronous image detection and annotation for a list of images.

This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.

Parameters
Name	Description
`request`	`AsyncBatchAnnotateImagesRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

BatchAnnotateFiles(BatchAnnotateFilesRequest, CallOptions)

public virtual BatchAnnotateFilesResponse BatchAnnotateFiles(BatchAnnotateFilesRequest request, CallOptions options)

Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported.

This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.

Parameters
Name	Description
`request`	`BatchAnnotateFilesRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`BatchAnnotateFilesResponse`	The response received from the server.

BatchAnnotateFiles(BatchAnnotateFilesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual BatchAnnotateFilesResponse BatchAnnotateFiles(BatchAnnotateFilesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported.

Parameters
Name	Description
`request`	`BatchAnnotateFilesRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`BatchAnnotateFilesResponse`	The response received from the server.

BatchAnnotateFilesAsync(BatchAnnotateFilesRequest, CallOptions)

public virtual AsyncUnaryCall<BatchAnnotateFilesResponse> BatchAnnotateFilesAsync(BatchAnnotateFilesRequest request, CallOptions options)

Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported.

Parameters
Name	Description
`request`	`BatchAnnotateFilesRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<BatchAnnotateFilesResponse>`	The call object.

BatchAnnotateFilesAsync(BatchAnnotateFilesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<BatchAnnotateFilesResponse> BatchAnnotateFilesAsync(BatchAnnotateFilesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported.

Parameters
Name	Description
`request`	`BatchAnnotateFilesRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<BatchAnnotateFilesResponse>`	The call object.

BatchAnnotateImages(BatchAnnotateImagesRequest, CallOptions)

public virtual BatchAnnotateImagesResponse BatchAnnotateImages(BatchAnnotateImagesRequest request, CallOptions options)

Run image detection and annotation for a batch of images.

Parameters
Name	Description
`request`	`BatchAnnotateImagesRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`BatchAnnotateImagesResponse`	The response received from the server.

BatchAnnotateImages(BatchAnnotateImagesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual BatchAnnotateImagesResponse BatchAnnotateImages(BatchAnnotateImagesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Run image detection and annotation for a batch of images.

Parameters
Name	Description
`request`	`BatchAnnotateImagesRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`BatchAnnotateImagesResponse`	The response received from the server.

BatchAnnotateImagesAsync(BatchAnnotateImagesRequest, CallOptions)

public virtual AsyncUnaryCall<BatchAnnotateImagesResponse> BatchAnnotateImagesAsync(BatchAnnotateImagesRequest request, CallOptions options)

Run image detection and annotation for a batch of images.

Parameters
Name	Description
`request`	`BatchAnnotateImagesRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<BatchAnnotateImagesResponse>`	The call object.

BatchAnnotateImagesAsync(BatchAnnotateImagesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<BatchAnnotateImagesResponse> BatchAnnotateImagesAsync(BatchAnnotateImagesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Run image detection and annotation for a batch of images.

Parameters
Name	Description
`request`	`BatchAnnotateImagesRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<BatchAnnotateImagesResponse>`	The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
`Operations.OperationsClient`	A new Operations client for the same target as this client.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override ImageAnnotator.ImageAnnotatorClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`ClientBase.ClientBaseConfiguration`

Returns
Type	Description
`ImageAnnotator.ImageAnnotatorClient`

Overrides

Grpc.Core.ClientBase<Google.Cloud.Vision.V1.ImageAnnotator.ImageAnnotatorClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)