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

Version 1.0.0-beta13

• 1.0.0-beta18 (latest)
• 1.0.0-beta17

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

Inherited Members

EngineServiceClient.DefaultEndpoint

EngineServiceClient.DefaultScopes

EngineServiceClient.ServiceMetadata

EngineServiceClient.CreateAsync(CancellationToken)

EngineServiceClient.Create()

EngineServiceClient.ShutdownDefaultChannelsAsync()

EngineServiceClient.CreateEngineAsync(CreateEngineRequest, CancellationToken)

EngineServiceClient.PollOnceCreateEngine(string, CallSettings)

EngineServiceClient.PollOnceCreateEngineAsync(string, CallSettings)

EngineServiceClient.CreateEngine(string, Engine, string, CallSettings)

EngineServiceClient.CreateEngineAsync(string, Engine, string, CallSettings)

EngineServiceClient.CreateEngineAsync(string, Engine, string, CancellationToken)

EngineServiceClient.CreateEngine(CollectionName, Engine, string, CallSettings)

EngineServiceClient.CreateEngineAsync(CollectionName, Engine, string, CallSettings)

EngineServiceClient.CreateEngineAsync(CollectionName, Engine, string, CancellationToken)

EngineServiceClient.DeleteEngineAsync(DeleteEngineRequest, CancellationToken)

EngineServiceClient.PollOnceDeleteEngine(string, CallSettings)

EngineServiceClient.PollOnceDeleteEngineAsync(string, CallSettings)

EngineServiceClient.DeleteEngine(string, CallSettings)

EngineServiceClient.DeleteEngineAsync(string, CallSettings)

EngineServiceClient.DeleteEngineAsync(string, CancellationToken)

EngineServiceClient.DeleteEngine(EngineName, CallSettings)

EngineServiceClient.DeleteEngineAsync(EngineName, CallSettings)

EngineServiceClient.DeleteEngineAsync(EngineName, CancellationToken)

EngineServiceClient.UpdateEngineAsync(UpdateEngineRequest, CancellationToken)

EngineServiceClient.UpdateEngine(Engine, FieldMask, CallSettings)

EngineServiceClient.UpdateEngineAsync(Engine, FieldMask, CallSettings)

EngineServiceClient.UpdateEngineAsync(Engine, FieldMask, CancellationToken)

EngineServiceClient.GetEngineAsync(GetEngineRequest, CancellationToken)

EngineServiceClient.GetEngine(string, CallSettings)

EngineServiceClient.GetEngineAsync(string, CallSettings)

EngineServiceClient.GetEngineAsync(string, CancellationToken)

EngineServiceClient.GetEngine(EngineName, CallSettings)

EngineServiceClient.GetEngineAsync(EngineName, CallSettings)

EngineServiceClient.GetEngineAsync(EngineName, CancellationToken)

EngineServiceClient.ListEngines(string, string, int?, CallSettings)

EngineServiceClient.ListEnginesAsync(string, string, int?, CallSettings)

EngineServiceClient.ListEngines(CollectionName, string, int?, CallSettings)

EngineServiceClient.ListEnginesAsync(CollectionName, string, int?, CallSettings)

EngineServiceClient.PauseEngineAsync(PauseEngineRequest, CancellationToken)

EngineServiceClient.PauseEngine(string, CallSettings)

EngineServiceClient.PauseEngineAsync(string, CallSettings)

EngineServiceClient.PauseEngineAsync(string, CancellationToken)

EngineServiceClient.PauseEngine(EngineName, CallSettings)

EngineServiceClient.PauseEngineAsync(EngineName, CallSettings)

EngineServiceClient.PauseEngineAsync(EngineName, CancellationToken)

EngineServiceClient.ResumeEngineAsync(ResumeEngineRequest, CancellationToken)

EngineServiceClient.ResumeEngine(string, CallSettings)

EngineServiceClient.ResumeEngineAsync(string, CallSettings)

EngineServiceClient.ResumeEngineAsync(string, CancellationToken)

EngineServiceClient.ResumeEngine(EngineName, CallSettings)

EngineServiceClient.ResumeEngineAsync(EngineName, CallSettings)

EngineServiceClient.ResumeEngineAsync(EngineName, CancellationToken)

EngineServiceClient.TuneEngineAsync(TuneEngineRequest, CancellationToken)

EngineServiceClient.PollOnceTuneEngine(string, CallSettings)

EngineServiceClient.PollOnceTuneEngineAsync(string, CallSettings)

EngineServiceClient.TuneEngine(string, CallSettings)

EngineServiceClient.TuneEngineAsync(string, CallSettings)

EngineServiceClient.TuneEngineAsync(string, CancellationToken)

EngineServiceClient.TuneEngine(EngineName, CallSettings)

EngineServiceClient.TuneEngineAsync(EngineName, CallSettings)

EngineServiceClient.TuneEngineAsync(EngineName, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

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

EngineServiceClient.CreateEngineOperationsClient

DeleteEngineOperationsClient

public override OperationsClient DeleteEngineOperationsClient { get; }

The long-running operations client for DeleteEngine.

Property Value
Type	Description
OperationsClient

Overrides

EngineServiceClient.DeleteEngineOperationsClient

GrpcClient

public override EngineService.EngineServiceClient GrpcClient { get; }

The underlying gRPC EngineService client

Property Value
Type	Description
EngineServiceEngineServiceClient

Overrides

EngineServiceClient.GrpcClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

Overrides

EngineServiceClient.LocationsClient

TuneEngineOperationsClient

public override OperationsClient TuneEngineOperationsClient { get; }

The long-running operations client for TuneEngine.

Property Value
Type	Description
OperationsClient

Overrides

EngineServiceClient.TuneEngineOperationsClient

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

EngineServiceClient.CreateEngine(CreateEngineRequest, CallSettings)

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

EngineServiceClient.CreateEngineAsync(CreateEngineRequest, CallSettings)

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

EngineServiceClient.DeleteEngine(DeleteEngineRequest, CallSettings)

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

EngineServiceClient.DeleteEngineAsync(DeleteEngineRequest, CallSettings)

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

EngineServiceClient.GetEngine(GetEngineRequest, CallSettings)

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

EngineServiceClient.GetEngineAsync(GetEngineRequest, CallSettings)

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

EngineServiceClient.ListEngines(ListEnginesRequest, CallSettings)

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

EngineServiceClient.ListEnginesAsync(ListEnginesRequest, CallSettings)

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

EngineServiceClient.PauseEngine(PauseEngineRequest, CallSettings)

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

EngineServiceClient.PauseEngineAsync(PauseEngineRequest, CallSettings)

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

EngineServiceClient.ResumeEngine(ResumeEngineRequest, CallSettings)

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

EngineServiceClient.ResumeEngineAsync(ResumeEngineRequest, CallSettings)

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

EngineServiceClient.TuneEngine(TuneEngineRequest, CallSettings)

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

EngineServiceClient.TuneEngineAsync(TuneEngineRequest, CallSettings)

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

EngineServiceClient.UpdateEngine(UpdateEngineRequest, CallSettings)

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

EngineServiceClient.UpdateEngineAsync(UpdateEngineRequest, CallSettings)