Class DocumentServiceConnection (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

The DocumentServiceConnection object for DocumentServiceClient.

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

To create a concrete instance, see MakeDocumentServiceConnection().

For mocking, see discoveryengine_v1_mocks::MockDocumentServiceConnection.

Functions

virtual options()

Returns
Type	Description
Options

virtual GetDocument(google::cloud::discoveryengine::v1::GetDocumentRequest const &)

Parameter
Name	Description
request	google::cloud::discoveryengine::v1::GetDocumentRequest const &

Returns
Type	Description
StatusOr< google::cloud::discoveryengine::v1::Document >

virtual ListDocuments(google::cloud::discoveryengine::v1::ListDocumentsRequest)

Parameter
Name	Description
request	google::cloud::discoveryengine::v1::ListDocumentsRequest

Returns
Type	Description
StreamRange< google::cloud::discoveryengine::v1::Document >

virtual CreateDocument(google::cloud::discoveryengine::v1::CreateDocumentRequest const &)

Parameter
Name	Description
request	google::cloud::discoveryengine::v1::CreateDocumentRequest const &

Returns
Type	Description
StatusOr< google::cloud::discoveryengine::v1::Document >

virtual UpdateDocument(google::cloud::discoveryengine::v1::UpdateDocumentRequest const &)

Parameter
Name	Description
request	google::cloud::discoveryengine::v1::UpdateDocumentRequest const &

Returns
Type	Description
StatusOr< google::cloud::discoveryengine::v1::Document >

virtual DeleteDocument(google::cloud::discoveryengine::v1::DeleteDocumentRequest const &)

Parameter
Name	Description
request	google::cloud::discoveryengine::v1::DeleteDocumentRequest const &

Returns
Type	Description
Status

virtual ImportDocuments(google::cloud::discoveryengine::v1::ImportDocumentsRequest const &)

Parameter
Name	Description
request	google::cloud::discoveryengine::v1::ImportDocumentsRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::discoveryengine::v1::ImportDocumentsResponse > >

virtual ImportDocuments(NoAwaitTag, google::cloud::discoveryengine::v1::ImportDocumentsRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::discoveryengine::v1::ImportDocumentsRequest const &

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

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

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

Returns
Type	Description
future< StatusOr< google::cloud::discoveryengine::v1::ImportDocumentsResponse > >

virtual PurgeDocuments(google::cloud::discoveryengine::v1::PurgeDocumentsRequest const &)

Parameter
Name	Description
request	google::cloud::discoveryengine::v1::PurgeDocumentsRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::discoveryengine::v1::PurgeDocumentsResponse > >

virtual PurgeDocuments(NoAwaitTag, google::cloud::discoveryengine::v1::PurgeDocumentsRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::discoveryengine::v1::PurgeDocumentsRequest const &

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

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

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

Returns
Type	Description
future< StatusOr< google::cloud::discoveryengine::v1::PurgeDocumentsResponse > >

virtual BatchGetDocumentsMetadata(google::cloud::discoveryengine::v1::BatchGetDocumentsMetadataRequest const &)

Parameter
Name	Description
request	google::cloud::discoveryengine::v1::BatchGetDocumentsMetadataRequest const &

Returns
Type	Description
StatusOr< google::cloud::discoveryengine::v1::BatchGetDocumentsMetadataResponse >

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