Retail v2 API - Class ControlService.ControlServiceBase (2.11.0)

Version 2.11.0

• 2.12.0 (latest)
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

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

Reference documentation and code samples for the Retail v2 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.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
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.retail.v2.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 [Catalog][google.cloud.retail.v2.Catalog].

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.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
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).