Discovery Engine v1 API - Class ControlService.ControlServiceBase (1.4.0)

[BindServiceMethod(typeof(ControlService), "BindService")]
public abstract class ControlService.ControlServiceBase

Reference documentation and code samples for the Discovery Engine v1 API class ControlService.ControlServiceBase.

Base class for server-side implementations of ControlService

Inheritance

object > ControlService.ControlServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Methods

CreateControl(CreateControlRequest, ServerCallContext)

public virtual Task<Control> CreateControl(CreateControlRequest request, ServerCallContext context)

Creates a Control.

By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the [Control][google.cloud.discoveryengine.v1.Control] to create already exists, an ALREADY_EXISTS error is returned.

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

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

DeleteControl(DeleteControlRequest, ServerCallContext)

public virtual Task<Empty> DeleteControl(DeleteControlRequest request, ServerCallContext context)

Deletes a Control.

If the [Control][google.cloud.discoveryengine.v1.Control] to delete does not exist, a NOT_FOUND error is returned.

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

GetControl(GetControlRequest, ServerCallContext)

public virtual Task<Control> GetControl(GetControlRequest request, ServerCallContext context)

Gets a Control.

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

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

ListControls(ListControlsRequest, ServerCallContext)

public virtual Task<ListControlsResponse> ListControls(ListControlsRequest request, ServerCallContext context)

Lists all Controls by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].

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

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

UpdateControl(UpdateControlRequest, ServerCallContext)

public virtual Task<Control> UpdateControl(UpdateControlRequest request, ServerCallContext context)

Updates a Control.

[Control][google.cloud.discoveryengine.v1.Control] action type cannot be changed. If the [Control][google.cloud.discoveryengine.v1.Control] to update does not exist, a NOT_FOUND error is returned.

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

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