Retail v2 API - Class ControlServiceClientImpl (2.6.0) 

public sealed class ControlServiceClientImpl : ControlServiceClient

Reference documentation and code samples for the Retail v2 API class ControlServiceClientImpl.

ControlService client wrapper implementation, for convenient use.

Inheritance

object > ControlServiceClient > ControlServiceClientImpl

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Remarks

Service for modifying Control.

Constructors

ControlServiceClientImpl(ControlServiceClient, ControlServiceSettings, ILogger)

public ControlServiceClientImpl(ControlService.ControlServiceClient grpcClient, ControlServiceSettings settings, ILogger logger)

Constructs a client wrapper for the ControlService service, with the specified gRPC client and settings.

Parameters
NameDescription
grpcClientControlServiceControlServiceClient

The underlying gRPC client.

settingsControlServiceSettings

The base ControlServiceSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override ControlService.ControlServiceClient GrpcClient { get; }

The underlying gRPC ControlService client

Property Value
TypeDescription
ControlServiceControlServiceClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
TypeDescription
LocationsClient
Overrides

Methods

CreateControl(CreateControlRequest, CallSettings)

public override Control CreateControl(CreateControlRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Control

The RPC response.

Overrides

CreateControlAsync(CreateControlRequest, CallSettings)

public override Task<Control> CreateControlAsync(CreateControlRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskControl

A Task containing the RPC response.

Overrides

DeleteControl(DeleteControlRequest, CallSettings)

public override void DeleteControl(DeleteControlRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

DeleteControlAsync(DeleteControlRequest, CallSettings)

public override Task DeleteControlAsync(DeleteControlRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

GetControl(GetControlRequest, CallSettings)

public override Control GetControl(GetControlRequest request, CallSettings callSettings = null)

Gets a Control.

Parameters
NameDescription
requestGetControlRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Control

The RPC response.

Overrides

GetControlAsync(GetControlRequest, CallSettings)

public override Task<Control> GetControlAsync(GetControlRequest request, CallSettings callSettings = null)

Gets a Control.

Parameters
NameDescription
requestGetControlRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskControl

A Task containing the RPC response.

Overrides

ListControls(ListControlsRequest, CallSettings)

public override PagedEnumerable<ListControlsResponse, Control> ListControls(ListControlsRequest request, CallSettings callSettings = null)

Lists all Controls by their parent [Catalog][google.cloud.retail.v2.Catalog].

Parameters
NameDescription
requestListControlsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListControlsResponseControl

A pageable sequence of Control resources.

Overrides

ListControlsAsync(ListControlsRequest, CallSettings)

public override PagedAsyncEnumerable<ListControlsResponse, Control> ListControlsAsync(ListControlsRequest request, CallSettings callSettings = null)

Lists all Controls by their parent [Catalog][google.cloud.retail.v2.Catalog].

Parameters
NameDescription
requestListControlsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListControlsResponseControl

A pageable asynchronous sequence of Control resources.

Overrides

UpdateControl(UpdateControlRequest, CallSettings)

public override Control UpdateControl(UpdateControlRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Control

The RPC response.

Overrides

UpdateControlAsync(UpdateControlRequest, CallSettings)

public override Task<Control> UpdateControlAsync(UpdateControlRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskControl

A Task containing the RPC response.

Overrides