Show / Hide Table of Contents

Class RunEvaluationRequest

Request message for EvaluationService.RunEvaluation.

Inheritance
object
RunEvaluationRequest
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CustomerEngagementSuite.v1beta.Data
Assembly: Google.Apis.CustomerEngagementSuite.v1beta.dll
Syntax
public class RunEvaluationRequest : IDirectResponseSchema

Properties

App

Required. The app to evaluate. Format: projects/{project}/locations/{location}/apps/{app}

Declaration
[JsonProperty("app")]
public virtual string App { get; set; }
Property Value
Type Description
string

AppVersion

Optional. The app version to evaluate. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}

Declaration
[JsonProperty("appVersion")]
public virtual string AppVersion { get; set; }
Property Value
Type Description
string

Config

Optional. The configuration to use for the run.

Declaration
[JsonProperty("config")]
public virtual EvaluationConfig Config { get; set; }
Property Value
Type Description
EvaluationConfig

DisplayName

Optional. The display name of the evaluation run.

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EvaluationDataset

Optional. An evaluation dataset to run. Format: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}

Declaration
[JsonProperty("evaluationDataset")]
public virtual string EvaluationDataset { get; set; }
Property Value
Type Description
string

Evaluations

Optional. List of evaluations to run. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}

Declaration
[JsonProperty("evaluations")]
public virtual IList<string> Evaluations { get; set; }
Property Value
Type Description
IList<string>

GenerateLatencyReport

Optional. Whether to generate a latency report for the evaluation run.

Declaration
[JsonProperty("generateLatencyReport")]
public virtual bool? GenerateLatencyReport { get; set; }
Property Value
Type Description
bool?

GoldenRunMethod

Optional. The method to run the evaluation if it is a golden evaluation. If not set, default to STABLE.

Declaration
[JsonProperty("goldenRunMethod")]
public virtual string GoldenRunMethod { get; set; }
Property Value
Type Description
string

OptimizationConfig

Optional. Configuration for running the optimization step after the evaluation run. If not set, the optimization step will not be run.

Declaration
[JsonProperty("optimizationConfig")]
public virtual OptimizationConfig OptimizationConfig { get; set; }
Property Value
Type Description
OptimizationConfig

PersonaRunConfigs

Optional. The configuration to use for the run per persona.

Declaration
[JsonProperty("personaRunConfigs")]
public virtual IList<PersonaRunConfig> PersonaRunConfigs { get; set; }
Property Value
Type Description
IList<PersonaRunConfig>

RunCount

Optional. The number of times to run the evaluation. If not set, the default value is 1 per golden, and 5 per scenario.

Declaration
[JsonProperty("runCount")]
public virtual int? RunCount { get; set; }
Property Value
Type Description
int?

ScheduledEvaluationRun

Optional. The resource name of the ScheduledEvaluationRun that is triggering this evaluation run. If this field is set, the scheduled_evaluation_run field on the created EvaluationRun resource will be populated from this value. Format: projects/{project}/locations/{location}/apps/{app}/scheduledEvaluationRuns/{scheduled_evaluation_run}

Declaration
[JsonProperty("scheduledEvaluationRun")]
public virtual string ScheduledEvaluationRun { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX