Cloud Document AI v1beta3 API - Class DocumentServiceClientImpl (2.0.0-beta23)

public sealed class DocumentServiceClientImpl : DocumentServiceClient

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

DocumentService client wrapper implementation, for convenient use.

Inheritance

object > DocumentServiceClient > DocumentServiceClientImpl

Namespace

Google.Cloud.DocumentAI.V1Beta3

Assembly

Google.Cloud.DocumentAI.V1Beta3.dll

Remarks

Service to call Cloud DocumentAI to manage document collection (dataset).

Constructors

DocumentServiceClientImpl(DocumentServiceClient, DocumentServiceSettings, ILogger)

public DocumentServiceClientImpl(DocumentService.DocumentServiceClient grpcClient, DocumentServiceSettings settings, ILogger logger)

Constructs a client wrapper for the DocumentService service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient DocumentServiceDocumentServiceClient

The underlying gRPC client.

settings DocumentServiceSettings

The base DocumentServiceSettings used within this client.

logger ILogger

Optional ILogger to use within this client.

Properties

BatchDeleteDocumentsOperationsClient

public override OperationsClient BatchDeleteDocumentsOperationsClient { get; }

The long-running operations client for BatchDeleteDocuments.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override DocumentService.DocumentServiceClient GrpcClient { get; }

The underlying gRPC DocumentService client

Property Value
Type Description
DocumentServiceDocumentServiceClient
Overrides

ImportDocumentsOperationsClient

public override OperationsClient ImportDocumentsOperationsClient { get; }

The long-running operations client for ImportDocuments.

Property Value
Type Description
OperationsClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

UpdateDatasetOperationsClient

public override OperationsClient UpdateDatasetOperationsClient { get; }

The long-running operations client for UpdateDataset.

Property Value
Type Description
OperationsClient
Overrides

Methods

BatchDeleteDocuments(BatchDeleteDocumentsRequest, CallSettings)

public override Operation<BatchDeleteDocumentsResponse, BatchDeleteDocumentsMetadata> BatchDeleteDocuments(BatchDeleteDocumentsRequest request, CallSettings callSettings = null)

Deletes a set of documents.

Parameters
Name Description
request BatchDeleteDocumentsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationBatchDeleteDocumentsResponseBatchDeleteDocumentsMetadata

The RPC response.

Overrides

BatchDeleteDocumentsAsync(BatchDeleteDocumentsRequest, CallSettings)

public override Task<Operation<BatchDeleteDocumentsResponse, BatchDeleteDocumentsMetadata>> BatchDeleteDocumentsAsync(BatchDeleteDocumentsRequest request, CallSettings callSettings = null)

Deletes a set of documents.

Parameters
Name Description
request BatchDeleteDocumentsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationBatchDeleteDocumentsResponseBatchDeleteDocumentsMetadata

A Task containing the RPC response.

Overrides

GetDatasetSchema(GetDatasetSchemaRequest, CallSettings)

public override DatasetSchema GetDatasetSchema(GetDatasetSchemaRequest request, CallSettings callSettings = null)

Gets the DatasetSchema of a Dataset.

Parameters
Name Description
request GetDatasetSchemaRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DatasetSchema

The RPC response.

Overrides

GetDatasetSchemaAsync(GetDatasetSchemaRequest, CallSettings)

public override Task<DatasetSchema> GetDatasetSchemaAsync(GetDatasetSchemaRequest request, CallSettings callSettings = null)

Gets the DatasetSchema of a Dataset.

Parameters
Name Description
request GetDatasetSchemaRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDatasetSchema

A Task containing the RPC response.

Overrides

GetDocument(GetDocumentRequest, CallSettings)

public override GetDocumentResponse GetDocument(GetDocumentRequest request, CallSettings callSettings = null)

Returns relevant fields present in the requested document.

Parameters
Name Description
request GetDocumentRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
GetDocumentResponse

The RPC response.

Overrides

GetDocumentAsync(GetDocumentRequest, CallSettings)

public override Task<GetDocumentResponse> GetDocumentAsync(GetDocumentRequest request, CallSettings callSettings = null)

Returns relevant fields present in the requested document.

Parameters
Name Description
request GetDocumentRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskGetDocumentResponse

A Task containing the RPC response.

Overrides

ImportDocuments(ImportDocumentsRequest, CallSettings)

public override Operation<ImportDocumentsResponse, ImportDocumentsMetadata> ImportDocuments(ImportDocumentsRequest request, CallSettings callSettings = null)

Import documents into a dataset.

Parameters
Name Description
request ImportDocumentsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationImportDocumentsResponseImportDocumentsMetadata

The RPC response.

Overrides

ImportDocumentsAsync(ImportDocumentsRequest, CallSettings)

public override Task<Operation<ImportDocumentsResponse, ImportDocumentsMetadata>> ImportDocumentsAsync(ImportDocumentsRequest request, CallSettings callSettings = null)

Import documents into a dataset.

Parameters
Name Description
request ImportDocumentsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationImportDocumentsResponseImportDocumentsMetadata

A Task containing the RPC response.

Overrides

ListDocuments(ListDocumentsRequest, CallSettings)

public override PagedEnumerable<ListDocumentsResponse, DocumentMetadata> ListDocuments(ListDocumentsRequest request, CallSettings callSettings = null)

Returns a list of documents present in the dataset.

Parameters
Name Description
request ListDocumentsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListDocumentsResponseDocumentMetadata

A pageable sequence of DocumentMetadata resources.

Overrides

ListDocumentsAsync(ListDocumentsRequest, CallSettings)

public override PagedAsyncEnumerable<ListDocumentsResponse, DocumentMetadata> ListDocumentsAsync(ListDocumentsRequest request, CallSettings callSettings = null)

Returns a list of documents present in the dataset.

Parameters
Name Description
request ListDocumentsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListDocumentsResponseDocumentMetadata

A pageable asynchronous sequence of DocumentMetadata resources.

Overrides

UpdateDataset(UpdateDatasetRequest, CallSettings)

public override Operation<Dataset, UpdateDatasetOperationMetadata> UpdateDataset(UpdateDatasetRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationDatasetUpdateDatasetOperationMetadata

The RPC response.

Overrides

UpdateDatasetAsync(UpdateDatasetRequest, CallSettings)

public override Task<Operation<Dataset, UpdateDatasetOperationMetadata>> UpdateDatasetAsync(UpdateDatasetRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationDatasetUpdateDatasetOperationMetadata

A Task containing the RPC response.

Overrides

UpdateDatasetSchema(UpdateDatasetSchemaRequest, CallSettings)

public override DatasetSchema UpdateDatasetSchema(UpdateDatasetSchemaRequest request, CallSettings callSettings = null)

Updates a DatasetSchema.

Parameters
Name Description
request UpdateDatasetSchemaRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DatasetSchema

The RPC response.

Overrides

UpdateDatasetSchemaAsync(UpdateDatasetSchemaRequest, CallSettings)

public override Task<DatasetSchema> UpdateDatasetSchemaAsync(UpdateDatasetSchemaRequest request, CallSettings callSettings = null)

Updates a DatasetSchema.

Parameters
Name Description
request UpdateDatasetSchemaRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDatasetSchema

A Task containing the RPC response.

Overrides