Class DocumentsConnection (2.28.0)

The DocumentsConnection object for DocumentsClient.

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

To create a concrete instance, see MakeDocumentsConnection().

For mocking, see dialogflow_es_mocks::MockDocumentsConnection.

Functions

virtual options()

Returns
Type Description
Options

virtual ListDocuments(google::cloud::dialogflow::v2::ListDocumentsRequest)

Parameter
Name Description
request google::cloud::dialogflow::v2::ListDocumentsRequest
Returns
Type Description
StreamRange< google::cloud::dialogflow::v2::Document >

virtual GetDocument(google::cloud::dialogflow::v2::GetDocumentRequest const &)

Parameter
Name Description
request google::cloud::dialogflow::v2::GetDocumentRequest const &
Returns
Type Description
StatusOr< google::cloud::dialogflow::v2::Document >

virtual CreateDocument(google::cloud::dialogflow::v2::CreateDocumentRequest const &)

Parameter
Name Description
request google::cloud::dialogflow::v2::CreateDocumentRequest const &
Returns
Type Description
future< StatusOr< google::cloud::dialogflow::v2::Document > >

virtual CreateDocument(NoAwaitTag, google::cloud::dialogflow::v2::CreateDocumentRequest const &)

Parameters
Name Description
NoAwaitTag
request google::cloud::dialogflow::v2::CreateDocumentRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Parameter
Name Description
operation google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::dialogflow::v2::Document > >

virtual ImportDocuments(google::cloud::dialogflow::v2::ImportDocumentsRequest const &)

Parameter
Name Description
request google::cloud::dialogflow::v2::ImportDocumentsRequest const &
Returns
Type Description
future< StatusOr< google::cloud::dialogflow::v2::ImportDocumentsResponse > >

virtual ImportDocuments(NoAwaitTag, google::cloud::dialogflow::v2::ImportDocumentsRequest const &)

Parameters
Name Description
NoAwaitTag
request google::cloud::dialogflow::v2::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::dialogflow::v2::ImportDocumentsResponse > >

virtual DeleteDocument(google::cloud::dialogflow::v2::DeleteDocumentRequest const &)

Parameter
Name Description
request google::cloud::dialogflow::v2::DeleteDocumentRequest const &
Returns
Type Description
future< StatusOr< google::cloud::dialogflow::v2::KnowledgeOperationMetadata > >

virtual DeleteDocument(NoAwaitTag, google::cloud::dialogflow::v2::DeleteDocumentRequest const &)

Parameters
Name Description
NoAwaitTag
request google::cloud::dialogflow::v2::DeleteDocumentRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Parameter
Name Description
operation google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::dialogflow::v2::KnowledgeOperationMetadata > >

virtual UpdateDocument(google::cloud::dialogflow::v2::UpdateDocumentRequest const &)

Parameter
Name Description
request google::cloud::dialogflow::v2::UpdateDocumentRequest const &
Returns
Type Description
future< StatusOr< google::cloud::dialogflow::v2::Document > >

virtual UpdateDocument(NoAwaitTag, google::cloud::dialogflow::v2::UpdateDocumentRequest const &)

Parameters
Name Description
NoAwaitTag
request google::cloud::dialogflow::v2::UpdateDocumentRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Parameter
Name Description
operation google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::dialogflow::v2::Document > >

virtual ReloadDocument(google::cloud::dialogflow::v2::ReloadDocumentRequest const &)

Parameter
Name Description
request google::cloud::dialogflow::v2::ReloadDocumentRequest const &
Returns
Type Description
future< StatusOr< google::cloud::dialogflow::v2::Document > >

virtual ReloadDocument(NoAwaitTag, google::cloud::dialogflow::v2::ReloadDocumentRequest const &)

Parameters
Name Description
NoAwaitTag
request google::cloud::dialogflow::v2::ReloadDocumentRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Parameter
Name Description
operation google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::dialogflow::v2::Document > >

virtual ExportDocument(google::cloud::dialogflow::v2::ExportDocumentRequest const &)

Parameter
Name Description
request google::cloud::dialogflow::v2::ExportDocumentRequest const &
Returns
Type Description
future< StatusOr< google::cloud::dialogflow::v2::Document > >

virtual ExportDocument(NoAwaitTag, google::cloud::dialogflow::v2::ExportDocumentRequest const &)

Parameters
Name Description
NoAwaitTag
request google::cloud::dialogflow::v2::ExportDocumentRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Parameter
Name Description
operation google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::dialogflow::v2::Document > >