Discovery Engine v1 API - Class DataStoreService.DataStoreServiceBase (1.17.0)

1.17.0 (latest) 1.16.0 1.15.0 1.14.0 1.13.0 1.12.0 1.11.0 1.10.0 1.9.0 1.8.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0-beta06

[BindServiceMethod(typeof(DataStoreService), "BindService")]
public abstract class DataStoreService.DataStoreServiceBase

Reference documentation and code samples for the Discovery Engine v1 API class DataStoreService.DataStoreServiceBase.

Base class for server-side implementations of DataStoreService

Inheritance

object > DataStoreService.DataStoreServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Methods

CreateDataStore(CreateDataStoreRequest, ServerCallContext)

public virtual Task<Operation> CreateDataStore(CreateDataStoreRequest request, ServerCallContext context)

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

DataStore is for storing [Documents][google.cloud.discoveryengine.v1.Document]. To serve these documents for Search, or Recommendation use case, an [Engine][google.cloud.discoveryengine.v1.Engine] needs to be created separately.

Parameters
Name	Description
request	CreateDataStoreRequest 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).

DeleteDataStore(DeleteDataStoreRequest, ServerCallContext)

public virtual Task<Operation> DeleteDataStore(DeleteDataStoreRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	DeleteDataStoreRequest 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).

GetDataStore(GetDataStoreRequest, ServerCallContext)

public virtual Task<DataStore> GetDataStore(GetDataStoreRequest request, ServerCallContext context)

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

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

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

GetIamPolicy(GetIamPolicyRequest, ServerCallContext)

public virtual Task<Policy> GetIamPolicy(GetIamPolicyRequest request, ServerCallContext context)

Gets the IAM access control policy for a [DataStore][google.cloud.discoveryengine.v1.DataStore]. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.

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

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

ListDataStores(ListDataStoresRequest, ServerCallContext)

public virtual Task<ListDataStoresResponse> ListDataStores(ListDataStoresRequest request, ServerCallContext context)

Lists all the [DataStore][google.cloud.discoveryengine.v1.DataStore]s associated with the project.

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

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

SetIamPolicy(SetIamPolicyRequest, ServerCallContext)

public virtual Task<Policy> SetIamPolicy(SetIamPolicyRequest request, ServerCallContext context)

Sets the IAM access control policy for a [DataStore][google.cloud.discoveryengine.v1.DataStore]. A NOT_FOUND error is returned if the resource does not exist.

Important: When setting a policy directly on a DataStore resource, the only recommended roles in the bindings are: roles/discoveryengine.admin roles/discoveryengine.agentspaceAdmin roles/discoveryengine.viewer roles/discoveryengine.agentspaceViewer roles/discoveryengine.user roles/discoveryengine.agentspaceUser Attempting to grant any other role will result in a warning in logging.

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

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

UpdateDataStore(UpdateDataStoreRequest, ServerCallContext)

public virtual Task<DataStore> UpdateDataStore(UpdateDataStoreRequest request, ServerCallContext context)

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

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

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