Cloud Document AI v1beta3 API - Class DocumentService.DocumentServiceClient (2.0.0-beta21)

public class DocumentService.DocumentServiceClient : ClientBase<DocumentService.DocumentServiceClient>

Reference documentation and code samples for the Cloud Document AI v1beta3 API class DocumentService.DocumentServiceClient.

Client for DocumentService

Inheritance

object > ClientBase > ClientBaseDocumentServiceDocumentServiceClient > DocumentService.DocumentServiceClient

Namespace

Google.Cloud.DocumentAI.V1Beta3

Assembly

Google.Cloud.DocumentAI.V1Beta3.dll

Constructors

DocumentServiceClient()

protected DocumentServiceClient()

Protected parameterless constructor to allow creation of test doubles.

DocumentServiceClient(CallInvoker)

public DocumentServiceClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

DocumentServiceClient(ChannelBase)

public DocumentServiceClient(ChannelBase channel)

Creates a new client for DocumentService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

DocumentServiceClient(ClientBaseConfiguration)

protected DocumentServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

BatchDeleteDocuments(BatchDeleteDocumentsRequest, CallOptions)

public virtual Operation BatchDeleteDocuments(BatchDeleteDocumentsRequest request, CallOptions options)

Deletes a set of documents.

Parameters
Name Description
request BatchDeleteDocumentsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

