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

(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

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

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

Calls CreateDocument.

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

CreateDocumentRequest message or plain object

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

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

Calls DeleteDocument.

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

DeleteDocumentRequest message or plain object

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

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

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

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

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

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

Calls ReloadDocument.

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

ReloadDocumentRequest message or plain object

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

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

Calls UpdateDocument.

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

UpdateDocumentRequest message or plain object

Type Definitions

CreateDocumentCallback(error, responseopt)

Callback as used by google.cloud.dialogflow.v2beta1.Documents#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 google.cloud.dialogflow.v2beta1.Documents#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 google.cloud.dialogflow.v2beta1.Documents#getDocument.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.dialogflow.v2beta1.Document <optional>

Document

ListDocumentsCallback(error, responseopt)

Callback as used by google.cloud.dialogflow.v2beta1.Documents#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 google.cloud.dialogflow.v2beta1.Documents#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 google.cloud.dialogflow.v2beta1.Documents#updateDocument.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation