Class protos.google.cloud.dialogflow.v2.Documents (6.11.0)

Represents a Documents

Inheritance

$protobuf.rpc.Service > protos.google.cloud.dialogflow.v2.Documents

Package

@google-cloud/dialogflow

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new Documents service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): Documents;

Creates new Documents service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
Documents

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

createDocument(request, callback)

public createDocument(request: google.cloud.dialogflow.v2.ICreateDocumentRequest, callback: google.cloud.dialogflow.v2.Documents.CreateDocumentCallback): void;

Calls CreateDocument.

Parameters
Name Description
request ICreateDocumentRequest

CreateDocumentRequest message or plain object
callback CreateDocumentCallback

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

createDocument(request)

public createDocument(request: google.cloud.dialogflow.v2.ICreateDocumentRequest): Promise<google.longrunning.Operation>;

Calls CreateDocument.

Parameter
Name Description
request ICreateDocumentRequest

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

Promise

deleteDocument(request, callback)

public deleteDocument(request: google.cloud.dialogflow.v2.IDeleteDocumentRequest, callback: google.cloud.dialogflow.v2.Documents.DeleteDocumentCallback): void;

Calls DeleteDocument.

Parameters
Name Description
request IDeleteDocumentRequest

DeleteDocumentRequest message or plain object
callback DeleteDocumentCallback

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

deleteDocument(request)

public deleteDocument(request: google.cloud.dialogflow.v2.IDeleteDocumentRequest): Promise<google.longrunning.Operation>;

Calls DeleteDocument.

Parameter
Name Description
request IDeleteDocumentRequest

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

Promise

exportDocument(request, callback)

public exportDocument(request: google.cloud.dialogflow.v2.IExportDocumentRequest, callback: google.cloud.dialogflow.v2.Documents.ExportDocumentCallback): void;

Calls ExportDocument.

Parameters
Name Description
request IExportDocumentRequest

ExportDocumentRequest message or plain object
callback ExportDocumentCallback

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

exportDocument(request)

public exportDocument(request: google.cloud.dialogflow.v2.IExportDocumentRequest): Promise<google.longrunning.Operation>;

Calls ExportDocument.

Parameter
Name Description
request IExportDocumentRequest

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

Promise

getDocument(request, callback)

public getDocument(request: google.cloud.dialogflow.v2.IGetDocumentRequest, callback: google.cloud.dialogflow.v2.Documents.GetDocumentCallback): void;

Calls GetDocument.

Parameters
Name Description
request IGetDocumentRequest

GetDocumentRequest message or plain object
callback GetDocumentCallback

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

getDocument(request)

public getDocument(request: google.cloud.dialogflow.v2.IGetDocumentRequest): Promise<google.cloud.dialogflow.v2.Document>;

Calls GetDocument.

Parameter
Name Description
request IGetDocumentRequest

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

Promise

importDocuments(request, callback)

public importDocuments(request: google.cloud.dialogflow.v2.IImportDocumentsRequest, callback: google.cloud.dialogflow.v2.Documents.ImportDocumentsCallback): void;

Calls ImportDocuments.

Parameters
Name Description
request IImportDocumentsRequest

ImportDocumentsRequest message or plain object
callback ImportDocumentsCallback

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

importDocuments(request)

public importDocuments(request: google.cloud.dialogflow.v2.IImportDocumentsRequest): Promise<google.longrunning.Operation>;

Calls ImportDocuments.

Parameter
Name Description
request IImportDocumentsRequest

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

Promise

listDocuments(request, callback)

public listDocuments(request: google.cloud.dialogflow.v2.IListDocumentsRequest, callback: google.cloud.dialogflow.v2.Documents.ListDocumentsCallback): void;

Calls ListDocuments.

Parameters
Name Description
request IListDocumentsRequest

ListDocumentsRequest message or plain object
callback ListDocumentsCallback

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

listDocuments(request)

public listDocuments(request: google.cloud.dialogflow.v2.IListDocumentsRequest): Promise<google.cloud.dialogflow.v2.ListDocumentsResponse>;

Calls ListDocuments.

Parameter
Name Description
request IListDocumentsRequest

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

Promise

reloadDocument(request, callback)

public reloadDocument(request: google.cloud.dialogflow.v2.IReloadDocumentRequest, callback: google.cloud.dialogflow.v2.Documents.ReloadDocumentCallback): void;

Calls ReloadDocument.

Parameters
Name Description
request IReloadDocumentRequest

ReloadDocumentRequest message or plain object
callback ReloadDocumentCallback

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

reloadDocument(request)

public reloadDocument(request: google.cloud.dialogflow.v2.IReloadDocumentRequest): Promise<google.longrunning.Operation>;

Calls ReloadDocument.

Parameter
Name Description
request IReloadDocumentRequest

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

Promise

updateDocument(request, callback)

public updateDocument(request: google.cloud.dialogflow.v2.IUpdateDocumentRequest, callback: google.cloud.dialogflow.v2.Documents.UpdateDocumentCallback): void;

Calls UpdateDocument.

Parameters
Name Description
request IUpdateDocumentRequest

UpdateDocumentRequest message or plain object
callback UpdateDocumentCallback

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

updateDocument(request)

public updateDocument(request: google.cloud.dialogflow.v2.IUpdateDocumentRequest): Promise<google.longrunning.Operation>;

Calls UpdateDocument.

Parameter
Name Description
request IUpdateDocumentRequest

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

Promise