BatchDeleteDocuments(BatchDeleteDocumentsRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a set of documents.

Parameters
Name Description
request BatchDeleteDocumentsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.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.

BatchDeleteDocumentsAsync(BatchDeleteDocumentsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> BatchDeleteDocumentsAsync(BatchDeleteDocumentsRequest request, CallOptions options)

Deletes a set of documents.

Parameters
Name Description
request BatchDeleteDocumentsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

BatchDeleteDocumentsAsync(BatchDeleteDocumentsRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a set of documents.

Parameters
Name Description
request BatchDeleteDocumentsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.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
AsyncUnaryCallOperation

The call object.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type Description
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

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

Returns
Type Description
OperationsOperationsClient

A new Operations client for the same target as this client.

GetDatasetSchema(GetDatasetSchemaRequest, CallOptions)

public virtual DatasetSchema GetDatasetSchema(GetDatasetSchemaRequest request, CallOptions options)

Gets the DatasetSchema of a Dataset.

Parameters
Name Description
request GetDatasetSchemaRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
DatasetSchema

The response received from the server.

GetDatasetSchema(GetDatasetSchemaRequest, Metadata, DateTime?, CancellationToken)

public virtual DatasetSchema GetDatasetSchema(GetDatasetSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the DatasetSchema of a Dataset.

Parameters
Name Description
request GetDatasetSchemaRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.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
DatasetSchema

The response received from the server.

GetDatasetSchemaAsync(GetDatasetSchemaRequest, CallOptions)

public virtual AsyncUnaryCall<DatasetSchema> GetDatasetSchemaAsync(GetDatasetSchemaRequest request, CallOptions options)

Gets the DatasetSchema of a Dataset.

Parameters
Name Description
request GetDatasetSchemaRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallDatasetSchema

The call object.

GetDatasetSchemaAsync(GetDatasetSchemaRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DatasetSchema> GetDatasetSchemaAsync(GetDatasetSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the DatasetSchema of a Dataset.

Parameters
Name Description
request GetDatasetSchemaRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.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
AsyncUnaryCallDatasetSchema

The call object.

GetDocument(GetDocumentRequest, CallOptions)

public virtual GetDocumentResponse GetDocument(GetDocumentRequest request, CallOptions options)

Returns relevant fields present in the requested document.

Parameters
Name Description
request GetDocumentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
GetDocumentResponse

The response received from the server.

GetDocument(GetDocumentRequest, Metadata, DateTime?, CancellationToken)

public virtual GetDocumentResponse GetDocument(GetDocumentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns relevant fields present in the requested document.

Parameters
Name Description
request GetDocumentRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.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
GetDocumentResponse

The response received from the server.

GetDocumentAsync(GetDocumentRequest, CallOptions)

public virtual AsyncUnaryCall<GetDocumentResponse> GetDocumentAsync(GetDocumentRequest request, CallOptions options)

Returns relevant fields present in the requested document.

Parameters
Name Description
request GetDocumentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallGetDocumentResponse

The call object.

GetDocumentAsync(GetDocumentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<GetDocumentResponse> GetDocumentAsync(GetDocumentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns relevant fields present in the requested document.

Parameters
Name Description
request GetDocumentRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.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
AsyncUnaryCallGetDocumentResponse

The call object.

ImportDocuments(ImportDocumentsRequest, CallOptions)

public virtual Operation ImportDocuments(ImportDocumentsRequest request, CallOptions options)

Import documents into a dataset.

Parameters
Name Description
request ImportDocumentsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

ImportDocuments(ImportDocumentsRequest, Metadata, DateTime?, CancellationToken)

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

Import documents into a dataset.

Parameters
Name Description
request ImportDocumentsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.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.

ImportDocumentsAsync(ImportDocumentsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ImportDocumentsAsync(ImportDocumentsRequest request, CallOptions options)

Import documents into a dataset.

Parameters
Name Description
request ImportDocumentsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

ImportDocumentsAsync(ImportDocumentsRequest, Metadata, DateTime?, CancellationToken)

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

Import documents into a dataset.

Parameters
Name Description
request ImportDocumentsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.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
AsyncUnaryCallOperation

The call object.

ListDocuments(ListDocumentsRequest, CallOptions)

public virtual ListDocumentsResponse ListDocuments(ListDocumentsRequest request, CallOptions options)

Returns a list of documents present in the dataset.

Parameters
Name Description
request ListDocumentsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListDocumentsResponse

The response received from the server.

ListDocuments(ListDocumentsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListDocumentsResponse ListDocuments(ListDocumentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns a list of documents present in the dataset.

Parameters
Name Description
request ListDocumentsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.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
ListDocumentsResponse

The response received from the server.

ListDocumentsAsync(ListDocumentsRequest, CallOptions)

public virtual AsyncUnaryCall<ListDocumentsResponse> ListDocumentsAsync(ListDocumentsRequest request, CallOptions options)

Returns a list of documents present in the dataset.

Parameters
Name Description
request ListDocumentsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListDocumentsResponse

The call object.

ListDocumentsAsync(ListDocumentsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListDocumentsResponse> ListDocumentsAsync(ListDocumentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns a list of documents present in the dataset.

Parameters
Name Description
request ListDocumentsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.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
AsyncUnaryCallListDocumentsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override DocumentService.DocumentServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
DocumentServiceDocumentServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.DocumentAI.V1Beta3.DocumentService.DocumentServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateDataset(UpdateDatasetRequest, CallOptions)

public virtual Operation UpdateDataset(UpdateDatasetRequest request, CallOptions options)

Updates metadata associated with a dataset. Note that this method requires the documentai.googleapis.com/datasets.update permission on the project, which is highly privileged. A user or service account with this permission can create new processors that can interact with any gcs bucket in your project.

Parameters
Name Description
request UpdateDatasetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

UpdateDataset(UpdateDatasetRequest, Metadata, DateTime?, CancellationToken)

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

Updates metadata associated with a dataset. Note that this method requires the documentai.googleapis.com/datasets.update permission on the project, which is highly privileged. A user or service account with this permission can create new processors that can interact with any gcs bucket in your project.

Parameters
Name Description
request UpdateDatasetRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.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.

UpdateDatasetAsync(UpdateDatasetRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateDatasetAsync(UpdateDatasetRequest request, CallOptions options)

Updates metadata associated with a dataset. Note that this method requires the documentai.googleapis.com/datasets.update permission on the project, which is highly privileged. A user or service account with this permission can create new processors that can interact with any gcs bucket in your project.

Parameters
Name Description
request UpdateDatasetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateDatasetAsync(UpdateDatasetRequest, Metadata, DateTime?, CancellationToken)

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

Updates metadata associated with a dataset. Note that this method requires the documentai.googleapis.com/datasets.update permission on the project, which is highly privileged. A user or service account with this permission can create new processors that can interact with any gcs bucket in your project.

Parameters
Name Description
request UpdateDatasetRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.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
AsyncUnaryCallOperation

The call object.

UpdateDatasetSchema(UpdateDatasetSchemaRequest, CallOptions)

public virtual DatasetSchema UpdateDatasetSchema(UpdateDatasetSchemaRequest request, CallOptions options)

Updates a DatasetSchema.

Parameters
Name Description
request UpdateDatasetSchemaRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
DatasetSchema

The response received from the server.

UpdateDatasetSchema(UpdateDatasetSchemaRequest, Metadata, DateTime?, CancellationToken)

public virtual DatasetSchema UpdateDatasetSchema(UpdateDatasetSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a DatasetSchema.

Parameters
Name Description
request UpdateDatasetSchemaRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.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
DatasetSchema

The response received from the server.

UpdateDatasetSchemaAsync(UpdateDatasetSchemaRequest, CallOptions)

public virtual AsyncUnaryCall<DatasetSchema> UpdateDatasetSchemaAsync(UpdateDatasetSchemaRequest request, CallOptions options)

Updates a DatasetSchema.

Parameters
Name Description
request UpdateDatasetSchemaRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallDatasetSchema

The call object.

UpdateDatasetSchemaAsync(UpdateDatasetSchemaRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DatasetSchema> UpdateDatasetSchemaAsync(UpdateDatasetSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a DatasetSchema.

Parameters
Name Description
request UpdateDatasetSchemaRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.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
AsyncUnaryCallDatasetSchema

The call object.