Class EvaluationRun

An evaluation run represents an all the evaluation results from an evaluation execution.

Inheritance
object
EvaluationRun
Implements
Inherited Members
Namespace: Google.Apis.CustomerEngagementSuite.v1beta.Data
Assembly: Google.Apis.CustomerEngagementSuite.v1beta.dll
Syntax
public class EvaluationRun : IDirectResponseSchema

Properties

AppVersion

Output only. 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

AppVersionDisplayName

Output only. The display name of the app_version that the evaluation ran against.

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

Changelog

Output only. The changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft.

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

ChangelogCreateTime

object representation of ChangelogCreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ChangelogCreateTimeDateTimeOffset instead.")]
public virtual object ChangelogCreateTime { get; set; }
Property Value
Type Description
object

ChangelogCreateTimeDateTimeOffset

DateTimeOffset representation of ChangelogCreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? ChangelogCreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

ChangelogCreateTimeRaw

Output only. The create time of the changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft.

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

Config

Output only. The configuration used in the run.

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

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. Timestamp when the evaluation run was created.

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

DisplayName

Optional. User-defined display name of the evaluation run. default: " 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

Error

Output only. Deprecated: Use error_info instead. Errors encountered during execution.

Declaration
[JsonProperty("error")]
public virtual Status Error { get; set; }
Property Value
Type Description
Status

ErrorInfo

Output only. Error information for the evaluation run.

Declaration
[JsonProperty("errorInfo")]
public virtual EvaluationErrorInfo ErrorInfo { get; set; }
Property Value
Type Description
EvaluationErrorInfo

EvaluationDataset

Output only. The evaluation dataset that this run is associated with. This field is mutually exclusive with evaluations. Format: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}

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

EvaluationResults

Output only. The evaluation results that are part of this run. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}

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

EvaluationRunSummaries

Output only. Map of evaluation name to EvaluationRunSummary.

Declaration
[JsonProperty("evaluationRunSummaries")]
public virtual IDictionary<string, EvaluationRunEvaluationRunSummary> EvaluationRunSummaries { get; set; }
Property Value
Type Description
IDictionary<string, EvaluationRunEvaluationRunSummary>

EvaluationType

Output only. The type of the evaluations in this run.

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

Evaluations

Output only. The evaluations that are part of this run. The list may contain evaluations of either type. This field is mutually exclusive with evaluation_dataset. 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>

GoldenRunMethod

Output only. The method used to run the evaluation.

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

InitiatedBy

Output only. The user who initiated the evaluation run.

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

LatencyReport

Output only. Latency report for the evaluation run.

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

Name

Identifier. The unique identifier of the evaluation run. Format: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}

Declaration
[JsonProperty("name")]
public virtual string Name { 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

Output only. 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>

Progress

Output only. The progress of the evaluation run.

Declaration
[JsonProperty("progress")]
public virtual EvaluationRunProgress Progress { get; set; }
Property Value
Type Description
EvaluationRunProgress

RunCount

Output only. The number of times the evaluations inside the run were run.

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

ScheduledEvaluationRun

Output only. The scheduled evaluation run resource name that created this evaluation run. This field is only set if the evaluation run was created by a scheduled evaluation run. 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

State

Output only. The state of the evaluation run.

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

Implements