Discovery Engine v1beta API - Class EngineService.EngineServiceClient (1.0.0-beta12)

Version latest

• 1.0.0-beta12 (latest)
• 1.0.0-beta11

public class EngineService.EngineServiceClient : ClientBase<EngineService.EngineServiceClient>

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

Client for EngineService

Inheritance

object > ClientBase > ClientBaseEngineServiceEngineServiceClient > EngineService.EngineServiceClient

Inherited Members

ClientBase<EngineService.EngineServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Constructors

EngineServiceClient()

protected EngineServiceClient()

Protected parameterless constructor to allow creation of test doubles.

EngineServiceClient(CallInvoker)

public EngineServiceClient(CallInvoker callInvoker)

Creates a new client for EngineService that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

EngineServiceClient(ChannelBase)

public EngineServiceClient(ChannelBase channel)

Creates a new client for EngineService

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

EngineServiceClient(ClientBaseConfiguration)

protected EngineServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateEngine(CreateEngineRequest, CallOptions)

public virtual Operation CreateEngine(CreateEngineRequest request, CallOptions options)

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

Parameters
Name	Description
request	CreateEngineRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

CreateEngine(CreateEngineRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateEngine(CreateEngineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	CreateEngineRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

CreateEngineAsync(CreateEngineRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateEngineAsync(CreateEngineRequest request, CallOptions options)

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

Parameters
Name	Description
request	CreateEngineRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateEngineAsync(CreateEngineRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateEngineAsync(CreateEngineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	CreateEngineRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
LocationsLocationsClient	A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

DeleteEngine(DeleteEngineRequest, CallOptions)

public virtual Operation DeleteEngine(DeleteEngineRequest request, CallOptions options)

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

Parameters
Name	Description
request	DeleteEngineRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteEngine(DeleteEngineRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteEngine(DeleteEngineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	DeleteEngineRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteEngineAsync(DeleteEngineRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteEngineAsync(DeleteEngineRequest request, CallOptions options)

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

Parameters
Name	Description
request	DeleteEngineRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteEngineAsync(DeleteEngineRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteEngineAsync(DeleteEngineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	DeleteEngineRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

GetEngine(GetEngineRequest, CallOptions)

public virtual Engine GetEngine(GetEngineRequest request, CallOptions options)

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

Parameters
Name	Description
request	GetEngineRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Engine	The response received from the server.

GetEngine(GetEngineRequest, Metadata, DateTime?, CancellationToken)

public virtual Engine GetEngine(GetEngineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	GetEngineRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Engine	The response received from the server.

GetEngineAsync(GetEngineRequest, CallOptions)

public virtual AsyncUnaryCall<Engine> GetEngineAsync(GetEngineRequest request, CallOptions options)

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

Parameters
Name	Description
request	GetEngineRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEngine	The call object.

GetEngineAsync(GetEngineRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Engine> GetEngineAsync(GetEngineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	GetEngineRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEngine	The call object.

ListEngines(ListEnginesRequest, CallOptions)

public virtual ListEnginesResponse ListEngines(ListEnginesRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListEnginesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListEnginesResponse	The response received from the server.

ListEngines(ListEnginesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListEnginesResponse ListEngines(ListEnginesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListEnginesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListEnginesResponse	The response received from the server.

ListEnginesAsync(ListEnginesRequest, CallOptions)

public virtual AsyncUnaryCall<ListEnginesResponse> ListEnginesAsync(ListEnginesRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListEnginesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListEnginesResponse	The call object.

ListEnginesAsync(ListEnginesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListEnginesResponse> ListEnginesAsync(ListEnginesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListEnginesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListEnginesResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override EngineService.EngineServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
EngineServiceEngineServiceClient

Overrides

ClientBase<EngineService.EngineServiceClient>.NewInstance(ClientBase.ClientBaseConfiguration)

PauseEngine(PauseEngineRequest, CallOptions)

public virtual Engine PauseEngine(PauseEngineRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Engine	The response received from the server.

PauseEngine(PauseEngineRequest, Metadata, DateTime?, CancellationToken)

public virtual Engine PauseEngine(PauseEngineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Engine	The response received from the server.

PauseEngineAsync(PauseEngineRequest, CallOptions)

public virtual AsyncUnaryCall<Engine> PauseEngineAsync(PauseEngineRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEngine	The call object.

PauseEngineAsync(PauseEngineRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Engine> PauseEngineAsync(PauseEngineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEngine	The call object.

ResumeEngine(ResumeEngineRequest, CallOptions)

public virtual Engine ResumeEngine(ResumeEngineRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Engine	The response received from the server.

ResumeEngine(ResumeEngineRequest, Metadata, DateTime?, CancellationToken)

public virtual Engine ResumeEngine(ResumeEngineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Engine	The response received from the server.

ResumeEngineAsync(ResumeEngineRequest, CallOptions)

public virtual AsyncUnaryCall<Engine> ResumeEngineAsync(ResumeEngineRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEngine	The call object.

ResumeEngineAsync(ResumeEngineRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Engine> ResumeEngineAsync(ResumeEngineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEngine	The call object.

TuneEngine(TuneEngineRequest, CallOptions)

public virtual Operation TuneEngine(TuneEngineRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

TuneEngine(TuneEngineRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation TuneEngine(TuneEngineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

TuneEngineAsync(TuneEngineRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> TuneEngineAsync(TuneEngineRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

TuneEngineAsync(TuneEngineRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> TuneEngineAsync(TuneEngineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateEngine(UpdateEngineRequest, CallOptions)

public virtual Engine UpdateEngine(UpdateEngineRequest request, CallOptions options)

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

Parameters
Name	Description
request	UpdateEngineRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Engine	The response received from the server.

UpdateEngine(UpdateEngineRequest, Metadata, DateTime?, CancellationToken)

public virtual Engine UpdateEngine(UpdateEngineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	UpdateEngineRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Engine	The response received from the server.

UpdateEngineAsync(UpdateEngineRequest, CallOptions)

public virtual AsyncUnaryCall<Engine> UpdateEngineAsync(UpdateEngineRequest request, CallOptions options)

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

Parameters
Name	Description
request	UpdateEngineRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEngine	The call object.

UpdateEngineAsync(UpdateEngineRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Engine> UpdateEngineAsync(UpdateEngineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	UpdateEngineRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEngine	The call object.