Documents

google.cloud.dialogflow.v2beta1. Documents

Represents a Documents

Constructor

new Documents(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new Documents service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean <optional>
 false

Whether requests are length-delimited
responseDelimited boolean <optional>
 false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

createDocument(request, callback) → {undefined}

Calls CreateDocument.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2beta1.ICreateDocumentRequest

CreateDocumentRequest message or plain object
callback google.cloud.dialogflow.v2beta1.Documents.CreateDocumentCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

createDocument(request) → {Promise.<google.longrunning.Operation>}

Calls CreateDocument.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2beta1.ICreateDocumentRequest

CreateDocumentRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

deleteDocument(request, callback) → {undefined}

Calls DeleteDocument.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2beta1.IDeleteDocumentRequest

DeleteDocumentRequest message or plain object
callback google.cloud.dialogflow.v2beta1.Documents.DeleteDocumentCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

deleteDocument(request) → {Promise.<google.longrunning.Operation>}

Calls DeleteDocument.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2beta1.IDeleteDocumentRequest

DeleteDocumentRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

getDocument(request, callback) → {undefined}

Calls GetDocument.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2beta1.IGetDocumentRequest

GetDocumentRequest message or plain object
callback google.cloud.dialogflow.v2beta1.Documents.GetDocumentCallback

Node-style callback called with the error, if any, and Document
Returns:
Type Description
undefined

getDocument(request) → {Promise.<google.cloud.dialogflow.v2beta1.Document>}

Calls GetDocument.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2beta1.IGetDocumentRequest

GetDocumentRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.dialogflow.v2beta1.Document>

Promise

importDocuments(request, callback) → {undefined}

Calls ImportDocuments.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2beta1.IImportDocumentsRequest

ImportDocumentsRequest message or plain object
callback google.cloud.dialogflow.v2beta1.Documents.ImportDocumentsCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

importDocuments(request) → {Promise.<google.longrunning.Operation>}

Calls ImportDocuments.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2beta1.IImportDocumentsRequest

ImportDocumentsRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

listDocuments(request, callback) → {undefined}

Calls ListDocuments.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2beta1.IListDocumentsRequest

ListDocumentsRequest message or plain object
callback google.cloud.dialogflow.v2beta1.Documents.ListDocumentsCallback

Node-style callback called with the error, if any, and ListDocumentsResponse
Returns:
Type Description
undefined

listDocuments(request) → {Promise.<google.cloud.dialogflow.v2beta1.ListDocumentsResponse>}

Calls ListDocuments.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2beta1.IListDocumentsRequest

ListDocumentsRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.dialogflow.v2beta1.ListDocumentsResponse>

Promise

reloadDocument(request, callback) → {undefined}

Calls ReloadDocument.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2beta1.IReloadDocumentRequest

ReloadDocumentRequest message or plain object
callback google.cloud.dialogflow.v2beta1.Documents.ReloadDocumentCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

reloadDocument(request) → {Promise.<google.longrunning.Operation>}

Calls ReloadDocument.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2beta1.IReloadDocumentRequest

ReloadDocumentRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

updateDocument(request, callback) → {undefined}

Calls UpdateDocument.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2beta1.IUpdateDocumentRequest

UpdateDocumentRequest message or plain object
callback google.cloud.dialogflow.v2beta1.Documents.UpdateDocumentCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

updateDocument(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateDocument.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2beta1.IUpdateDocumentRequest

UpdateDocumentRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {Documents}

Creates new Documents service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean <optional>
 false

Whether requests are length-delimited
responseDelimited boolean <optional>
 false

Whether responses are length-delimited
Returns:
Type Description
Documents

RPC service. Useful where requests and/or responses are streamed.

Type Definitions

CreateDocumentCallback(error, responseopt)

Callback as used by createDocument.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

DeleteDocumentCallback(error, responseopt)

Callback as used by deleteDocument.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

GetDocumentCallback(error, responseopt)

Callback as used by getDocument.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.dialogflow.v2beta1.Document <optional>

Document

ImportDocumentsCallback(error, responseopt)

Callback as used by importDocuments.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

ListDocumentsCallback(error, responseopt)

Callback as used by listDocuments.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.dialogflow.v2beta1.ListDocumentsResponse <optional>

ListDocumentsResponse

ReloadDocumentCallback(error, responseopt)

Callback as used by reloadDocument.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

UpdateDocumentCallback(error, responseopt)

Callback as used by updateDocument.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation