Class protos.google.cloud.dialogflow.v2beta1.Documents (3.5.0)

Represents a Documents

Inheritance

$protobuf.rpc.Service > protos.google.cloud.dialogflow.v2beta1.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.v2beta1.ICreateDocumentRequest, callback: google.cloud.dialogflow.v2beta1.Documents.CreateDocumentCallback): void;

Calls CreateDocument.

Parameters

Name	Description
request	`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
void

createDocument(request)

public createDocument(request: google.cloud.dialogflow.v2beta1.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.v2beta1.IDeleteDocumentRequest, callback: google.cloud.dialogflow.v2beta1.Documents.DeleteDocumentCallback): void;

Calls DeleteDocument.

Parameters

Name	Description
request	`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
void

deleteDocument(request)

public deleteDocument(request: google.cloud.dialogflow.v2beta1.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

getDocument(request, callback)

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

Calls GetDocument.

Parameters

Name	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
void

getDocument(request)

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

Calls GetDocument.

Parameter

Name	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)

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

Calls ImportDocuments.

Parameters

Name	Description
request	`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
void

importDocuments(request)

public importDocuments(request: google.cloud.dialogflow.v2beta1.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.v2beta1.IListDocumentsRequest, callback: google.cloud.dialogflow.v2beta1.Documents.ListDocumentsCallback): void;

Calls ListDocuments.

Parameters

Name	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
void

listDocuments(request)

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

Calls ListDocuments.

Parameter

Name	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)

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

Calls ReloadDocument.

Parameters

Name	Description
request	`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
void

reloadDocument(request)

public reloadDocument(request: google.cloud.dialogflow.v2beta1.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.v2beta1.IUpdateDocumentRequest, callback: google.cloud.dialogflow.v2beta1.Documents.UpdateDocumentCallback): void;

Calls UpdateDocument.

Parameters

Name	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
void

updateDocument(request)

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

Calls UpdateDocument.

Parameter

Name	Description
request	`google.cloud.dialogflow.v2beta1.IUpdateDocumentRequest` UpdateDocumentRequest message or plain object

Returns

Type	Description
Promise<google.longrunning.Operation>	Promise