Discovery Engine v1beta API - Class EvaluationService.EvaluationServiceClient (1.0.0-beta15)

public class EvaluationService.EvaluationServiceClient : ClientBase<EvaluationService.EvaluationServiceClient>

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

Client for EvaluationService

Inheritance

object > ClientBase > ClientBaseEvaluationServiceEvaluationServiceClient > EvaluationService.EvaluationServiceClient

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Constructors

EvaluationServiceClient()

protected EvaluationServiceClient()

Protected parameterless constructor to allow creation of test doubles.

EvaluationServiceClient(CallInvoker)

public EvaluationServiceClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

EvaluationServiceClient(ChannelBase)

public EvaluationServiceClient(ChannelBase channel)

Creates a new client for EvaluationService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

EvaluationServiceClient(ClientBaseConfiguration)

protected EvaluationServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateEvaluation(CreateEvaluationRequest, CallOptions)

public virtual Operation CreateEvaluation(CreateEvaluationRequest request, CallOptions options)

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

Upon creation, the evaluation will be automatically triggered and begin execution.

Parameters
Name Description
request CreateEvaluationRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

CreateEvaluation(CreateEvaluationRequest, Metadata, DateTime?, CancellationToken)

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

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

Upon creation, the evaluation will be automatically triggered and begin execution.

Parameters
Name Description
request CreateEvaluationRequest

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.

CreateEvaluationAsync(CreateEvaluationRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateEvaluationAsync(CreateEvaluationRequest request, CallOptions options)

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

Upon creation, the evaluation will be automatically triggered and begin execution.

Parameters
Name Description
request CreateEvaluationRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateEvaluationAsync(CreateEvaluationRequest, Metadata, DateTime?, CancellationToken)

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

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

Upon creation, the evaluation will be automatically triggered and begin execution.

Parameters
Name Description
request CreateEvaluationRequest

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.

GetEvaluation(GetEvaluationRequest, CallOptions)

public virtual Evaluation GetEvaluation(GetEvaluationRequest request, CallOptions options)

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

Parameters
Name Description
request GetEvaluationRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Evaluation

The response received from the server.

GetEvaluation(GetEvaluationRequest, Metadata, DateTime?, CancellationToken)

public virtual Evaluation GetEvaluation(GetEvaluationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request GetEvaluationRequest

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
Evaluation

The response received from the server.

GetEvaluationAsync(GetEvaluationRequest, CallOptions)

public virtual AsyncUnaryCall<Evaluation> GetEvaluationAsync(GetEvaluationRequest request, CallOptions options)

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

Parameters
Name Description
request GetEvaluationRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEvaluation

The call object.

GetEvaluationAsync(GetEvaluationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Evaluation> GetEvaluationAsync(GetEvaluationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request GetEvaluationRequest

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
AsyncUnaryCallEvaluation

The call object.

ListEvaluationResults(ListEvaluationResultsRequest, CallOptions)

public virtual ListEvaluationResultsResponse ListEvaluationResults(ListEvaluationResultsRequest request, CallOptions options)

Gets a list of results for a given a [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation].

Parameters
Name Description
request ListEvaluationResultsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListEvaluationResultsResponse

The response received from the server.

ListEvaluationResults(ListEvaluationResultsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListEvaluationResultsResponse ListEvaluationResults(ListEvaluationResultsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a list of results for a given a [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation].

Parameters
Name Description
request ListEvaluationResultsRequest

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
ListEvaluationResultsResponse

The response received from the server.

ListEvaluationResultsAsync(ListEvaluationResultsRequest, CallOptions)

public virtual AsyncUnaryCall<ListEvaluationResultsResponse> ListEvaluationResultsAsync(ListEvaluationResultsRequest request, CallOptions options)

Gets a list of results for a given a [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation].

Parameters
Name Description
request ListEvaluationResultsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListEvaluationResultsResponse

The call object.

ListEvaluationResultsAsync(ListEvaluationResultsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListEvaluationResultsResponse> ListEvaluationResultsAsync(ListEvaluationResultsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a list of results for a given a [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation].

Parameters
Name Description
request ListEvaluationResultsRequest

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
AsyncUnaryCallListEvaluationResultsResponse

The call object.

ListEvaluations(ListEvaluationsRequest, CallOptions)

public virtual ListEvaluationsResponse ListEvaluations(ListEvaluationsRequest request, CallOptions options)

Gets a list of [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]s.

Parameters
Name Description
request ListEvaluationsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListEvaluationsResponse

The response received from the server.

ListEvaluations(ListEvaluationsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListEvaluationsResponse ListEvaluations(ListEvaluationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a list of [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]s.

Parameters
Name Description
request ListEvaluationsRequest

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
ListEvaluationsResponse

The response received from the server.

ListEvaluationsAsync(ListEvaluationsRequest, CallOptions)

public virtual AsyncUnaryCall<ListEvaluationsResponse> ListEvaluationsAsync(ListEvaluationsRequest request, CallOptions options)

Gets a list of [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]s.

Parameters
Name Description
request ListEvaluationsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListEvaluationsResponse

The call object.

ListEvaluationsAsync(ListEvaluationsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListEvaluationsResponse> ListEvaluationsAsync(ListEvaluationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a list of [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]s.

Parameters
Name Description
request ListEvaluationsRequest

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
AsyncUnaryCallListEvaluationsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override EvaluationService.EvaluationServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
EvaluationServiceEvaluationServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.DiscoveryEngine.V1Beta.EvaluationService.EvaluationServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)