Class EvaluationResult.Builder (0.3.0)

public static final class EvaluationResult.Builder extends GeneratedMessage.Builder<EvaluationResult.Builder> implements EvaluationResultOrBuilder

An evaluation result represents the output of running an Evaluation.

Protobuf type google.cloud.ces.v1beta.EvaluationResult

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public EvaluationResult build()
Returns
Type Description
EvaluationResult

buildPartial()

public EvaluationResult buildPartial()
Returns
Type Description
EvaluationResult

clear()

public EvaluationResult.Builder clear()
Returns
Type Description
EvaluationResult.Builder
Overrides

clearAppVersion()

public EvaluationResult.Builder clearAppVersion()

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
EvaluationResult.Builder

This builder for chaining.

clearAppVersionDisplayName()

public EvaluationResult.Builder clearAppVersionDisplayName()

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
EvaluationResult.Builder

This builder for chaining.

clearChangelog()

public EvaluationResult.Builder clearChangelog()

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
EvaluationResult.Builder

This builder for chaining.

clearChangelogCreateTime()

public EvaluationResult.Builder clearChangelogCreateTime()

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
EvaluationResult.Builder

clearConfig()

public EvaluationResult.Builder clearConfig()

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
EvaluationResult.Builder

clearCreateTime()

public EvaluationResult.Builder clearCreateTime()

Output only. Timestamp when the evaluation result was created.

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

Returns
Type Description
EvaluationResult.Builder

clearDisplayName()

public EvaluationResult.Builder clearDisplayName()

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
EvaluationResult.Builder

This builder for chaining.

clearError() (deprecated)

public EvaluationResult.Builder clearError()

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
EvaluationResult.Builder

clearErrorInfo()

public EvaluationResult.Builder clearErrorInfo()

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
EvaluationResult.Builder

clearEvaluationMetricsThresholds()

public EvaluationResult.Builder clearEvaluationMetricsThresholds()

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
EvaluationResult.Builder

clearEvaluationRun()

public EvaluationResult.Builder clearEvaluationRun()

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
EvaluationResult.Builder

This builder for chaining.

clearEvaluationStatus()

public EvaluationResult.Builder clearEvaluationStatus()

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.Builder

This builder for chaining.

clearExecutionState()

public EvaluationResult.Builder clearExecutionState()

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.Builder

This builder for chaining.

clearGoldenResult()

public EvaluationResult.Builder clearGoldenResult()

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.Builder

clearGoldenRunMethod()

public EvaluationResult.Builder clearGoldenRunMethod()

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
EvaluationResult.Builder

This builder for chaining.

clearInitiatedBy()

public EvaluationResult.Builder clearInitiatedBy()

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
EvaluationResult.Builder

This builder for chaining.

clearName()

public EvaluationResult.Builder clearName()

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
EvaluationResult.Builder

This builder for chaining.

clearPersona()

public EvaluationResult.Builder clearPersona()

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
EvaluationResult.Builder

clearResult()

public EvaluationResult.Builder clearResult()
Returns
Type Description
EvaluationResult.Builder

clearScenarioResult()

public EvaluationResult.Builder clearScenarioResult()

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.Builder

getAppVersion()

public 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 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 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 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 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 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 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.

getChangelogCreateTimeBuilder()

public Timestamp.Builder getChangelogCreateTimeBuilder()

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
Builder

getChangelogCreateTimeOrBuilder()

public 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 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.

getConfigBuilder()

public EvaluationConfig.Builder getConfigBuilder()

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.Builder

getConfigOrBuilder()

public 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 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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp when the evaluation result was created.

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public 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

getDefaultInstanceForType()

public EvaluationResult getDefaultInstanceForType()
Returns
Type Description
EvaluationResult

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public 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 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 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.

getErrorBuilder() (deprecated)

public Status.Builder getErrorBuilder()

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.Builder

getErrorInfo()

public 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.

getErrorInfoBuilder()

public EvaluationErrorInfo.Builder getErrorInfoBuilder()

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.Builder

getErrorInfoOrBuilder()

public 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 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 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.

getEvaluationMetricsThresholdsBuilder()

public EvaluationMetricsThresholds.Builder getEvaluationMetricsThresholdsBuilder()

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.Builder

