Discovery Engine v1 API - Class ControlServiceClientImpl (1.5.0) 

public sealed class ControlServiceClientImpl : ControlServiceClient

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

ControlService client wrapper implementation, for convenient use.

Inheritance

object > ControlServiceClient > ControlServiceClientImpl

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Remarks

Service for performing CRUD operations on Controls. Controls allow for custom logic to be implemented in the serving path. Controls need to be attached to a Serving Config to be considered during a request.

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
Name Description
grpcClient ControlServiceControlServiceClient

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
ControlServiceControlServiceClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

Methods

CreateControl(CreateControlRequest, CallSettings)

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

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

CreateControlAsync(CreateControlRequest, CallSettings)

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

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

If not null, applies overrides to this RPC call.
Returns
Type Description
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.discoveryengine.v1.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

DeleteControlAsync(DeleteControlRequest, CallSettings)

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

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

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

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
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 [DataStore][google.cloud.discoveryengine.v1.DataStore].

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
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 [DataStore][google.cloud.discoveryengine.v1.DataStore].

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

UpdateControlAsync(UpdateControlRequest, CallSettings)

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

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskControl

A Task containing the RPC response.
Overrides