# Discovery Engine v1beta API - Class DocumentService.DocumentServiceBase (1.0.0-beta23)

1.0.0-beta23 (latest) 1.0.0-beta22

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

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

Base class for server-side implementations of DocumentService

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> DocumentService.DocumentServiceBase

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.DiscoveryEngine.V1Beta](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta)

## Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

## Methods

### BatchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest, ServerCallContext)

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

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.BatchGetDocumentsMetadataRequest` The request received from the client. |
| `context` | `https://cloud.google.com/dotnet/docs/reference/Grpc.Core/latest/Grpc.Core.ServerCallContext.html` The context of the server-side call handler being invoked. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.BatchGetDocumentsMetadataResponse` | 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.v1beta.Document\].

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.CreateDocumentRequest` The request received from the client. |
| `context` | `https://cloud.google.com/dotnet/docs/reference/Grpc.Core/latest/Grpc.Core.ServerCallContext.html` The context of the server-side call handler being invoked. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.Document` | 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.v1beta.Document\].

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.DeleteDocumentRequest` The request received from the client. |
| `context` | `https://cloud.google.com/dotnet/docs/reference/Grpc.Core/latest/Grpc.Core.ServerCallContext.html` The context of the server-side call handler being invoked. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Empty.html` | 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.v1beta.Document\].

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.GetDocumentRequest` The request received from the client. |
| `context` | `https://cloud.google.com/dotnet/docs/reference/Grpc.Core/latest/Grpc.Core.ServerCallContext.html` The context of the server-side call handler being invoked. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.Document` | 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.v1beta.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.v1beta.Document\]s to be
successfully updated.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ImportDocumentsRequest` The request received from the client. |
| `context` | `https://cloud.google.com/dotnet/docs/reference/Grpc.Core/latest/Grpc.Core.ServerCallContext.html` The context of the server-side call handler being invoked. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://docs.cloud.google.com/dotnet/docs/reference/Google.LongRunning/latest/Google.LongRunning.Operation.html` | 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.v1beta.Document\]s.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ListDocumentsRequest` The request received from the client. |
| `context` | `https://cloud.google.com/dotnet/docs/reference/Grpc.Core/latest/Grpc.Core.ServerCallContext.html` The context of the server-side call handler being invoked. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ListDocumentsResponse` | 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.v1beta.Document\]s in a branch.

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

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.PurgeDocumentsRequest` The request received from the client. |
| `context` | `https://cloud.google.com/dotnet/docs/reference/Grpc.Core/latest/Grpc.Core.ServerCallContext.html` The context of the server-side call handler being invoked. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://docs.cloud.google.com/dotnet/docs/reference/Google.LongRunning/latest/Google.LongRunning.Operation.html` | 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.v1beta.Document\].

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.UpdateDocumentRequest` The request received from the client. |
| `context` | `https://cloud.google.com/dotnet/docs/reference/Grpc.Core/latest/Grpc.Core.ServerCallContext.html` The context of the server-side call handler being invoked. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.Document` | The response to send back to the client (wrapped by a task). |