Retail v2 API - Class ControlServiceClientImpl (2.4.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

Inherited Members

ControlServiceClient.DefaultEndpoint

ControlServiceClient.DefaultScopes

ControlServiceClient.ServiceMetadata

ControlServiceClient.CreateAsync(CancellationToken)

ControlServiceClient.Create()

ControlServiceClient.ShutdownDefaultChannelsAsync()

ControlServiceClient.CreateControlAsync(CreateControlRequest, CancellationToken)

ControlServiceClient.CreateControl(String, Control, String, CallSettings)

ControlServiceClient.CreateControlAsync(String, Control, String, CallSettings)

ControlServiceClient.CreateControlAsync(String, Control, String, CancellationToken)

ControlServiceClient.CreateControl(CatalogName, Control, String, CallSettings)

ControlServiceClient.CreateControlAsync(CatalogName, Control, String, CallSettings)

ControlServiceClient.CreateControlAsync(CatalogName, Control, String, CancellationToken)

ControlServiceClient.DeleteControlAsync(DeleteControlRequest, CancellationToken)

ControlServiceClient.DeleteControl(String, CallSettings)

ControlServiceClient.DeleteControlAsync(String, CallSettings)

ControlServiceClient.DeleteControlAsync(String, CancellationToken)

ControlServiceClient.DeleteControl(ControlName, CallSettings)

ControlServiceClient.DeleteControlAsync(ControlName, CallSettings)

ControlServiceClient.DeleteControlAsync(ControlName, CancellationToken)

ControlServiceClient.UpdateControlAsync(UpdateControlRequest, CancellationToken)

ControlServiceClient.UpdateControl(Control, FieldMask, CallSettings)

ControlServiceClient.UpdateControlAsync(Control, FieldMask, CallSettings)

ControlServiceClient.UpdateControlAsync(Control, FieldMask, CancellationToken)

ControlServiceClient.GetControlAsync(GetControlRequest, CancellationToken)

ControlServiceClient.GetControl(String, CallSettings)

ControlServiceClient.GetControlAsync(String, CallSettings)

ControlServiceClient.GetControlAsync(String, CancellationToken)

ControlServiceClient.GetControl(ControlName, CallSettings)

ControlServiceClient.GetControlAsync(ControlName, CallSettings)

ControlServiceClient.GetControlAsync(ControlName, CancellationToken)

ControlServiceClient.ListControls(String, String, Nullable<Int32>, CallSettings)

ControlServiceClient.ListControlsAsync(String, String, Nullable<Int32>, CallSettings)

ControlServiceClient.ListControls(CatalogName, String, Nullable<Int32>, CallSettings)

ControlServiceClient.ListControlsAsync(CatalogName, String, Nullable<Int32>, CallSettings)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Remarks

Service for modifying Control.

Constructors

ControlServiceClientImpl(ControlService.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
Name	Description
`grpcClient`	`ControlService.ControlServiceClient` The underlying gRPC client.
`settings`	`ControlServiceSettings` The base ControlServiceSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

GrpcClient

public override ControlService.ControlServiceClient GrpcClient { get; }

The underlying gRPC ControlService client

Property Value
Type	Description
`ControlService.ControlServiceClient`

Overrides

ControlServiceClient.GrpcClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
`LocationsClient`

Overrides

ControlServiceClient.LocationsClient

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
Name	Description
`request`	`CreateControlRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Control`	The RPC response.

Overrides

ControlServiceClient.CreateControl(CreateControlRequest, CallSettings)

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
Name	Description
`request`	`CreateControlRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Control>`	A Task containing the RPC response.

Overrides

ControlServiceClient.CreateControlAsync(CreateControlRequest, CallSettings)

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
Name	Description
`request`	`DeleteControlRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Overrides

ControlServiceClient.DeleteControl(DeleteControlRequest, CallSettings)

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
Name	Description
`request`	`DeleteControlRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Overrides

ControlServiceClient.DeleteControlAsync(DeleteControlRequest, CallSettings)

GetControl(GetControlRequest, CallSettings)

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

Gets a Control.

Parameters
Name	Description
`request`	`GetControlRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Control`	The RPC response.

Overrides

ControlServiceClient.GetControl(GetControlRequest, CallSettings)

GetControlAsync(GetControlRequest, CallSettings)

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

Gets a Control.

Parameters
Name	Description
`request`	`GetControlRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Control>`	A Task containing the RPC response.

Overrides

ControlServiceClient.GetControlAsync(GetControlRequest, CallSettings)

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
Name	Description
`request`	`ListControlsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerable<ListControlsResponse, Control>`	A pageable sequence of Control resources.

Overrides

ControlServiceClient.ListControls(ListControlsRequest, CallSettings)

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
Name	Description
`request`	`ListControlsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerable<ListControlsResponse, Control>`	A pageable asynchronous sequence of Control resources.

Overrides

ControlServiceClient.ListControlsAsync(ListControlsRequest, CallSettings)

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
Name	Description
`request`	`UpdateControlRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Control`	The RPC response.

Overrides

ControlServiceClient.UpdateControl(UpdateControlRequest, CallSettings)

UpdateControlAsync(UpdateControlRequest, CallSettings)

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

Updates a Control.

Parameters
Name	Description
`request`	`UpdateControlRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Control>`	A Task containing the RPC response.

Overrides

ControlServiceClient.UpdateControlAsync(UpdateControlRequest, CallSettings)