Discovery Engine v1 API - Class DocumentService.DocumentServiceBase (1.6.0)

Version latest

• 1.6.0 (latest)
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0-beta06

[BindServiceMethod(typeof(DocumentService), "BindService")]
public abstract class DocumentService.DocumentServiceBase

Reference documentation and code samples for the Discovery Engine v1 API class DocumentService.DocumentServiceBase.

Base class for server-side implementations of DocumentService

Inheritance

object > DocumentService.DocumentServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Methods

BatchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest, ServerCallContext)

public virtual Task<BatchGetDocumentsMetadataResponse> BatchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest request, ServerCallContext context)

Gets index freshness metadata for [Document][google.cloud.discoveryengine.v1.Document]s. Supported for website search only.

Parameters
Name	Description
request	BatchGetDocumentsMetadataRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskBatchGetDocumentsMetadataResponse	The response to send back to the client (wrapped by a task).

CreateDocument(CreateDocumentRequest, ServerCallContext)

public virtual Task<Document> CreateDocument(CreateDocumentRequest request, ServerCallContext context)

Creates a [Document][google.cloud.discoveryengine.v1.Document].

Parameters
Name	Description
request	CreateDocumentRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskDocument	The response to send back to the client (wrapped by a task).

DeleteDocument(DeleteDocumentRequest, ServerCallContext)

public virtual Task<Empty> DeleteDocument(DeleteDocumentRequest request, ServerCallContext context)

Deletes a [Document][google.cloud.discoveryengine.v1.Document].

Parameters
Name	Description
request	DeleteDocumentRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

GetDocument(GetDocumentRequest, ServerCallContext)

public virtual Task<Document> GetDocument(GetDocumentRequest request, ServerCallContext context)

Gets a [Document][google.cloud.discoveryengine.v1.Document].

Parameters
Name	Description
request	GetDocumentRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskDocument	The response to send back to the client (wrapped by a task).

ImportDocuments(ImportDocumentsRequest, ServerCallContext)

public virtual Task<Operation> ImportDocuments(ImportDocumentsRequest request, ServerCallContext context)

Bulk import of multiple [Document][google.cloud.discoveryengine.v1.Document]s. Request processing may be synchronous. Non-existing items are created.

Note: It is possible for a subset of the [Document][google.cloud.discoveryengine.v1.Document]s to be successfully updated.

Parameters
Name	Description
request	ImportDocumentsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ListDocuments(ListDocumentsRequest, ServerCallContext)

public virtual Task<ListDocumentsResponse> ListDocuments(ListDocumentsRequest request, ServerCallContext context)

Gets a list of [Document][google.cloud.discoveryengine.v1.Document]s.

Parameters
Name	Description
request	ListDocumentsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListDocumentsResponse	The response to send back to the client (wrapped by a task).

PurgeDocuments(PurgeDocumentsRequest, ServerCallContext)

public virtual Task<Operation> PurgeDocuments(PurgeDocumentsRequest request, ServerCallContext context)

Permanently deletes all selected [Document][google.cloud.discoveryengine.v1.Document]s in a branch.

This process is asynchronous. Depending on the number of [Document][google.cloud.discoveryengine.v1.Document]s to be deleted, this operation can take hours to complete. Before the delete operation completes, some [Document][google.cloud.discoveryengine.v1.Document]s might still be returned by [DocumentService.GetDocument][google.cloud.discoveryengine.v1.DocumentService.GetDocument] or [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments].

To get a list of the [Document][google.cloud.discoveryengine.v1.Document]s to be deleted, set [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1.PurgeDocumentsRequest.force] to false.

Parameters
Name	Description
request	PurgeDocumentsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateDocument(UpdateDocumentRequest, ServerCallContext)

public virtual Task<Document> UpdateDocument(UpdateDocumentRequest request, ServerCallContext context)

Updates a [Document][google.cloud.discoveryengine.v1.Document].

Parameters
Name	Description
request	UpdateDocumentRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskDocument	The response to send back to the client (wrapped by a task).