Class EvaluationRun.Builder (0.3.0)

public static final class EvaluationRun.Builder extends GeneratedMessage.Builder<EvaluationRun.Builder> implements EvaluationRunOrBuilder

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

Protobuf type google.cloud.ces.v1beta.EvaluationRun

Static Methods

getDescriptor()

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

Methods

addAllEvaluationResults(Iterable<String> values)

public EvaluationRun.Builder addAllEvaluationResults(Iterable<String> values)

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

repeated string evaluation_results = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The evaluationResults to add.

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

addAllEvaluations(Iterable<String> values)

public EvaluationRun.Builder addAllEvaluations(Iterable<String> values)

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}

repeated string evaluations = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The evaluations to add.

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

addAllPersonaRunConfigs(Iterable<? extends PersonaRunConfig> values)

public EvaluationRun.Builder addAllPersonaRunConfigs(Iterable<? extends PersonaRunConfig> values)

Output only. The configuration to use for the run per persona.

repeated .google.cloud.ces.v1beta.PersonaRunConfig persona_run_configs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<? extends com.google.cloud.ces.v1beta.PersonaRunConfig>
Returns
Type Description
EvaluationRun.Builder

addEvaluationResults(String value)

public EvaluationRun.Builder addEvaluationResults(String value)

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

repeated string evaluation_results = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The evaluationResults to add.

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

addEvaluationResultsBytes(ByteString value)

public EvaluationRun.Builder addEvaluationResultsBytes(ByteString value)

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

repeated string evaluation_results = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the evaluationResults to add.

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

addEvaluations(String value)

public EvaluationRun.Builder addEvaluations(String value)

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}

repeated string evaluations = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The evaluations to add.

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

addEvaluationsBytes(ByteString value)

public EvaluationRun.Builder addEvaluationsBytes(ByteString value)

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}

repeated string evaluations = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the evaluations to add.

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

addPersonaRunConfigs(PersonaRunConfig value)

public EvaluationRun.Builder addPersonaRunConfigs(PersonaRunConfig value)

Output only. The configuration to use for the run per persona.

repeated .google.cloud.ces.v1beta.PersonaRunConfig persona_run_configs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value PersonaRunConfig
Returns
Type Description
EvaluationRun.Builder

addPersonaRunConfigs(PersonaRunConfig.Builder builderForValue)

public EvaluationRun.Builder addPersonaRunConfigs(PersonaRunConfig.Builder builderForValue)

Output only. The configuration to use for the run per persona.

repeated .google.cloud.ces.v1beta.PersonaRunConfig persona_run_configs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue PersonaRunConfig.Builder
Returns
Type Description
EvaluationRun.Builder

addPersonaRunConfigs(int index, PersonaRunConfig value)

public EvaluationRun.Builder addPersonaRunConfigs(int index, PersonaRunConfig value)

Output only. The configuration to use for the run per persona.

repeated .google.cloud.ces.v1beta.PersonaRunConfig persona_run_configs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value PersonaRunConfig
Returns
Type Description
EvaluationRun.Builder

addPersonaRunConfigs(int index, PersonaRunConfig.Builder builderForValue)

public EvaluationRun.Builder addPersonaRunConfigs(int index, PersonaRunConfig.Builder builderForValue)

Output only. The configuration to use for the run per persona.

repeated .google.cloud.ces.v1beta.PersonaRunConfig persona_run_configs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue PersonaRunConfig.Builder
Returns
Type Description
EvaluationRun.Builder

addPersonaRunConfigsBuilder()

public PersonaRunConfig.Builder addPersonaRunConfigsBuilder()

Output only. The configuration to use for the run per persona.

repeated .google.cloud.ces.v1beta.PersonaRunConfig persona_run_configs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PersonaRunConfig.Builder

addPersonaRunConfigsBuilder(int index)

public PersonaRunConfig.Builder addPersonaRunConfigsBuilder(int index)

Output only. The configuration to use for the run per persona.

repeated .google.cloud.ces.v1beta.PersonaRunConfig persona_run_configs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
PersonaRunConfig.Builder

build()

public EvaluationRun build()
Returns
Type Description
EvaluationRun

buildPartial()