getEvaluationMetricsThresholdsOrBuilder()

public 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 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 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 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 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 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 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 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.

getGoldenResultBuilder()

public EvaluationResult.GoldenResult.Builder getGoldenResultBuilder()

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.Builder

getGoldenResultOrBuilder()

public 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 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 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 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 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 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 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 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.

getPersonaBuilder()

public EvaluationPersona.Builder getPersonaBuilder()

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.Builder

getPersonaOrBuilder()

public 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 EvaluationResult.ResultCase getResultCase()
Returns
Type Description
EvaluationResult.ResultCase

getScenarioResult()

public 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.

getScenarioResultBuilder()

public EvaluationResult.ScenarioResult.Builder getScenarioResultBuilder()

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.Builder

getScenarioResultOrBuilder()

public 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 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 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 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 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 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 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 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeChangelogCreateTime(Timestamp value)

public EvaluationResult.Builder mergeChangelogCreateTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
EvaluationResult.Builder

mergeConfig(EvaluationConfig value)

public EvaluationResult.Builder mergeConfig(EvaluationConfig value)

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];

Parameter
Name Description
value EvaluationConfig
Returns
Type Description
EvaluationResult.Builder

mergeCreateTime(Timestamp value)

public EvaluationResult.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp when the evaluation result was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
EvaluationResult.Builder

mergeError(Status value) (deprecated)

public EvaluationResult.Builder mergeError(Status value)

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

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

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
EvaluationResult.Builder

mergeErrorInfo(EvaluationErrorInfo value)

public EvaluationResult.Builder mergeErrorInfo(EvaluationErrorInfo value)

Output only. Error information for the evaluation result.

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

Parameter
Name Description
value EvaluationErrorInfo
Returns
Type Description
EvaluationResult.Builder

mergeEvaluationMetricsThresholds(EvaluationMetricsThresholds value)

public EvaluationResult.Builder mergeEvaluationMetricsThresholds(EvaluationMetricsThresholds value)

Output only. The evaluation thresholds for the result.

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

Parameter
Name Description
value EvaluationMetricsThresholds
Returns
Type Description
EvaluationResult.Builder

mergeFrom(EvaluationResult other)

public EvaluationResult.Builder mergeFrom(EvaluationResult other)
Parameter
Name Description
other EvaluationResult
Returns
Type Description
EvaluationResult.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public EvaluationResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EvaluationResult.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public EvaluationResult.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
EvaluationResult.Builder
Overrides

mergeGoldenResult(EvaluationResult.GoldenResult value)

public EvaluationResult.Builder mergeGoldenResult(EvaluationResult.GoldenResult value)

Output only. The outcome of a golden evaluation.

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

Parameter
Name Description
value EvaluationResult.GoldenResult
Returns
Type Description
EvaluationResult.Builder

mergePersona(EvaluationPersona value)

public EvaluationResult.Builder mergePersona(EvaluationPersona value)

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];

Parameter
Name Description
value EvaluationPersona
Returns
Type Description
EvaluationResult.Builder

mergeScenarioResult(EvaluationResult.ScenarioResult value)

public EvaluationResult.Builder mergeScenarioResult(EvaluationResult.ScenarioResult value)

Output only. The outcome of a scenario evaluation.

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

Parameter
Name Description
value EvaluationResult.ScenarioResult
Returns
Type Description
EvaluationResult.Builder

setAppVersion(String value)

public EvaluationResult.Builder setAppVersion(String value)

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) = { ... }

Parameter
Name Description
value String

The appVersion to set.

Returns
Type Description
EvaluationResult.Builder

This builder for chaining.

setAppVersionBytes(ByteString value)

public EvaluationResult.Builder setAppVersionBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for appVersion to set.

Returns
Type Description
EvaluationResult.Builder

This builder for chaining.

setAppVersionDisplayName(String value)

public EvaluationResult.Builder setAppVersionDisplayName(String value)

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];

Parameter
Name Description
value String

The appVersionDisplayName to set.

Returns
Type Description
EvaluationResult.Builder

This builder for chaining.

setAppVersionDisplayNameBytes(ByteString value)

public EvaluationResult.Builder setAppVersionDisplayNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for appVersionDisplayName to set.

