Interface EvaluationResultOrBuilder (0.3.0) 

public interface EvaluationResultOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAppVersion()

public abstract String getAppVersion()

Output only. The app version used to generate the conversation that resulted in this result. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}

string app_version = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The appVersion.

getAppVersionBytes()

public abstract ByteString getAppVersionBytes()

Output only. The app version used to generate the conversation that resulted in this result. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}

string app_version = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for appVersion.

getAppVersionDisplayName()

public abstract String getAppVersionDisplayName()

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

string app_version_display_name = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The appVersionDisplayName.

getAppVersionDisplayNameBytes()

public abstract ByteString getAppVersionDisplayNameBytes()

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

string app_version_display_name = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for appVersionDisplayName.

getChangelog()

public abstract String getChangelog()

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

string changelog = 21 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The changelog.

getChangelogBytes()

public abstract ByteString getChangelogBytes()

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

string changelog = 21 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for changelog.

getChangelogCreateTime()

public abstract Timestamp getChangelogCreateTime()

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.

.google.protobuf.Timestamp changelog_create_time = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The changelogCreateTime.

getChangelogCreateTimeOrBuilder()

public abstract TimestampOrBuilder getChangelogCreateTimeOrBuilder()

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.

.google.protobuf.Timestamp changelog_create_time = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getConfig()

public abstract EvaluationConfig getConfig()

Output only. The configuration used in the evaluation run that resulted in this result.

.google.cloud.ces.v1beta.EvaluationConfig config = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationConfig

The config.

getConfigOrBuilder()

public abstract EvaluationConfigOrBuilder getConfigOrBuilder()

Output only. The configuration used in the evaluation run that resulted in this result.

.google.cloud.ces.v1beta.EvaluationConfig config = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationConfigOrBuilder

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Timestamp when the evaluation result was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when the evaluation result was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDisplayName()

public abstract String getDisplayName()

Required. Display name of the Evaluation Result. Unique within an Evaluation. By default, it has the following format: "<evaluation-display-name> result

  • <timestamp>".

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Required. Display name of the Evaluation Result. Unique within an Evaluation. By default, it has the following format: "<evaluation-display-name> result

  • <timestamp>".

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getError() (deprecated)

public abstract Status getError()

Deprecated. google.cloud.ces.v1beta.EvaluationResult.error is deprecated. See google/cloud/ces/v1beta/evaluation.proto;l=988

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

.google.rpc.Status error = 14 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.rpc.Status

The error.

getErrorInfo()

public abstract EvaluationErrorInfo getErrorInfo()

Output only. Error information for the evaluation result.

.google.cloud.ces.v1beta.EvaluationErrorInfo error_info = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationErrorInfo

The errorInfo.

getErrorInfoOrBuilder()

public abstract EvaluationErrorInfoOrBuilder getErrorInfoOrBuilder()

Output only. Error information for the evaluation result.

.google.cloud.ces.v1beta.EvaluationErrorInfo error_info = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationErrorInfoOrBuilder

getErrorOrBuilder() (deprecated)

public abstract StatusOrBuilder getErrorOrBuilder()

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

.google.rpc.Status error = 14 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.rpc.StatusOrBuilder

getEvaluationMetricsThresholds()

public abstract EvaluationMetricsThresholds getEvaluationMetricsThresholds()

Output only. The evaluation thresholds for the result.

.google.cloud.ces.v1beta.EvaluationMetricsThresholds evaluation_metrics_thresholds = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationMetricsThresholds

The evaluationMetricsThresholds.

getEvaluationMetricsThresholdsOrBuilder()

public abstract EvaluationMetricsThresholdsOrBuilder getEvaluationMetricsThresholdsOrBuilder()

Output only. The evaluation thresholds for the result.

.google.cloud.ces.v1beta.EvaluationMetricsThresholds evaluation_metrics_thresholds = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationMetricsThresholdsOrBuilder

getEvaluationRun()

public abstract String getEvaluationRun()

Output only. The evaluation run that produced this result. Format: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}

string evaluation_run = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The evaluationRun.

getEvaluationRunBytes()

public abstract ByteString getEvaluationRunBytes()

Output only. The evaluation run that produced this result. Format: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}

string evaluation_run = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for evaluationRun.

getEvaluationStatus()

public abstract EvaluationResult.Outcome getEvaluationStatus()

Output only. The outcome of the evaluation. Only populated if execution_state is COMPLETE.

.google.cloud.ces.v1beta.EvaluationResult.Outcome evaluation_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationResult.Outcome

The evaluationStatus.

getEvaluationStatusValue()

public abstract int getEvaluationStatusValue()

Output only. The outcome of the evaluation. Only populated if execution_state is COMPLETE.

.google.cloud.ces.v1beta.EvaluationResult.Outcome evaluation_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for evaluationStatus.

getExecutionState()

public abstract EvaluationResult.ExecutionState getExecutionState()

Output only. The state of the evaluation result execution.

