Class ControlService.ControlServiceBase (2.2.0)

Stay organized with collections Save and categorize content based on your preferences.
[BindServiceMethod(typeof(ControlService), "BindService")]
public abstract class ControlServiceBase

Base class for server-side implementations of ControlService

Inheritance

Object > ControlService.ControlServiceBase

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Methods

CreateControl(CreateControlRequest, ServerCallContext)

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

Creates a Control.

If the [Control][google.cloud.retail.v2.Control] to create already exists, an ALREADY_EXISTS error is returned.

Parameters
NameDescription
requestCreateControlRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Control>

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.retail.v2.Control] to delete does not exist, a NOT_FOUND error is returned.

Parameters
NameDescription
requestDeleteControlRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Empty>

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
NameDescription
requestGetControlRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Control>

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 [Catalog][google.cloud.retail.v2.Catalog].

Parameters
NameDescription
requestListControlsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<ListControlsResponse>

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.retail.v2.Control] cannot be set to a different oneof field, if so an INVALID_ARGUMENT is returned. If the [Control][google.cloud.retail.v2.Control] to update does not exist, a NOT_FOUND error is returned.

Parameters
NameDescription
requestUpdateControlRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Control>

The response to send back to the client (wrapped by a task).