Returns
Type Description
EvaluationResult.Builder

This builder for chaining.

setChangelog(String value)

public EvaluationResult.Builder setChangelog(String value)

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) = { ... }

Parameter
Name Description
value String

The changelog to set.

Returns
Type Description
EvaluationResult.Builder

This builder for chaining.

setChangelogBytes(ByteString value)

public EvaluationResult.Builder setChangelogBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for changelog to set.

Returns
Type Description
EvaluationResult.Builder

This builder for chaining.

setChangelogCreateTime(Timestamp value)

public EvaluationResult.Builder setChangelogCreateTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
EvaluationResult.Builder

setChangelogCreateTime(Timestamp.Builder builderForValue)

public EvaluationResult.Builder setChangelogCreateTime(Timestamp.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
EvaluationResult.Builder

setConfig(EvaluationConfig value)

public EvaluationResult.Builder setConfig(EvaluationConfig value)

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];

Parameter
Name Description
value EvaluationConfig
Returns
Type Description
EvaluationResult.Builder

setConfig(EvaluationConfig.Builder builderForValue)

public EvaluationResult.Builder setConfig(EvaluationConfig.Builder builderForValue)

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];

Parameter
Name Description
builderForValue EvaluationConfig.Builder
Returns
Type Description
EvaluationResult.Builder

setCreateTime(Timestamp value)

public EvaluationResult.Builder setCreateTime(Timestamp value)

Output only. Timestamp when the evaluation result was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
EvaluationResult.Builder

setCreateTime(Timestamp.Builder builderForValue)

public EvaluationResult.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when the evaluation result was created.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
EvaluationResult.Builder

setDisplayName(String value)

public EvaluationResult.Builder setDisplayName(String value)

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];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
EvaluationResult.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public EvaluationResult.Builder setDisplayNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
EvaluationResult.Builder

This builder for chaining.

setError(Status value) (deprecated)

public EvaluationResult.Builder setError(Status value)

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

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

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
EvaluationResult.Builder

setError(Status.Builder builderForValue) (deprecated)

public EvaluationResult.Builder setError(Status.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
EvaluationResult.Builder

setErrorInfo(EvaluationErrorInfo value)

public EvaluationResult.Builder setErrorInfo(EvaluationErrorInfo value)

Output only. Error information for the evaluation result.

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

Parameter
Name Description
value EvaluationErrorInfo
Returns
Type Description
EvaluationResult.Builder

setErrorInfo(EvaluationErrorInfo.Builder builderForValue)

public EvaluationResult.Builder setErrorInfo(EvaluationErrorInfo.Builder builderForValue)

Output only. Error information for the evaluation result.

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

Parameter
Name Description
builderForValue EvaluationErrorInfo.Builder
Returns
Type Description
EvaluationResult.Builder

setEvaluationMetricsThresholds(EvaluationMetricsThresholds value)

public EvaluationResult.Builder setEvaluationMetricsThresholds(EvaluationMetricsThresholds value)

Output only. The evaluation thresholds for the result.

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

Parameter
Name Description
value EvaluationMetricsThresholds
Returns
Type Description
EvaluationResult.Builder

setEvaluationMetricsThresholds(EvaluationMetricsThresholds.Builder builderForValue)

public EvaluationResult.Builder setEvaluationMetricsThresholds(EvaluationMetricsThresholds.Builder builderForValue)

Output only. The evaluation thresholds for the result.

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

Parameter
Name Description
builderForValue EvaluationMetricsThresholds.Builder
Returns
Type Description
EvaluationResult.Builder

setEvaluationRun(String value)

public EvaluationResult.Builder setEvaluationRun(String value)

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) = { ... }

Parameter
Name Description
value String

The evaluationRun to set.

Returns
Type Description
EvaluationResult.Builder

This builder for chaining.

setEvaluationRunBytes(ByteString value)

public EvaluationResult.Builder setEvaluationRunBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for evaluationRun to set.

Returns
Type Description
EvaluationResult.Builder

This builder for chaining.

setEvaluationStatus(EvaluationResult.Outcome value)

public EvaluationResult.Builder setEvaluationStatus(EvaluationResult.Outcome value)

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];

