Represents a DocumentService
Inheritance
$protobuf.rpc.Service > protos.google.cloud.discoveryengine.v1.DocumentServicePackage
@google-cloud/discoveryengineConstructors
(constructor)(rpcImpl, requestDelimited, responseDelimited)
constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);
Constructs a new DocumentService 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): DocumentService;
Creates new DocumentService 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 |
DocumentService | RPC service. Useful where requests and/or responses are streamed. |
createDocument(request, callback)
public createDocument(request: google.cloud.discoveryengine.v1.ICreateDocumentRequest, callback: google.cloud.discoveryengine.v1.DocumentService.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 Document |
Returns | |
---|---|
Type | Description |
void |
createDocument(request)
public createDocument(request: google.cloud.discoveryengine.v1.ICreateDocumentRequest): Promise<google.cloud.discoveryengine.v1.Document>;
Calls CreateDocument.
Parameter | |
---|---|
Name | Description |
request |
ICreateDocumentRequest
CreateDocumentRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.discoveryengine.v1.Document> | Promise |
deleteDocument(request, callback)
public deleteDocument(request: google.cloud.discoveryengine.v1.IDeleteDocumentRequest, callback: google.cloud.discoveryengine.v1.DocumentService.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 Empty |
Returns | |
---|---|
Type | Description |
void |
deleteDocument(request)
public deleteDocument(request: google.cloud.discoveryengine.v1.IDeleteDocumentRequest): Promise<google.protobuf.Empty>;
Calls DeleteDocument.
Parameter | |
---|---|
Name | Description |
request |
IDeleteDocumentRequest
DeleteDocumentRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.protobuf.Empty> | Promise |
getDocument(request, callback)
public getDocument(request: google.cloud.discoveryengine.v1.IGetDocumentRequest, callback: google.cloud.discoveryengine.v1.DocumentService.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.discoveryengine.v1.IGetDocumentRequest): Promise<google.cloud.discoveryengine.v1.Document>;
Calls GetDocument.
Parameter | |
---|---|
Name | Description |
request |
IGetDocumentRequest
GetDocumentRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.discoveryengine.v1.Document> | Promise |
importDocuments(request, callback)
public importDocuments(request: google.cloud.discoveryengine.v1.IImportDocumentsRequest, callback: google.cloud.discoveryengine.v1.DocumentService.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.discoveryengine.v1.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.discoveryengine.v1.IListDocumentsRequest, callback: google.cloud.discoveryengine.v1.DocumentService.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.discoveryengine.v1.IListDocumentsRequest): Promise<google.cloud.discoveryengine.v1.ListDocumentsResponse>;
Calls ListDocuments.
Parameter | |
---|---|
Name | Description |
request |
IListDocumentsRequest
ListDocumentsRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.discoveryengine.v1.ListDocumentsResponse> | Promise |
purgeDocuments(request, callback)
public purgeDocuments(request: google.cloud.discoveryengine.v1.IPurgeDocumentsRequest, callback: google.cloud.discoveryengine.v1.DocumentService.PurgeDocumentsCallback): void;
Calls PurgeDocuments.
Parameters | |
---|---|
Name | Description |
request |
IPurgeDocumentsRequest
PurgeDocumentsRequest message or plain object |
callback |
PurgeDocumentsCallback
Node-style callback called with the error, if any, and Operation |
Returns | |
---|---|
Type | Description |
void |
purgeDocuments(request)
public purgeDocuments(request: google.cloud.discoveryengine.v1.IPurgeDocumentsRequest): Promise<google.longrunning.Operation>;
Calls PurgeDocuments.
Parameter | |
---|---|
Name | Description |
request |
IPurgeDocumentsRequest
PurgeDocumentsRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.longrunning.Operation> | Promise |
updateDocument(request, callback)
public updateDocument(request: google.cloud.discoveryengine.v1.IUpdateDocumentRequest, callback: google.cloud.discoveryengine.v1.DocumentService.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 Document |
Returns | |
---|---|
Type | Description |
void |
updateDocument(request)
public updateDocument(request: google.cloud.discoveryengine.v1.IUpdateDocumentRequest): Promise<google.cloud.discoveryengine.v1.Document>;
Calls UpdateDocument.
Parameter | |
---|---|
Name | Description |
request |
IUpdateDocumentRequest
UpdateDocumentRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.discoveryengine.v1.Document> | Promise |