Discovery Engine v1beta API - Class EngineServiceClientImpl (1.0.0-beta15)

public sealed class EngineServiceClientImpl : EngineServiceClient

Reference documentation and code samples for the Discovery Engine v1beta API class EngineServiceClientImpl.

EngineService client wrapper implementation, for convenient use.

Inheritance

object > EngineServiceClient > EngineServiceClientImpl

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Remarks

Service for managing [Engine][google.cloud.discoveryengine.v1beta.Engine] configuration.

Constructors

EngineServiceClientImpl(EngineServiceClient, EngineServiceSettings, ILogger)

public EngineServiceClientImpl(EngineService.EngineServiceClient grpcClient, EngineServiceSettings settings, ILogger logger)

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

Parameters
Name Description
grpcClient EngineServiceEngineServiceClient

The underlying gRPC client.

settings EngineServiceSettings

The base EngineServiceSettings used within this client.

logger ILogger

Optional ILogger to use within this client.

Properties

CreateEngineOperationsClient

public override OperationsClient CreateEngineOperationsClient { get; }

The long-running operations client for CreateEngine.

Property Value
Type Description
OperationsClient
Overrides

DeleteEngineOperationsClient

public override OperationsClient DeleteEngineOperationsClient { get; }

The long-running operations client for DeleteEngine.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override EngineService.EngineServiceClient GrpcClient { get; }

The underlying gRPC EngineService client

Property Value
Type Description
EngineServiceEngineServiceClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

TuneEngineOperationsClient

public override OperationsClient TuneEngineOperationsClient { get; }

The long-running operations client for TuneEngine.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateEngine(CreateEngineRequest, CallSettings)

public override Operation<Engine, CreateEngineMetadata> CreateEngine(CreateEngineRequest request, CallSettings callSettings = null)

Creates a [Engine][google.cloud.discoveryengine.v1beta.Engine].

Parameters
Name Description
request CreateEngineRequest

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
OperationEngineCreateEngineMetadata

The RPC response.

Overrides

CreateEngineAsync(CreateEngineRequest, CallSettings)

public override Task<Operation<Engine, CreateEngineMetadata>> CreateEngineAsync(CreateEngineRequest request, CallSettings callSettings = null)

Creates a [Engine][google.cloud.discoveryengine.v1beta.Engine].

Parameters
Name Description
request CreateEngineRequest

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
TaskOperationEngineCreateEngineMetadata

A Task containing the RPC response.

Overrides

DeleteEngine(DeleteEngineRequest, CallSettings)

public override Operation<Empty, DeleteEngineMetadata> DeleteEngine(DeleteEngineRequest request, CallSettings callSettings = null)

Deletes a [Engine][google.cloud.discoveryengine.v1beta.Engine].

Parameters
Name Description
request DeleteEngineRequest

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
OperationEmptyDeleteEngineMetadata

The RPC response.

Overrides

DeleteEngineAsync(DeleteEngineRequest, CallSettings)

public override Task<Operation<Empty, DeleteEngineMetadata>> DeleteEngineAsync(DeleteEngineRequest request, CallSettings callSettings = null)

Deletes a [Engine][google.cloud.discoveryengine.v1beta.Engine].

Parameters
Name Description
request DeleteEngineRequest

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
TaskOperationEmptyDeleteEngineMetadata

A Task containing the RPC response.

Overrides

GetEngine(GetEngineRequest, CallSettings)

public override Engine GetEngine(GetEngineRequest request, CallSettings callSettings = null)

Gets a [Engine][google.cloud.discoveryengine.v1beta.Engine].

Parameters
Name Description
request GetEngineRequest

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
Engine

The RPC response.

Overrides

GetEngineAsync(GetEngineRequest, CallSettings)

public override Task<Engine> GetEngineAsync(GetEngineRequest request, CallSettings callSettings = null)

Gets a [Engine][google.cloud.discoveryengine.v1beta.Engine].

Parameters
Name Description
request GetEngineRequest

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
TaskEngine

