Discovery Engine v1 API - Class CollectionService.CollectionServiceBase (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(CollectionService), "BindService")]
public abstract class CollectionService.CollectionServiceBase

Reference documentation and code samples for the Discovery Engine v1 API class CollectionService.CollectionServiceBase.

Base class for server-side implementations of CollectionService

Inheritance

object > CollectionService.CollectionServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Methods

DeleteCollection(DeleteCollectionRequest, ServerCallContext)

public virtual Task<Operation> DeleteCollection(DeleteCollectionRequest request, ServerCallContext context)

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

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

GetIamPolicy(GetIamPolicyRequest, ServerCallContext)

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

Gets the IAM access control policy for a [Collection][google.cloud.discoveryengine.v1.Collection]. 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).

SetIamPolicy(SetIamPolicyRequest, ServerCallContext)

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

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

Important: When setting a policy directly on a Collection 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).