public EvaluationRun buildPartial()
Returns
Type Description
EvaluationRun

clear()

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

clearAppVersion()

public EvaluationRun.Builder clearAppVersion()

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

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

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

clearAppVersionDisplayName()

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

This builder for chaining.

clearChangelog()

public EvaluationRun.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 = 22 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

clearChangelogCreateTime()

public EvaluationRun.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 = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationRun.Builder

clearConfig()

public EvaluationRun.Builder clearConfig()

Output only. The configuration used in the run.

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

Returns
Type Description
EvaluationRun.Builder

clearCreateTime()

public EvaluationRun.Builder clearCreateTime()

Output only. Timestamp when the evaluation run was created.

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

Returns
Type Description
EvaluationRun.Builder

clearDisplayName()

public EvaluationRun.Builder clearDisplayName()

Optional. User-defined display name of the evaluation run. default: "<evaluation-dataset-display-name> run - <timestamp>".

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

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

clearError() (deprecated)

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

clearErrorInfo()

public EvaluationRun.Builder clearErrorInfo()

Output only. Error information for the evaluation run.

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

Returns
Type Description
EvaluationRun.Builder

clearEvaluationDataset()

public EvaluationRun.Builder clearEvaluationDataset()

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}

string evaluation_dataset = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

clearEvaluationResults()

public EvaluationRun.Builder clearEvaluationResults()

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

repeated string evaluation_results = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

clearEvaluationRunSummaries()

public EvaluationRun.Builder clearEvaluationRunSummaries()
Returns
Type Description
EvaluationRun.Builder

clearEvaluationType()

public EvaluationRun.Builder clearEvaluationType()

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

.google.cloud.ces.v1beta.EvaluationRun.EvaluationType evaluation_type = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

clearEvaluations()

public EvaluationRun.Builder clearEvaluations()

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}

repeated string evaluations = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

clearGoldenRunMethod()

public EvaluationRun.Builder clearGoldenRunMethod()

Output only. The method used to run the evaluation.

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

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

clearInitiatedBy()

public EvaluationRun.Builder clearInitiatedBy()

Output only. The user who initiated the evaluation run.

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

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

clearLatencyReport()

public EvaluationRun.Builder clearLatencyReport()

Output only. Latency report for the evaluation run.

.google.cloud.ces.v1beta.LatencyReport latency_report = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationRun.Builder

clearName()

public EvaluationRun.Builder clearName()

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

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

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

clearOptimizationConfig()

public EvaluationRun.Builder clearOptimizationConfig()

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

.google.cloud.ces.v1beta.OptimizationConfig optimization_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EvaluationRun.Builder

clearPersonaRunConfigs()

public EvaluationRun.Builder clearPersonaRunConfigs()

Output only. The configuration to use for the run per persona.

repeated .google.cloud.ces.v1beta.PersonaRunConfig persona_run_configs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationRun.Builder

clearProgress()

public EvaluationRun.Builder clearProgress()

Output only. The progress of the evaluation run.

.google.cloud.ces.v1beta.EvaluationRun.Progress progress = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationRun.Builder

clearRunCount()

public EvaluationRun.Builder clearRunCount()

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

int32 run_count = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

clearScheduledEvaluationRun()

public EvaluationRun.Builder clearScheduledEvaluationRun()

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}

string scheduled_evaluation_run = 20 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

clearState()

public EvaluationRun.Builder clearState()

Output only. The state of the evaluation run.

.google.cloud.ces.v1beta.EvaluationRun.EvaluationRunState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

containsEvaluationRunSummaries(String key)

public boolean containsEvaluationRunSummaries(String key)

Output only. Map of evaluation name to EvaluationRunSummary.

map<string, .google.cloud.ces.v1beta.EvaluationRun.EvaluationRunSummary> evaluation_run_summaries = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
key String
Returns
Type Description
boolean

getAppVersion()

public String getAppVersion()

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

