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

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

Inherited Members

DocumentServiceClient.DefaultEndpoint

DocumentServiceClient.DefaultScopes

DocumentServiceClient.ServiceMetadata

DocumentServiceClient.CreateAsync(CancellationToken)

DocumentServiceClient.Create()

DocumentServiceClient.ShutdownDefaultChannelsAsync()

DocumentServiceClient.UpdateDatasetAsync(UpdateDatasetRequest, CancellationToken)

DocumentServiceClient.PollOnceUpdateDataset(string, CallSettings)

DocumentServiceClient.PollOnceUpdateDatasetAsync(string, CallSettings)

DocumentServiceClient.UpdateDataset(Dataset, FieldMask, CallSettings)

DocumentServiceClient.UpdateDatasetAsync(Dataset, FieldMask, CallSettings)

DocumentServiceClient.UpdateDatasetAsync(Dataset, FieldMask, CancellationToken)

DocumentServiceClient.ImportDocumentsAsync(ImportDocumentsRequest, CancellationToken)

DocumentServiceClient.PollOnceImportDocuments(string, CallSettings)

DocumentServiceClient.PollOnceImportDocumentsAsync(string, CallSettings)

DocumentServiceClient.ImportDocuments(string, CallSettings)

DocumentServiceClient.ImportDocumentsAsync(string, CallSettings)

DocumentServiceClient.ImportDocumentsAsync(string, CancellationToken)

DocumentServiceClient.ImportDocuments(DatasetName, CallSettings)

DocumentServiceClient.ImportDocumentsAsync(DatasetName, CallSettings)

DocumentServiceClient.ImportDocumentsAsync(DatasetName, CancellationToken)

DocumentServiceClient.GetDocumentAsync(GetDocumentRequest, CancellationToken)

DocumentServiceClient.GetDocument(string, CallSettings)

DocumentServiceClient.GetDocumentAsync(string, CallSettings)

DocumentServiceClient.GetDocumentAsync(string, CancellationToken)

DocumentServiceClient.GetDocument(DatasetName, CallSettings)

DocumentServiceClient.GetDocumentAsync(DatasetName, CallSettings)

DocumentServiceClient.GetDocumentAsync(DatasetName, CancellationToken)

DocumentServiceClient.ListDocuments(string, string, int?, CallSettings)

DocumentServiceClient.ListDocumentsAsync(string, string, int?, CallSettings)

DocumentServiceClient.ListDocuments(DatasetName, string, int?, CallSettings)

DocumentServiceClient.ListDocumentsAsync(DatasetName, string, int?, CallSettings)

DocumentServiceClient.BatchDeleteDocumentsAsync(BatchDeleteDocumentsRequest, CancellationToken)

DocumentServiceClient.PollOnceBatchDeleteDocuments(string, CallSettings)

DocumentServiceClient.PollOnceBatchDeleteDocumentsAsync(string, CallSettings)

DocumentServiceClient.BatchDeleteDocuments(string, CallSettings)

DocumentServiceClient.BatchDeleteDocumentsAsync(string, CallSettings)

DocumentServiceClient.BatchDeleteDocumentsAsync(string, CancellationToken)

DocumentServiceClient.GetDatasetSchemaAsync(GetDatasetSchemaRequest, CancellationToken)

DocumentServiceClient.GetDatasetSchema(string, CallSettings)

DocumentServiceClient.GetDatasetSchemaAsync(string, CallSettings)

DocumentServiceClient.GetDatasetSchemaAsync(string, CancellationToken)

DocumentServiceClient.GetDatasetSchema(DatasetSchemaName, CallSettings)

DocumentServiceClient.GetDatasetSchemaAsync(DatasetSchemaName, CallSettings)

DocumentServiceClient.GetDatasetSchemaAsync(DatasetSchemaName, CancellationToken)

DocumentServiceClient.UpdateDatasetSchemaAsync(UpdateDatasetSchemaRequest, CancellationToken)

DocumentServiceClient.UpdateDatasetSchema(DatasetSchema, FieldMask, CallSettings)

DocumentServiceClient.UpdateDatasetSchemaAsync(DatasetSchema, FieldMask, CallSettings)

DocumentServiceClient.UpdateDatasetSchemaAsync(DatasetSchema, FieldMask, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

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

DocumentServiceClient.BatchDeleteDocumentsOperationsClient

GrpcClient

public override DocumentService.DocumentServiceClient GrpcClient { get; }

The underlying gRPC DocumentService client

Property Value
Type	Description
`DocumentServiceDocumentServiceClient`

Overrides

DocumentServiceClient.GrpcClient

ImportDocumentsOperationsClient

public override OperationsClient ImportDocumentsOperationsClient { get; }

The long-running operations client for ImportDocuments.

Property Value
Type	Description
`OperationsClient`

Overrides

DocumentServiceClient.ImportDocumentsOperationsClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
`LocationsClient`

Overrides

DocumentServiceClient.LocationsClient

UpdateDatasetOperationsClient

public override OperationsClient UpdateDatasetOperationsClient { get; }

The long-running operations client for UpdateDataset.

Property Value
Type	Description
`OperationsClient`

Overrides

DocumentServiceClient.UpdateDatasetOperationsClient

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

DocumentServiceClient.BatchDeleteDocuments(BatchDeleteDocumentsRequest, CallSettings)

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

DocumentServiceClient.BatchDeleteDocumentsAsync(BatchDeleteDocumentsRequest, CallSettings)

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

DocumentServiceClient.GetDatasetSchema(GetDatasetSchemaRequest, CallSettings)

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

DocumentServiceClient.GetDatasetSchemaAsync(GetDatasetSchemaRequest, CallSettings)

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

DocumentServiceClient.GetDocument(GetDocumentRequest, CallSettings)

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

DocumentServiceClient.GetDocumentAsync(GetDocumentRequest, CallSettings)

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

DocumentServiceClient.ImportDocuments(ImportDocumentsRequest, CallSettings)

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

DocumentServiceClient.ImportDocumentsAsync(ImportDocumentsRequest, CallSettings)

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

DocumentServiceClient.ListDocuments(ListDocumentsRequest, CallSettings)

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

DocumentServiceClient.ListDocumentsAsync(ListDocumentsRequest, CallSettings)

UpdateDataset(UpdateDatasetRequest, CallSettings)

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

Updates metadata associated with a dataset.

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

DocumentServiceClient.UpdateDataset(UpdateDatasetRequest, CallSettings)

UpdateDatasetAsync(UpdateDatasetRequest, CallSettings)

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

Updates metadata associated with a dataset.

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

DocumentServiceClient.UpdateDatasetAsync(UpdateDatasetRequest, CallSettings)

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

DocumentServiceClient.UpdateDatasetSchema(UpdateDatasetSchemaRequest, CallSettings)

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

DocumentServiceClient.UpdateDatasetSchemaAsync(UpdateDatasetSchemaRequest, CallSettings)