Class protos.google.cloud.discoveryengine.v1alpha.DocumentService (2.6.0)

2.6.0 (latest) 2.2.0 2.0.1 1.14.0 1.10.0 1.9.0 1.7.0 1.6.0 1.4.1 1.3.1 1.2.0 1.0.0 0.6.0 0.5.0 0.3.1 0.2.0

Represents a DocumentService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.discoveryengine.v1alpha.DocumentService

Package

@google-cloud/discoveryengine

Constructors

(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

batchGetDocumentsMetadata(request, callback)

public batchGetDocumentsMetadata(request: google.cloud.discoveryengine.v1alpha.IBatchGetDocumentsMetadataRequest, callback: google.cloud.discoveryengine.v1alpha.DocumentService.BatchGetDocumentsMetadataCallback): void;

Calls BatchGetDocumentsMetadata.

Parameters
Name	Description
request	IBatchGetDocumentsMetadataRequest BatchGetDocumentsMetadataRequest message or plain object
callback	BatchGetDocumentsMetadataCallback Node-style callback called with the error, if any, and BatchGetDocumentsMetadataResponse

Returns
Type	Description
void

batchGetDocumentsMetadata(request)

public batchGetDocumentsMetadata(request: google.cloud.discoveryengine.v1alpha.IBatchGetDocumentsMetadataRequest): Promise<google.cloud.discoveryengine.v1alpha.BatchGetDocumentsMetadataResponse>;

Calls BatchGetDocumentsMetadata.

Parameter
Name	Description
request	IBatchGetDocumentsMetadataRequest BatchGetDocumentsMetadataRequest message or plain object

Returns
Type	Description
Promise<google.cloud.discoveryengine.v1alpha.BatchGetDocumentsMetadataResponse>	Promise

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.v1alpha.ICreateDocumentRequest, callback: google.cloud.discoveryengine.v1alpha.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.v1alpha.ICreateDocumentRequest): Promise<google.cloud.discoveryengine.v1alpha.Document>;

Calls CreateDocument.

Parameter
Name	Description
request	ICreateDocumentRequest CreateDocumentRequest message or plain object

Returns
Type	Description
Promise<google.cloud.discoveryengine.v1alpha.Document>	Promise

deleteDocument(request, callback)

public deleteDocument(request: google.cloud.discoveryengine.v1alpha.IDeleteDocumentRequest, callback: google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.IGetDocumentRequest, callback: google.cloud.discoveryengine.v1alpha.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.v1alpha.IGetDocumentRequest): Promise<google.cloud.discoveryengine.v1alpha.Document>;

Calls GetDocument.

Parameter
Name	Description
request	IGetDocumentRequest GetDocumentRequest message or plain object

Returns
Type	Description
Promise<google.cloud.discoveryengine.v1alpha.Document>	Promise

getProcessedDocument(request, callback)

public getProcessedDocument(request: google.cloud.discoveryengine.v1alpha.IGetProcessedDocumentRequest, callback: google.cloud.discoveryengine.v1alpha.DocumentService.GetProcessedDocumentCallback): void;

Calls GetProcessedDocument.

Parameters
Name	Description
request	IGetProcessedDocumentRequest GetProcessedDocumentRequest message or plain object
callback	GetProcessedDocumentCallback Node-style callback called with the error, if any, and ProcessedDocument

Returns
Type	Description
void

getProcessedDocument(request)

public getProcessedDocument(request: google.cloud.discoveryengine.v1alpha.IGetProcessedDocumentRequest): Promise<google.cloud.discoveryengine.v1alpha.ProcessedDocument>;

Calls GetProcessedDocument.

Parameter
Name	Description
request	IGetProcessedDocumentRequest GetProcessedDocumentRequest message or plain object

Returns
Type	Description
Promise<google.cloud.discoveryengine.v1alpha.ProcessedDocument>	Promise

importDocuments(request, callback)

public importDocuments(request: google.cloud.discoveryengine.v1alpha.IImportDocumentsRequest, callback: google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.IListDocumentsRequest, callback: google.cloud.discoveryengine.v1alpha.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.v1alpha.IListDocumentsRequest): Promise<google.cloud.discoveryengine.v1alpha.ListDocumentsResponse>;

Calls ListDocuments.

Parameter
Name	Description
request	IListDocumentsRequest ListDocumentsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.discoveryengine.v1alpha.ListDocumentsResponse>	Promise

purgeDocuments(request, callback)

public purgeDocuments(request: google.cloud.discoveryengine.v1alpha.IPurgeDocumentsRequest, callback: google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.IUpdateDocumentRequest, callback: google.cloud.discoveryengine.v1alpha.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.v1alpha.IUpdateDocumentRequest): Promise<google.cloud.discoveryengine.v1alpha.Document>;

Calls UpdateDocument.

Parameter
Name	Description
request	IUpdateDocumentRequest UpdateDocumentRequest message or plain object

Returns
Type	Description
Promise<google.cloud.discoveryengine.v1alpha.Document>	Promise