Class DocumentProcessorServiceConnection (2.34.0-rc)

Version latest

• 2.34.0-rc (latest)
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

The DocumentProcessorServiceConnection object for DocumentProcessorServiceClient.

This interface defines virtual methods for each of the user-facing overload sets in DocumentProcessorServiceClient. This allows users to inject custom behavior (e.g., with a Google Mock object) when writing tests that use objects of type DocumentProcessorServiceClient.

To create a concrete instance, see MakeDocumentProcessorServiceConnection().

For mocking, see documentai_v1_mocks::MockDocumentProcessorServiceConnection.

Functions

virtual options()

Returns
Type	Description
Options

virtual ProcessDocument(google::cloud::documentai::v1::ProcessRequest const &)

Parameter
Name	Description
request	google::cloud::documentai::v1::ProcessRequest const &

Returns
Type	Description
StatusOr< google::cloud::documentai::v1::ProcessResponse >

virtual BatchProcessDocuments(google::cloud::documentai::v1::BatchProcessRequest const &)

Parameter
Name	Description
request	google::cloud::documentai::v1::BatchProcessRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::documentai::v1::BatchProcessResponse > >

virtual BatchProcessDocuments(NoAwaitTag, google::cloud::documentai::v1::BatchProcessRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::documentai::v1::BatchProcessRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual BatchProcessDocuments(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::documentai::v1::BatchProcessResponse > >

virtual FetchProcessorTypes(google::cloud::documentai::v1::FetchProcessorTypesRequest const &)

Parameter
Name	Description
request	google::cloud::documentai::v1::FetchProcessorTypesRequest const &

Returns
Type	Description
StatusOr< google::cloud::documentai::v1::FetchProcessorTypesResponse >

virtual ListProcessorTypes(google::cloud::documentai::v1::ListProcessorTypesRequest)

Parameter
Name	Description
request	google::cloud::documentai::v1::ListProcessorTypesRequest

Returns
Type	Description
StreamRange< google::cloud::documentai::v1::ProcessorType >

virtual GetProcessorType(google::cloud::documentai::v1::GetProcessorTypeRequest const &)

Parameter
Name	Description
request	google::cloud::documentai::v1::GetProcessorTypeRequest const &

Returns
Type	Description
StatusOr< google::cloud::documentai::v1::ProcessorType >

virtual ListProcessors(google::cloud::documentai::v1::ListProcessorsRequest)

Parameter
Name	Description
request	google::cloud::documentai::v1::ListProcessorsRequest

Returns
Type	Description
StreamRange< google::cloud::documentai::v1::Processor >

virtual GetProcessor(google::cloud::documentai::v1::GetProcessorRequest const &)

Parameter
Name	Description
request	google::cloud::documentai::v1::GetProcessorRequest const &

Returns
Type	Description
StatusOr< google::cloud::documentai::v1::Processor >

virtual TrainProcessorVersion(google::cloud::documentai::v1::TrainProcessorVersionRequest const &)

Parameter
Name	Description
request	google::cloud::documentai::v1::TrainProcessorVersionRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::documentai::v1::TrainProcessorVersionResponse > >

virtual TrainProcessorVersion(NoAwaitTag, google::cloud::documentai::v1::TrainProcessorVersionRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::documentai::v1::TrainProcessorVersionRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual TrainProcessorVersion(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::documentai::v1::TrainProcessorVersionResponse > >

virtual GetProcessorVersion(google::cloud::documentai::v1::GetProcessorVersionRequest const &)

Parameter
Name	Description
request	google::cloud::documentai::v1::GetProcessorVersionRequest const &

Returns
Type	Description
StatusOr< google::cloud::documentai::v1::ProcessorVersion >

virtual ListProcessorVersions(google::cloud::documentai::v1::ListProcessorVersionsRequest)

Parameter
Name	Description
request	google::cloud::documentai::v1::ListProcessorVersionsRequest

Returns
Type	Description
StreamRange< google::cloud::documentai::v1::ProcessorVersion >

virtual DeleteProcessorVersion(google::cloud::documentai::v1::DeleteProcessorVersionRequest const &)

Parameter
Name	Description
request	google::cloud::documentai::v1::DeleteProcessorVersionRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::documentai::v1::DeleteProcessorVersionMetadata > >

virtual DeleteProcessorVersion(NoAwaitTag, google::cloud::documentai::v1::DeleteProcessorVersionRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::documentai::v1::DeleteProcessorVersionRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual DeleteProcessorVersion(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::documentai::v1::DeleteProcessorVersionMetadata > >

virtual DeployProcessorVersion(google::cloud::documentai::v1::DeployProcessorVersionRequest const &)

Parameter
Name	Description
request	google::cloud::documentai::v1::DeployProcessorVersionRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::documentai::v1::DeployProcessorVersionResponse > >

virtual DeployProcessorVersion(NoAwaitTag, google::cloud::documentai::v1::DeployProcessorVersionRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::documentai::v1::DeployProcessorVersionRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual DeployProcessorVersion(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::documentai::v1::DeployProcessorVersionResponse > >

virtual UndeployProcessorVersion(google::cloud::documentai::v1::UndeployProcessorVersionRequest const &)

Parameter
Name	Description
request	google::cloud::documentai::v1::UndeployProcessorVersionRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::documentai::v1::UndeployProcessorVersionResponse > >

virtual UndeployProcessorVersion(NoAwaitTag, google::cloud::documentai::v1::UndeployProcessorVersionRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::documentai::v1::UndeployProcessorVersionRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual UndeployProcessorVersion(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::documentai::v1::UndeployProcessorVersionResponse > >

virtual CreateProcessor(google::cloud::documentai::v1::CreateProcessorRequest const &)

Parameter
Name	Description
request	google::cloud::documentai::v1::CreateProcessorRequest const &

Returns
Type	Description
StatusOr< google::cloud::documentai::v1::Processor >

virtual DeleteProcessor(google::cloud::documentai::v1::DeleteProcessorRequest const &)

Parameter
Name	Description
request	google::cloud::documentai::v1::DeleteProcessorRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::documentai::v1::DeleteProcessorMetadata > >

virtual DeleteProcessor(NoAwaitTag, google::cloud::documentai::v1::DeleteProcessorRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::documentai::v1::DeleteProcessorRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual DeleteProcessor(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::documentai::v1::DeleteProcessorMetadata > >

virtual EnableProcessor(google::cloud::documentai::v1::EnableProcessorRequest const &)

Parameter
Name	Description
request	google::cloud::documentai::v1::EnableProcessorRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::documentai::v1::EnableProcessorResponse > >

virtual EnableProcessor(NoAwaitTag, google::cloud::documentai::v1::EnableProcessorRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::documentai::v1::EnableProcessorRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual EnableProcessor(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::documentai::v1::EnableProcessorResponse > >

virtual DisableProcessor(google::cloud::documentai::v1::DisableProcessorRequest const &)

Parameter
Name	Description
request	google::cloud::documentai::v1::DisableProcessorRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::documentai::v1::DisableProcessorResponse > >

virtual DisableProcessor(NoAwaitTag, google::cloud::documentai::v1::DisableProcessorRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::documentai::v1::DisableProcessorRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual DisableProcessor(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::documentai::v1::DisableProcessorResponse > >

virtual SetDefaultProcessorVersion(google::cloud::documentai::v1::SetDefaultProcessorVersionRequest const &)

Parameter
Name	Description
request	google::cloud::documentai::v1::SetDefaultProcessorVersionRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::documentai::v1::SetDefaultProcessorVersionResponse > >

virtual SetDefaultProcessorVersion(NoAwaitTag, google::cloud::documentai::v1::SetDefaultProcessorVersionRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::documentai::v1::SetDefaultProcessorVersionRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual SetDefaultProcessorVersion(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::documentai::v1::SetDefaultProcessorVersionResponse > >

virtual ReviewDocument(google::cloud::documentai::v1::ReviewDocumentRequest const &)

Parameter
Name	Description
request	google::cloud::documentai::v1::ReviewDocumentRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::documentai::v1::ReviewDocumentResponse > >

virtual ReviewDocument(NoAwaitTag, google::cloud::documentai::v1::ReviewDocumentRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::documentai::v1::ReviewDocumentRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual ReviewDocument(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::documentai::v1::ReviewDocumentResponse > >

virtual EvaluateProcessorVersion(google::cloud::documentai::v1::EvaluateProcessorVersionRequest const &)

Parameter
Name	Description
request	google::cloud::documentai::v1::EvaluateProcessorVersionRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::documentai::v1::EvaluateProcessorVersionResponse > >

virtual EvaluateProcessorVersion(NoAwaitTag, google::cloud::documentai::v1::EvaluateProcessorVersionRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::documentai::v1::EvaluateProcessorVersionRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual EvaluateProcessorVersion(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::documentai::v1::EvaluateProcessorVersionResponse > >

virtual GetEvaluation(google::cloud::documentai::v1::GetEvaluationRequest const &)

Parameter
Name	Description
request	google::cloud::documentai::v1::GetEvaluationRequest const &

Returns
Type	Description
StatusOr< google::cloud::documentai::v1::Evaluation >

virtual ListEvaluations(google::cloud::documentai::v1::ListEvaluationsRequest)

Parameter
Name	Description
request	google::cloud::documentai::v1::ListEvaluationsRequest

Returns
Type	Description
StreamRange< google::cloud::documentai::v1::Evaluation >

virtual ListLocations(google::cloud::location::ListLocationsRequest)

Parameter
Name	Description
request	google::cloud::location::ListLocationsRequest

Returns
Type	Description
StreamRange< google::cloud::location::Location >

virtual GetLocation(google::cloud::location::GetLocationRequest const &)

Parameter
Name	Description
request	google::cloud::location::GetLocationRequest const &

Returns
Type	Description
StatusOr< google::cloud::location::Location >

virtual ListOperations(google::longrunning::ListOperationsRequest)

Parameter
Name	Description
request	google::longrunning::ListOperationsRequest

Returns
Type	Description
StreamRange< google::longrunning::Operation >

virtual GetOperation(google::longrunning::GetOperationRequest const &)

Parameter
Name	Description
request	google::longrunning::GetOperationRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual CancelOperation(google::longrunning::CancelOperationRequest const &)

Parameter
Name	Description
request	google::longrunning::CancelOperationRequest const &

Returns
Type	Description
Status