A Task containing the RPC response.

Overrides

ListEngines(ListEnginesRequest, CallSettings)

public override PagedEnumerable<ListEnginesResponse, Engine> ListEngines(ListEnginesRequest request, CallSettings callSettings = null)

Lists all the [Engine][google.cloud.discoveryengine.v1beta.Engine]s associated with the project.

Parameters
Name Description
request ListEnginesRequest

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
PagedEnumerableListEnginesResponseEngine

A pageable sequence of Engine resources.

Overrides

ListEnginesAsync(ListEnginesRequest, CallSettings)

public override PagedAsyncEnumerable<ListEnginesResponse, Engine> ListEnginesAsync(ListEnginesRequest request, CallSettings callSettings = null)

Lists all the [Engine][google.cloud.discoveryengine.v1beta.Engine]s associated with the project.

Parameters
Name Description
request ListEnginesRequest

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
PagedAsyncEnumerableListEnginesResponseEngine

A pageable asynchronous sequence of Engine resources.

Overrides

PauseEngine(PauseEngineRequest, CallSettings)

public override Engine PauseEngine(PauseEngineRequest request, CallSettings callSettings = null)

Pauses the training of an existing engine. Only applicable if [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].

Parameters
Name Description
request PauseEngineRequest

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
Engine

The RPC response.

Overrides

PauseEngineAsync(PauseEngineRequest, CallSettings)

public override Task<Engine> PauseEngineAsync(PauseEngineRequest request, CallSettings callSettings = null)

Pauses the training of an existing engine. Only applicable if [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].

Parameters
Name Description
request PauseEngineRequest

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
TaskEngine

A Task containing the RPC response.

Overrides

ResumeEngine(ResumeEngineRequest, CallSettings)

public override Engine ResumeEngine(ResumeEngineRequest request, CallSettings callSettings = null)

Resumes the training of an existing engine. Only applicable if [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].

Parameters
Name Description
request ResumeEngineRequest

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
Engine

The RPC response.

Overrides

ResumeEngineAsync(ResumeEngineRequest, CallSettings)

public override Task<Engine> ResumeEngineAsync(ResumeEngineRequest request, CallSettings callSettings = null)

Resumes the training of an existing engine. Only applicable if [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].

Parameters
Name Description
request ResumeEngineRequest

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
TaskEngine

A Task containing the RPC response.

Overrides

TuneEngine(TuneEngineRequest, CallSettings)

public override Operation<TuneEngineResponse, TuneEngineMetadata> TuneEngine(TuneEngineRequest request, CallSettings callSettings = null)

Tunes an existing engine. Only applicable if [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].

Parameters
Name Description
request TuneEngineRequest

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
OperationTuneEngineResponseTuneEngineMetadata

The RPC response.

Overrides

TuneEngineAsync(TuneEngineRequest, CallSettings)

public override Task<Operation<TuneEngineResponse, TuneEngineMetadata>> TuneEngineAsync(TuneEngineRequest request, CallSettings callSettings = null)

Tunes an existing engine. Only applicable if [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].

Parameters
Name Description
request TuneEngineRequest

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
TaskOperationTuneEngineResponseTuneEngineMetadata

A Task containing the RPC response.

Overrides

UpdateEngine(UpdateEngineRequest, CallSettings)

public override Engine UpdateEngine(UpdateEngineRequest request, CallSettings callSettings = null)

Updates an [Engine][google.cloud.discoveryengine.v1beta.Engine]

Parameters
Name Description
request UpdateEngineRequest

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
Engine

The RPC response.

Overrides

UpdateEngineAsync(UpdateEngineRequest, CallSettings)

public override Task<Engine> UpdateEngineAsync(UpdateEngineRequest request, CallSettings callSettings = null)

Updates an [Engine][google.cloud.discoveryengine.v1beta.Engine]

Parameters
Name Description
request UpdateEngineRequest

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
TaskEngine

A Task containing the RPC response.

Overrides