Parameter
Name Description
value EvaluationResult.Outcome

The evaluationStatus to set.

Returns
Type Description
EvaluationResult.Builder

This builder for chaining.

setEvaluationStatusValue(int value)

public EvaluationResult.Builder setEvaluationStatusValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for evaluationStatus to set.

Returns
Type Description
EvaluationResult.Builder

This builder for chaining.

setExecutionState(EvaluationResult.ExecutionState value)

public EvaluationResult.Builder setExecutionState(EvaluationResult.ExecutionState value)

Output only. The state of the evaluation result execution.

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

Parameter
Name Description
value EvaluationResult.ExecutionState

The executionState to set.

Returns
Type Description
EvaluationResult.Builder

This builder for chaining.

setExecutionStateValue(int value)

public EvaluationResult.Builder setExecutionStateValue(int value)

Output only. The state of the evaluation result execution.

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

Parameter
Name Description
value int

The enum numeric value on the wire for executionState to set.

Returns
Type Description
EvaluationResult.Builder

This builder for chaining.

setGoldenResult(EvaluationResult.GoldenResult value)

public EvaluationResult.Builder setGoldenResult(EvaluationResult.GoldenResult value)

Output only. The outcome of a golden evaluation.

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

Parameter
Name Description
value EvaluationResult.GoldenResult
Returns
Type Description
EvaluationResult.Builder

setGoldenResult(EvaluationResult.GoldenResult.Builder builderForValue)

public EvaluationResult.Builder setGoldenResult(EvaluationResult.GoldenResult.Builder builderForValue)

Output only. The outcome of a golden evaluation.

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

Parameter
Name Description
builderForValue EvaluationResult.GoldenResult.Builder
Returns
Type Description
EvaluationResult.Builder

setGoldenRunMethod(GoldenRunMethod value)

public EvaluationResult.Builder setGoldenRunMethod(GoldenRunMethod value)

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];

Parameter
Name Description
value GoldenRunMethod

The goldenRunMethod to set.

Returns
Type Description
EvaluationResult.Builder

This builder for chaining.

setGoldenRunMethodValue(int value)

public EvaluationResult.Builder setGoldenRunMethodValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for goldenRunMethod to set.

Returns
Type Description
EvaluationResult.Builder

This builder for chaining.

setInitiatedBy(String value)

public EvaluationResult.Builder setInitiatedBy(String value)

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

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

Parameter
Name Description
value String

The initiatedBy to set.

Returns
Type Description
EvaluationResult.Builder

This builder for chaining.

setInitiatedByBytes(ByteString value)

public EvaluationResult.Builder setInitiatedByBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for initiatedBy to set.

Returns
Type Description
EvaluationResult.Builder

This builder for chaining.

setName(String value)

public EvaluationResult.Builder setName(String value)

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];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
EvaluationResult.Builder

This builder for chaining.

setNameBytes(ByteString value)

public EvaluationResult.Builder setNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
EvaluationResult.Builder

This builder for chaining.

setPersona(EvaluationPersona value)

public EvaluationResult.Builder setPersona(EvaluationPersona value)

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];

Parameter
Name Description
value EvaluationPersona
Returns
Type Description
EvaluationResult.Builder

setPersona(EvaluationPersona.Builder builderForValue)

public EvaluationResult.Builder setPersona(EvaluationPersona.Builder builderForValue)

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];

Parameter
Name Description
builderForValue EvaluationPersona.Builder
Returns
Type Description
EvaluationResult.Builder

setScenarioResult(EvaluationResult.ScenarioResult value)

public EvaluationResult.Builder setScenarioResult(EvaluationResult.ScenarioResult value)

Output only. The outcome of a scenario evaluation.

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

Parameter
Name Description
value EvaluationResult.ScenarioResult
Returns
Type Description
EvaluationResult.Builder

setScenarioResult(EvaluationResult.ScenarioResult.Builder builderForValue)

public EvaluationResult.Builder setScenarioResult(EvaluationResult.ScenarioResult.Builder builderForValue)

Output only. The outcome of a scenario evaluation.

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

Parameter
Name Description
builderForValue EvaluationResult.ScenarioResult.Builder
Returns
Type Description
EvaluationResult.Builder