string app_version = 6 [(.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 to evaluate. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}

string app_version = 6 [(.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 = 22 [(.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 = 22 [(.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 = 23 [(.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 = 23 [(.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 = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getConfig()

public EvaluationConfig getConfig()

Output only. The configuration used in the run.

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

Returns
Type Description
EvaluationConfig

The config.

getConfigBuilder()

public EvaluationConfig.Builder getConfigBuilder()

Output only. The configuration used in the run.

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

Returns
Type Description
EvaluationConfig.Builder

getConfigOrBuilder()

public EvaluationConfigOrBuilder getConfigOrBuilder()

Output only. The configuration used in the run.

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

Returns
Type Description
EvaluationConfigOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when the evaluation run was created.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp when the evaluation run was created.

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when the evaluation run was created.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public EvaluationRun getDefaultInstanceForType()
Returns
Type Description
EvaluationRun

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

Optional. User-defined display name of the evaluation run. default: "<evaluation-dataset-display-name> run - <timestamp>".

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. User-defined display name of the evaluation run. default: "<evaluation-dataset-display-name> run - <timestamp>".

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

Returns
Type Description
ByteString

The bytes for displayName.

getError() (deprecated)

public Status getError()

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

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

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

Returns
Type Description
EvaluationErrorInfo

The errorInfo.

getErrorInfoBuilder()

public EvaluationErrorInfo.Builder getErrorInfoBuilder()

Output only. Error information for the evaluation run.

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

Returns
Type Description
EvaluationErrorInfo.Builder

getErrorInfoOrBuilder()

public EvaluationErrorInfoOrBuilder getErrorInfoOrBuilder()

Output only. Error information for the evaluation run.

.google.cloud.ces.v1beta.EvaluationErrorInfo error_info = 17 [(.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

getEvaluationDataset()

public String getEvaluationDataset()

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}

string evaluation_dataset = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The evaluationDataset.

getEvaluationDatasetBytes()

public ByteString getEvaluationDatasetBytes()

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}

string evaluation_dataset = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for evaluationDataset.

getEvaluationResults(int index)

public String getEvaluationResults(int index)

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

repeated string evaluation_results = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The evaluationResults at the given index.

getEvaluationResultsBytes(int index)

public ByteString getEvaluationResultsBytes(int index)

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

repeated string evaluation_results = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the evaluationResults at the given index.

getEvaluationResultsCount()

public int getEvaluationResultsCount()

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

repeated string evaluation_results = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of evaluationResults.

getEvaluationResultsList()

public ProtocolStringList getEvaluationResultsList()

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

repeated string evaluation_results = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the evaluationResults.

getEvaluationRunSummaries() (deprecated)

public Map<String,EvaluationRun.EvaluationRunSummary> getEvaluationRunSummaries()
Returns
Type Description
Map<String,EvaluationRunSummary>

getEvaluationRunSummariesCount()

public int getEvaluationRunSummariesCount()

Output only. Map of evaluation name to EvaluationRunSummary.

map<string, .google.cloud.ces.v1beta.EvaluationRun.EvaluationRunSummary> evaluation_run_summaries = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getEvaluationRunSummariesMap()

public Map<String,EvaluationRun.EvaluationRunSummary> getEvaluationRunSummariesMap()

Output only. Map of evaluation name to EvaluationRunSummary.

map<string, .google.cloud.ces.v1beta.EvaluationRun.EvaluationRunSummary> evaluation_run_summaries = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Map<String,EvaluationRunSummary>

getEvaluationRunSummariesOrDefault(String key, EvaluationRun.EvaluationRunSummary defaultValue)

public EvaluationRun.EvaluationRunSummary getEvaluationRunSummariesOrDefault(String key, EvaluationRun.EvaluationRunSummary defaultValue)

Output only. Map of evaluation name to EvaluationRunSummary.

map<string, .google.cloud.ces.v1beta.EvaluationRun.EvaluationRunSummary> evaluation_run_summaries = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
key String
defaultValue EvaluationRun.EvaluationRunSummary
Returns
Type Description
EvaluationRun.EvaluationRunSummary

getEvaluationRunSummariesOrThrow(String key)

public EvaluationRun.EvaluationRunSummary getEvaluationRunSummariesOrThrow(String key)

Output only. Map of evaluation name to EvaluationRunSummary.

map<string, .google.cloud.ces.v1beta.EvaluationRun.EvaluationRunSummary> evaluation_run_summaries = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
key String
Returns
Type Description
EvaluationRun.EvaluationRunSummary

getEvaluationType()

public EvaluationRun.EvaluationType getEvaluationType()

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

.google.cloud.ces.v1beta.EvaluationRun.EvaluationType evaluation_type = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationRun.EvaluationType

The evaluationType.

getEvaluationTypeValue()

public int getEvaluationTypeValue()

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

.google.cloud.ces.v1beta.EvaluationRun.EvaluationType evaluation_type = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for evaluationType.

getEvaluations(int index)

public String getEvaluations(int index)

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}

repeated string evaluations = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The evaluations at the given index.

getEvaluationsBytes(int index)

public ByteString getEvaluationsBytes(int index)

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}

repeated string evaluations = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the evaluations at the given index.

getEvaluationsCount()

public int getEvaluationsCount()

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}

repeated string evaluations = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of evaluations.

getEvaluationsList()

public ProtocolStringList getEvaluationsList()

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}

repeated string evaluations = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the evaluations.

getGoldenRunMethod()

public GoldenRunMethod getGoldenRunMethod()

Output only. The method used to run the evaluation.

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

Returns
Type Description
GoldenRunMethod

The goldenRunMethod.

getGoldenRunMethodValue()

public int getGoldenRunMethodValue()

Output only. The method used to run the evaluation.

.google.cloud.ces.v1beta.GoldenRunMethod golden_run_method = 21 [(.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.

string initiated_by = 5 [(.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.

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

Returns
Type Description
ByteString

The bytes for initiatedBy.

getLatencyReport()

public LatencyReport getLatencyReport()

Output only. Latency report for the evaluation run.

.google.cloud.ces.v1beta.LatencyReport latency_report = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
LatencyReport

The latencyReport.

getLatencyReportBuilder()

public LatencyReport.Builder getLatencyReportBuilder()

Output only. Latency report for the evaluation run.

.google.cloud.ces.v1beta.LatencyReport latency_report = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
LatencyReport.Builder

getLatencyReportOrBuilder()

public LatencyReportOrBuilder getLatencyReportOrBuilder()

Output only. Latency report for the evaluation run.

.google.cloud.ces.v1beta.LatencyReport latency_report = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
LatencyReportOrBuilder

getMutableEvaluationRunSummaries() (deprecated)

public Map<String,EvaluationRun.EvaluationRunSummary> getMutableEvaluationRunSummaries()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,EvaluationRunSummary>

getName()

public String getName()

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

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 run. Format: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}

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

Returns
Type Description
ByteString

The bytes for name.

getOptimizationConfig()

public OptimizationConfig getOptimizationConfig()

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

.google.cloud.ces.v1beta.OptimizationConfig optimization_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
OptimizationConfig

The optimizationConfig.

getOptimizationConfigBuilder()

public OptimizationConfig.Builder getOptimizationConfigBuilder()

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

.google.cloud.ces.v1beta.OptimizationConfig optimization_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
OptimizationConfig.Builder

getOptimizationConfigOrBuilder()

public OptimizationConfigOrBuilder getOptimizationConfigOrBuilder()

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

.google.cloud.ces.v1beta.OptimizationConfig optimization_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
OptimizationConfigOrBuilder

getPersonaRunConfigs(int index)

public PersonaRunConfig getPersonaRunConfigs(int index)

Output only. The configuration to use for the run per persona.

repeated .google.cloud.ces.v1beta.PersonaRunConfig persona_run_configs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
PersonaRunConfig

getPersonaRunConfigsBuilder(int index)

public PersonaRunConfig.Builder getPersonaRunConfigsBuilder(int index)

Output only. The configuration to use for the run per persona.

repeated .google.cloud.ces.v1beta.PersonaRunConfig persona_run_configs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
PersonaRunConfig.Builder

getPersonaRunConfigsBuilderList()

public List<PersonaRunConfig.Builder> getPersonaRunConfigsBuilderList()

Output only. The configuration to use for the run per persona.

repeated .google.cloud.ces.v1beta.PersonaRunConfig persona_run_configs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Builder>

getPersonaRunConfigsCount()

public int getPersonaRunConfigsCount()

Output only. The configuration to use for the run per persona.

repeated .google.cloud.ces.v1beta.PersonaRunConfig persona_run_configs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getPersonaRunConfigsList()

public List<PersonaRunConfig> getPersonaRunConfigsList()

Output only. The configuration to use for the run per persona.

repeated .google.cloud.ces.v1beta.PersonaRunConfig persona_run_configs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<PersonaRunConfig>

getPersonaRunConfigsOrBuilder(int index)

public PersonaRunConfigOrBuilder getPersonaRunConfigsOrBuilder(int index)

Output only. The configuration to use for the run per persona.

repeated .google.cloud.ces.v1beta.PersonaRunConfig persona_run_configs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
PersonaRunConfigOrBuilder

getPersonaRunConfigsOrBuilderList()

public List<? extends PersonaRunConfigOrBuilder> getPersonaRunConfigsOrBuilderList()

Output only. The configuration to use for the run per persona.

repeated .google.cloud.ces.v1beta.PersonaRunConfig persona_run_configs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.ces.v1beta.PersonaRunConfigOrBuilder>

getProgress()

public EvaluationRun.Progress getProgress()

Output only. The progress of the evaluation run.

.google.cloud.ces.v1beta.EvaluationRun.Progress progress = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationRun.Progress

The progress.

getProgressBuilder()

public EvaluationRun.Progress.Builder getProgressBuilder()

Output only. The progress of the evaluation run.

.google.cloud.ces.v1beta.EvaluationRun.Progress progress = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationRun.Progress.Builder

getProgressOrBuilder()

public EvaluationRun.ProgressOrBuilder getProgressOrBuilder()

Output only. The progress of the evaluation run.

.google.cloud.ces.v1beta.EvaluationRun.Progress progress = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationRun.ProgressOrBuilder

getRunCount()

public int getRunCount()

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

int32 run_count = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The runCount.

getScheduledEvaluationRun()

public String getScheduledEvaluationRun()

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}

string scheduled_evaluation_run = 20 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The scheduledEvaluationRun.

getScheduledEvaluationRunBytes()

public ByteString getScheduledEvaluationRunBytes()

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}

string scheduled_evaluation_run = 20 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for scheduledEvaluationRun.

getState()

public EvaluationRun.EvaluationRunState getState()

Output only. The state of the evaluation run.

.google.cloud.ces.v1beta.EvaluationRun.EvaluationRunState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationRun.EvaluationRunState

The state.

getStateValue()

public int getStateValue()

Output only. The state of the evaluation run.

.google.cloud.ces.v1beta.EvaluationRun.EvaluationRunState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

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 = 23 [(.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 run.

.google.cloud.ces.v1beta.EvaluationConfig config = 12 [(.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 run was created.

.google.protobuf.Timestamp create_time = 4 [(.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.EvaluationRun.error is deprecated. See google/cloud/ces/v1beta/evaluation.proto;l=1206

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

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

Returns
Type Description
boolean

Whether the errorInfo field is set.

hasLatencyReport()

public boolean hasLatencyReport()

Output only. Latency report for the evaluation run.

.google.cloud.ces.v1beta.LatencyReport latency_report = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the latencyReport field is set.

hasOptimizationConfig()

public boolean hasOptimizationConfig()

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

.google.cloud.ces.v1beta.OptimizationConfig optimization_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the optimizationConfig field is set.

hasProgress()

public boolean hasProgress()

Output only. The progress of the evaluation run.

.google.cloud.ces.v1beta.EvaluationRun.Progress progress = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the progress field is set.

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeChangelogCreateTime(Timestamp value)

public EvaluationRun.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 = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
EvaluationRun.Builder

mergeConfig(EvaluationConfig value)

public EvaluationRun.Builder mergeConfig(EvaluationConfig value)

Output only. The configuration used in the run.

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

Parameter
Name Description
value EvaluationConfig
Returns
Type Description
EvaluationRun.Builder

mergeCreateTime(Timestamp value)

public EvaluationRun.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp when the evaluation run was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
EvaluationRun.Builder

mergeError(Status value) (deprecated)

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

mergeErrorInfo(EvaluationErrorInfo value)

public EvaluationRun.Builder mergeErrorInfo(EvaluationErrorInfo value)

Output only. Error information for the evaluation run.

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

Parameter
Name Description
value EvaluationErrorInfo
Returns
Type Description
EvaluationRun.Builder

mergeFrom(EvaluationRun other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeLatencyReport(LatencyReport value)

public EvaluationRun.Builder mergeLatencyReport(LatencyReport value)

Output only. Latency report for the evaluation run.

.google.cloud.ces.v1beta.LatencyReport latency_report = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value LatencyReport
Returns
Type Description
EvaluationRun.Builder

mergeOptimizationConfig(OptimizationConfig value)

public EvaluationRun.Builder mergeOptimizationConfig(OptimizationConfig value)

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

.google.cloud.ces.v1beta.OptimizationConfig optimization_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value OptimizationConfig
Returns
Type Description
EvaluationRun.Builder

mergeProgress(EvaluationRun.Progress value)

public EvaluationRun.Builder mergeProgress(EvaluationRun.Progress value)

Output only. The progress of the evaluation run.

.google.cloud.ces.v1beta.EvaluationRun.Progress progress = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value EvaluationRun.Progress
Returns
Type Description
EvaluationRun.Builder

putAllEvaluationRunSummaries(Map<String,EvaluationRun.EvaluationRunSummary> values)

public EvaluationRun.Builder putAllEvaluationRunSummaries(Map<String,EvaluationRun.EvaluationRunSummary> values)

Output only. Map of evaluation name to EvaluationRunSummary.

map<string, .google.cloud.ces.v1beta.EvaluationRun.EvaluationRunSummary> evaluation_run_summaries = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Map<String,EvaluationRunSummary>
Returns
Type Description
EvaluationRun.Builder

putEvaluationRunSummaries(String key, EvaluationRun.EvaluationRunSummary value)

public EvaluationRun.Builder putEvaluationRunSummaries(String key, EvaluationRun.EvaluationRunSummary value)

Output only. Map of evaluation name to EvaluationRunSummary.

map<string, .google.cloud.ces.v1beta.EvaluationRun.EvaluationRunSummary> evaluation_run_summaries = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
key String
value EvaluationRun.EvaluationRunSummary
Returns
Type Description
EvaluationRun.Builder

putEvaluationRunSummariesBuilderIfAbsent(String key)

public EvaluationRun.EvaluationRunSummary.Builder putEvaluationRunSummariesBuilderIfAbsent(String key)

Output only. Map of evaluation name to EvaluationRunSummary.

map<string, .google.cloud.ces.v1beta.EvaluationRun.EvaluationRunSummary> evaluation_run_summaries = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
key String
Returns
Type Description
EvaluationRun.EvaluationRunSummary.Builder

removeEvaluationRunSummaries(String key)

public EvaluationRun.Builder removeEvaluationRunSummaries(String key)

Output only. Map of evaluation name to EvaluationRunSummary.

map<string, .google.cloud.ces.v1beta.EvaluationRun.EvaluationRunSummary> evaluation_run_summaries = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
key String
Returns
Type Description
EvaluationRun.Builder

removePersonaRunConfigs(int index)

public EvaluationRun.Builder removePersonaRunConfigs(int index)

Output only. The configuration to use for the run per persona.

repeated .google.cloud.ces.v1beta.PersonaRunConfig persona_run_configs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
EvaluationRun.Builder

setAppVersion(String value)

public EvaluationRun.Builder setAppVersion(String value)

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

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

Parameter
Name Description
value String

The appVersion to set.

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

setAppVersionBytes(ByteString value)

public EvaluationRun.Builder setAppVersionBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for appVersion to set.

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

setAppVersionDisplayName(String value)

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

This builder for chaining.

setAppVersionDisplayNameBytes(ByteString value)

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

This builder for chaining.

setChangelog(String value)

public EvaluationRun.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 = 22 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The changelog to set.

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

setChangelogBytes(ByteString value)

public EvaluationRun.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 = 22 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for changelog to set.

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

setChangelogCreateTime(Timestamp value)

public EvaluationRun.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 = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
EvaluationRun.Builder

setChangelogCreateTime(Timestamp.Builder builderForValue)

public EvaluationRun.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 = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
EvaluationRun.Builder

setConfig(EvaluationConfig value)

public EvaluationRun.Builder setConfig(EvaluationConfig value)

Output only. The configuration used in the run.

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

Parameter
Name Description
value EvaluationConfig
Returns
Type Description
EvaluationRun.Builder

setConfig(EvaluationConfig.Builder builderForValue)

public EvaluationRun.Builder setConfig(EvaluationConfig.Builder builderForValue)

Output only. The configuration used in the run.

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

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

setCreateTime(Timestamp value)

public EvaluationRun.Builder setCreateTime(Timestamp value)

Output only. Timestamp when the evaluation run was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
EvaluationRun.Builder

setCreateTime(Timestamp.Builder builderForValue)

public EvaluationRun.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when the evaluation run was created.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
EvaluationRun.Builder

setDisplayName(String value)

public EvaluationRun.Builder setDisplayName(String value)

Optional. User-defined display name of the evaluation run. default: "<evaluation-dataset-display-name> run - <timestamp>".

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

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public EvaluationRun.Builder setDisplayNameBytes(ByteString value)

Optional. User-defined display name of the evaluation run. default: "<evaluation-dataset-display-name> run - <timestamp>".

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

setError(Status value) (deprecated)

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

setError(Status.Builder builderForValue) (deprecated)

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

setErrorInfo(EvaluationErrorInfo value)

public EvaluationRun.Builder setErrorInfo(EvaluationErrorInfo value)

Output only. Error information for the evaluation run.

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

Parameter
Name Description
value EvaluationErrorInfo
Returns
Type Description
EvaluationRun.Builder

setErrorInfo(EvaluationErrorInfo.Builder builderForValue)

public EvaluationRun.Builder setErrorInfo(EvaluationErrorInfo.Builder builderForValue)

Output only. Error information for the evaluation run.

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

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

setEvaluationDataset(String value)

public EvaluationRun.Builder setEvaluationDataset(String value)

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}

string evaluation_dataset = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The evaluationDataset to set.

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

setEvaluationDatasetBytes(ByteString value)

public EvaluationRun.Builder setEvaluationDatasetBytes(ByteString value)

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}

string evaluation_dataset = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for evaluationDataset to set.

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

setEvaluationResults(int index, String value)

public EvaluationRun.Builder setEvaluationResults(int index, String value)

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

repeated string evaluation_results = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The evaluationResults to set.

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

setEvaluationType(EvaluationRun.EvaluationType value)

public EvaluationRun.Builder setEvaluationType(EvaluationRun.EvaluationType value)

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

.google.cloud.ces.v1beta.EvaluationRun.EvaluationType evaluation_type = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value EvaluationRun.EvaluationType

The evaluationType to set.

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

setEvaluationTypeValue(int value)

public EvaluationRun.Builder setEvaluationTypeValue(int value)

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

.google.cloud.ces.v1beta.EvaluationRun.EvaluationType evaluation_type = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

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

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

setEvaluations(int index, String value)

public EvaluationRun.Builder setEvaluations(int index, String value)

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}

repeated string evaluations = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The evaluations to set.

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

setGoldenRunMethod(GoldenRunMethod value)

public EvaluationRun.Builder setGoldenRunMethod(GoldenRunMethod value)

Output only. The method used to run the evaluation.

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

Parameter
Name Description
value GoldenRunMethod

The goldenRunMethod to set.

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

setGoldenRunMethodValue(int value)

public EvaluationRun.Builder setGoldenRunMethodValue(int value)

Output only. The method used to run the evaluation.

.google.cloud.ces.v1beta.GoldenRunMethod golden_run_method = 21 [(.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
EvaluationRun.Builder

This builder for chaining.

setInitiatedBy(String value)

public EvaluationRun.Builder setInitiatedBy(String value)

Output only. The user who initiated the evaluation run.

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

Parameter
Name Description
value String

The initiatedBy to set.

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

setInitiatedByBytes(ByteString value)

public EvaluationRun.Builder setInitiatedByBytes(ByteString value)

Output only. The user who initiated the evaluation run.

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

Parameter
Name Description
value ByteString

The bytes for initiatedBy to set.

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

setLatencyReport(LatencyReport value)

public EvaluationRun.Builder setLatencyReport(LatencyReport value)

Output only. Latency report for the evaluation run.

.google.cloud.ces.v1beta.LatencyReport latency_report = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value LatencyReport
Returns
Type Description
EvaluationRun.Builder

setLatencyReport(LatencyReport.Builder builderForValue)

public EvaluationRun.Builder setLatencyReport(LatencyReport.Builder builderForValue)

Output only. Latency report for the evaluation run.

.google.cloud.ces.v1beta.LatencyReport latency_report = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue LatencyReport.Builder
Returns
Type Description
EvaluationRun.Builder

setName(String value)

public EvaluationRun.Builder setName(String value)

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

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

setNameBytes(ByteString value)

public EvaluationRun.Builder setNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

setOptimizationConfig(OptimizationConfig value)

public EvaluationRun.Builder setOptimizationConfig(OptimizationConfig value)

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

.google.cloud.ces.v1beta.OptimizationConfig optimization_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value OptimizationConfig
Returns
Type Description
EvaluationRun.Builder

setOptimizationConfig(OptimizationConfig.Builder builderForValue)

public EvaluationRun.Builder setOptimizationConfig(OptimizationConfig.Builder builderForValue)

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

.google.cloud.ces.v1beta.OptimizationConfig optimization_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue OptimizationConfig.Builder
Returns
Type Description
EvaluationRun.Builder

setPersonaRunConfigs(int index, PersonaRunConfig value)

public EvaluationRun.Builder setPersonaRunConfigs(int index, PersonaRunConfig value)

Output only. The configuration to use for the run per persona.

repeated .google.cloud.ces.v1beta.PersonaRunConfig persona_run_configs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value PersonaRunConfig
Returns
Type Description
EvaluationRun.Builder

setPersonaRunConfigs(int index, PersonaRunConfig.Builder builderForValue)

public EvaluationRun.Builder setPersonaRunConfigs(int index, PersonaRunConfig.Builder builderForValue)

Output only. The configuration to use for the run per persona.

repeated .google.cloud.ces.v1beta.PersonaRunConfig persona_run_configs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue PersonaRunConfig.Builder
Returns
Type Description
EvaluationRun.Builder

setProgress(EvaluationRun.Progress value)

public EvaluationRun.Builder setProgress(EvaluationRun.Progress value)

Output only. The progress of the evaluation run.

.google.cloud.ces.v1beta.EvaluationRun.Progress progress = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value EvaluationRun.Progress
Returns
Type Description
EvaluationRun.Builder

setProgress(EvaluationRun.Progress.Builder builderForValue)

public EvaluationRun.Builder setProgress(EvaluationRun.Progress.Builder builderForValue)

Output only. The progress of the evaluation run.

.google.cloud.ces.v1beta.EvaluationRun.Progress progress = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue EvaluationRun.Progress.Builder
Returns
Type Description
EvaluationRun.Builder

setRunCount(int value)

public EvaluationRun.Builder setRunCount(int value)

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

int32 run_count = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The runCount to set.

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

setScheduledEvaluationRun(String value)

public EvaluationRun.Builder setScheduledEvaluationRun(String value)

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}

string scheduled_evaluation_run = 20 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The scheduledEvaluationRun to set.

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

setScheduledEvaluationRunBytes(ByteString value)

public EvaluationRun.Builder setScheduledEvaluationRunBytes(ByteString value)

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}

string scheduled_evaluation_run = 20 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for scheduledEvaluationRun to set.

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

setState(EvaluationRun.EvaluationRunState value)

public EvaluationRun.Builder setState(EvaluationRun.EvaluationRunState value)

Output only. The state of the evaluation run.

.google.cloud.ces.v1beta.EvaluationRun.EvaluationRunState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value EvaluationRun.EvaluationRunState

The state to set.

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.

setStateValue(int value)

public EvaluationRun.Builder setStateValue(int value)

Output only. The state of the evaluation run.

.google.cloud.ces.v1beta.EvaluationRun.EvaluationRunState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

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

Returns
Type Description
EvaluationRun.Builder

This builder for chaining.