.google.cloud.ces.v1beta.EvaluationResult.ExecutionState execution_state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationResult.ExecutionState

The executionState.

getExecutionStateValue()

public abstract int getExecutionStateValue()

Output only. The state of the evaluation result execution.

.google.cloud.ces.v1beta.EvaluationResult.ExecutionState execution_state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for executionState.

getGoldenResult()

public abstract EvaluationResult.GoldenResult getGoldenResult()

Output only. The outcome of a golden evaluation.

.google.cloud.ces.v1beta.EvaluationResult.GoldenResult golden_result = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationResult.GoldenResult

The goldenResult.

getGoldenResultOrBuilder()

public abstract EvaluationResult.GoldenResultOrBuilder getGoldenResultOrBuilder()

Output only. The outcome of a golden evaluation.

.google.cloud.ces.v1beta.EvaluationResult.GoldenResult golden_result = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationResult.GoldenResultOrBuilder

getGoldenRunMethod()

public abstract GoldenRunMethod getGoldenRunMethod()

Output only. The method used to run the golden evaluation.

.google.cloud.ces.v1beta.GoldenRunMethod golden_run_method = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
GoldenRunMethod

The goldenRunMethod.

getGoldenRunMethodValue()

public abstract int getGoldenRunMethodValue()

Output only. The method used to run the golden evaluation.

.google.cloud.ces.v1beta.GoldenRunMethod golden_run_method = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for goldenRunMethod.

getInitiatedBy()

public abstract String getInitiatedBy()

Output only. The user who initiated the evaluation run that resulted in this result.

string initiated_by = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The initiatedBy.

getInitiatedByBytes()

public abstract ByteString getInitiatedByBytes()

Output only. The user who initiated the evaluation run that resulted in this result.

string initiated_by = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for initiatedBy.

getName()

public abstract String getName()

Identifier. The unique identifier of the evaluation result. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. The unique identifier of the evaluation result. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getPersona()

public abstract EvaluationPersona getPersona()

Output only. The persona used to generate the conversation for the evaluation result.

.google.cloud.ces.v1beta.EvaluationPersona persona = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationPersona

The persona.

getPersonaOrBuilder()

public abstract EvaluationPersonaOrBuilder getPersonaOrBuilder()

Output only. The persona used to generate the conversation for the evaluation result.

.google.cloud.ces.v1beta.EvaluationPersona persona = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationPersonaOrBuilder

getResultCase()

public abstract EvaluationResult.ResultCase getResultCase()
Returns
Type Description
EvaluationResult.ResultCase

getScenarioResult()

public abstract EvaluationResult.ScenarioResult getScenarioResult()

Output only. The outcome of a scenario evaluation.

.google.cloud.ces.v1beta.EvaluationResult.ScenarioResult scenario_result = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationResult.ScenarioResult

The scenarioResult.

getScenarioResultOrBuilder()

public abstract EvaluationResult.ScenarioResultOrBuilder getScenarioResultOrBuilder()

Output only. The outcome of a scenario evaluation.

.google.cloud.ces.v1beta.EvaluationResult.ScenarioResult scenario_result = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationResult.ScenarioResultOrBuilder

hasChangelogCreateTime()

public abstract boolean hasChangelogCreateTime()

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.

.google.protobuf.Timestamp changelog_create_time = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the changelogCreateTime field is set.

hasConfig()

public abstract boolean hasConfig()

Output only. The configuration used in the evaluation run that resulted in this result.

.google.cloud.ces.v1beta.EvaluationConfig config = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the config field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Timestamp when the evaluation result was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasError() (deprecated)

public abstract boolean hasError()

Deprecated. google.cloud.ces.v1beta.EvaluationResult.error is deprecated. See google/cloud/ces/v1beta/evaluation.proto;l=988

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

.google.rpc.Status error = 14 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the error field is set.

hasErrorInfo()

public abstract boolean hasErrorInfo()

Output only. Error information for the evaluation result.

.google.cloud.ces.v1beta.EvaluationErrorInfo error_info = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the errorInfo field is set.

hasEvaluationMetricsThresholds()

public abstract boolean hasEvaluationMetricsThresholds()

Output only. The evaluation thresholds for the result.

.google.cloud.ces.v1beta.EvaluationMetricsThresholds evaluation_metrics_thresholds = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the evaluationMetricsThresholds field is set.

hasGoldenResult()

public abstract boolean hasGoldenResult()

Output only. The outcome of a golden evaluation.

.google.cloud.ces.v1beta.EvaluationResult.GoldenResult golden_result = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the goldenResult field is set.

hasPersona()

public abstract boolean hasPersona()

Output only. The persona used to generate the conversation for the evaluation result.

.google.cloud.ces.v1beta.EvaluationPersona persona = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the persona field is set.

hasScenarioResult()

public abstract boolean hasScenarioResult()

Output only. The outcome of a scenario evaluation.

.google.cloud.ces.v1beta.EvaluationResult.ScenarioResult scenario_result = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the scenarioResult field is set.