Class Evaluation.Builder (0.3.0)

public static final class Evaluation.Builder extends GeneratedMessage.Builder<Evaluation.Builder> implements EvaluationOrBuilder

An evaluation represents all of the information needed to simulate and evaluate an agent.

Protobuf type google.cloud.ces.v1beta.Evaluation

Implements

EvaluationOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllEvaluationDatasets(Iterable<String> values)

public Evaluation.Builder addAllEvaluationDatasets(Iterable<String> values)

Output only. List of evaluation datasets the evaluation belongs to. Format: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}

repeated string evaluation_datasets = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The evaluationDatasets to add.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

addAllEvaluationRuns(Iterable<String> values)

public Evaluation.Builder addAllEvaluationRuns(Iterable<String> values)

Output only. The EvaluationRuns that this Evaluation is associated with.

repeated string evaluation_runs = 15 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The evaluationRuns to add.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

addAllLastTenResults(Iterable<? extends EvaluationResult> values)

public Evaluation.Builder addAllLastTenResults(Iterable<? extends EvaluationResult> values)

Output only. The last 10 evaluation results for this evaluation. This is only populated if include_last_ten_results is set to true in the ListEvaluationsRequest or GetEvaluationRequest.

repeated .google.cloud.ces.v1beta.EvaluationResult last_ten_results = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

addAllTags(Iterable<String> values)

public Evaluation.Builder addAllTags(Iterable<String> values)

Optional. User defined tags to categorize the evaluation.

repeated string tags = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<String>

The tags to add.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

addEvaluationDatasets(String value)

public Evaluation.Builder addEvaluationDatasets(String value)

Output only. List of evaluation datasets the evaluation belongs to. Format: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}

repeated string evaluation_datasets = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The evaluationDatasets to add.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

addEvaluationDatasetsBytes(ByteString value)

public Evaluation.Builder addEvaluationDatasetsBytes(ByteString value)

Output only. List of evaluation datasets the evaluation belongs to. Format: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}

repeated string evaluation_datasets = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the evaluationDatasets to add.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

addEvaluationRuns(String value)

public Evaluation.Builder addEvaluationRuns(String value)

Output only. The EvaluationRuns that this Evaluation is associated with.

repeated string evaluation_runs = 15 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The evaluationRuns to add.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

addEvaluationRunsBytes(ByteString value)

public Evaluation.Builder addEvaluationRunsBytes(ByteString value)

Output only. The EvaluationRuns that this Evaluation is associated with.

repeated string evaluation_runs = 15 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the evaluationRuns to add.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

addLastTenResults(EvaluationResult value)

public Evaluation.Builder addLastTenResults(EvaluationResult value)

Output only. The last 10 evaluation results for this evaluation. This is only populated if include_last_ten_results is set to true in the ListEvaluationsRequest or GetEvaluationRequest.

repeated .google.cloud.ces.v1beta.EvaluationResult last_ten_results = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value EvaluationResult
Returns
Type Description
Evaluation.Builder

addLastTenResults(EvaluationResult.Builder builderForValue)

public Evaluation.Builder addLastTenResults(EvaluationResult.Builder builderForValue)

Output only. The last 10 evaluation results for this evaluation. This is only populated if include_last_ten_results is set to true in the ListEvaluationsRequest or GetEvaluationRequest.

repeated .google.cloud.ces.v1beta.EvaluationResult last_ten_results = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

addLastTenResults(int index, EvaluationResult value)

public Evaluation.Builder addLastTenResults(int index, EvaluationResult value)

Output only. The last 10 evaluation results for this evaluation. This is only populated if include_last_ten_results is set to true in the ListEvaluationsRequest or GetEvaluationRequest.

repeated .google.cloud.ces.v1beta.EvaluationResult last_ten_results = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value EvaluationResult
Returns
Type Description
Evaluation.Builder

addLastTenResults(int index, EvaluationResult.Builder builderForValue)

public Evaluation.Builder addLastTenResults(int index, EvaluationResult.Builder builderForValue)

Output only. The last 10 evaluation results for this evaluation. This is only populated if include_last_ten_results is set to true in the ListEvaluationsRequest or GetEvaluationRequest.

repeated .google.cloud.ces.v1beta.EvaluationResult last_ten_results = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue EvaluationResult.Builder
Returns
Type Description
Evaluation.Builder

addLastTenResultsBuilder()

public EvaluationResult.Builder addLastTenResultsBuilder()

Output only. The last 10 evaluation results for this evaluation. This is only populated if include_last_ten_results is set to true in the ListEvaluationsRequest or GetEvaluationRequest.

repeated .google.cloud.ces.v1beta.EvaluationResult last_ten_results = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationResult.Builder

addLastTenResultsBuilder(int index)

public EvaluationResult.Builder addLastTenResultsBuilder(int index)

Output only. The last 10 evaluation results for this evaluation. This is only populated if include_last_ten_results is set to true in the ListEvaluationsRequest or GetEvaluationRequest.

repeated .google.cloud.ces.v1beta.EvaluationResult last_ten_results = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
EvaluationResult.Builder

addTags(String value)

public Evaluation.Builder addTags(String value)

Optional. User defined tags to categorize the evaluation.

repeated string tags = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The tags to add.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

addTagsBytes(ByteString value)

public Evaluation.Builder addTagsBytes(ByteString value)

Optional. User defined tags to categorize the evaluation.

repeated string tags = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes of the tags to add.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

build()

public Evaluation build()
Returns
Type Description
Evaluation

buildPartial()

public Evaluation buildPartial()
Returns
Type Description
Evaluation

clear()

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

clearAggregatedMetrics()

public Evaluation.Builder clearAggregatedMetrics()

Output only. The aggregated metrics for this evaluation across all runs.

.google.cloud.ces.v1beta.AggregatedMetrics aggregated_metrics = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Evaluation.Builder

clearCreateTime()

public Evaluation.Builder clearCreateTime()

Output only. Timestamp when the evaluation was created.

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

Returns
Type Description
Evaluation.Builder

clearCreatedBy()

public Evaluation.Builder clearCreatedBy()

Output only. The user who created the evaluation.

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

Returns
Type Description
Evaluation.Builder

This builder for chaining.

clearDescription()

public Evaluation.Builder clearDescription()

Optional. User-defined description of the evaluation.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Evaluation.Builder

This builder for chaining.

clearDisplayName()

public Evaluation.Builder clearDisplayName()

Required. User-defined display name of the evaluation. Unique within an App.

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

Returns
Type Description
Evaluation.Builder

This builder for chaining.

clearEtag()

public Evaluation.Builder clearEtag()

Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

string etag = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Evaluation.Builder

This builder for chaining.

clearEvaluationDatasets()

public Evaluation.Builder clearEvaluationDatasets()

Output only. List of evaluation datasets the evaluation belongs to. Format: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}

repeated string evaluation_datasets = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
Evaluation.Builder

This builder for chaining.

clearEvaluationRuns()

public Evaluation.Builder clearEvaluationRuns()

Output only. The EvaluationRuns that this Evaluation is associated with.

repeated string evaluation_runs = 15 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
Evaluation.Builder

This builder for chaining.

clearGolden()

public Evaluation.Builder clearGolden()

Optional. The golden steps to be evaluated.

.google.cloud.ces.v1beta.Evaluation.Golden golden = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Evaluation.Builder

clearInputs()

public Evaluation.Builder clearInputs()
Returns
Type Description
Evaluation.Builder

clearInvalid()

public Evaluation.Builder clearInvalid()

Output only. Whether the evaluation is invalid. This can happen if an evaluation is referencing a tool, toolset, or agent that has since been deleted.

bool invalid = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Evaluation.Builder

This builder for chaining.

clearLastCompletedResult()

public Evaluation.Builder clearLastCompletedResult()

Output only. The latest evaluation result for this evaluation.

.google.cloud.ces.v1beta.EvaluationResult last_completed_result = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Evaluation.Builder

clearLastTenResults()

public Evaluation.Builder clearLastTenResults()

Output only. The last 10 evaluation results for this evaluation. This is only populated if include_last_ten_results is set to true in the ListEvaluationsRequest or GetEvaluationRequest.

repeated .google.cloud.ces.v1beta.EvaluationResult last_ten_results = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Evaluation.Builder

clearLastUpdatedBy()

public Evaluation.Builder clearLastUpdatedBy()

Output only. The user who last updated the evaluation.

string last_updated_by = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Evaluation.Builder

This builder for chaining.

clearName()

public Evaluation.Builder clearName()

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

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

Returns
Type Description
Evaluation.Builder

This builder for chaining.

clearScenario()

public Evaluation.Builder clearScenario()

Optional. The config for a scenario.

.google.cloud.ces.v1beta.Evaluation.Scenario scenario = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Evaluation.Builder

clearTags()

public Evaluation.Builder clearTags()

Optional. User defined tags to categorize the evaluation.

repeated string tags = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Evaluation.Builder

This builder for chaining.

clearUpdateTime()

public Evaluation.Builder clearUpdateTime()

Output only. Timestamp when the evaluation was last updated.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Evaluation.Builder

getAggregatedMetrics()

public AggregatedMetrics getAggregatedMetrics()

Output only. The aggregated metrics for this evaluation across all runs.

.google.cloud.ces.v1beta.AggregatedMetrics aggregated_metrics = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AggregatedMetrics

The aggregatedMetrics.

getAggregatedMetricsBuilder()

public AggregatedMetrics.Builder getAggregatedMetricsBuilder()

Output only. The aggregated metrics for this evaluation across all runs.

.google.cloud.ces.v1beta.AggregatedMetrics aggregated_metrics = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AggregatedMetrics.Builder

getAggregatedMetricsOrBuilder()

public AggregatedMetricsOrBuilder getAggregatedMetricsOrBuilder()

Output only. The aggregated metrics for this evaluation across all runs.

.google.cloud.ces.v1beta.AggregatedMetrics aggregated_metrics = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AggregatedMetricsOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when the evaluation was created.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp when the evaluation was created.

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when the evaluation was created.

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

Returns
Type Description
TimestampOrBuilder

getCreatedBy()

public String getCreatedBy()

Output only. The user who created the evaluation.

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

Returns
Type Description
String

The createdBy.

getCreatedByBytes()

public ByteString getCreatedByBytes()

Output only. The user who created the evaluation.

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

Returns
Type Description
ByteString

The bytes for createdBy.

getDefaultInstanceForType()

public Evaluation getDefaultInstanceForType()
Returns
Type Description
Evaluation

getDescription()

public String getDescription()

Optional. User-defined description of the evaluation.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. User-defined description of the evaluation.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

Required. User-defined display name of the evaluation. Unique within an App.

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. User-defined display name of the evaluation. Unique within an App.

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

Returns
Type Description
ByteString

The bytes for displayName.

getEtag()

public String getEtag()

Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

string etag = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

string etag = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for etag.

getEvaluationDatasets(int index)

public String getEvaluationDatasets(int index)

Output only. List of evaluation datasets the evaluation belongs to. Format: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}

repeated string evaluation_datasets = 5 [(.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 evaluationDatasets at the given index.

getEvaluationDatasetsBytes(int index)

public ByteString getEvaluationDatasetsBytes(int index)

Output only. List of evaluation datasets the evaluation belongs to. Format: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}

repeated string evaluation_datasets = 5 [(.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 evaluationDatasets at the given index.

getEvaluationDatasetsCount()

public int getEvaluationDatasetsCount()

Output only. List of evaluation datasets the evaluation belongs to. Format: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}

repeated string evaluation_datasets = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of evaluationDatasets.

getEvaluationDatasetsList()

public ProtocolStringList getEvaluationDatasetsList()

Output only. List of evaluation datasets the evaluation belongs to. Format: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}

repeated string evaluation_datasets = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the evaluationDatasets.

getEvaluationRuns(int index)

public String getEvaluationRuns(int index)

Output only. The EvaluationRuns that this Evaluation is associated with.

repeated string evaluation_runs = 15 [(.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 evaluationRuns at the given index.

getEvaluationRunsBytes(int index)

public ByteString getEvaluationRunsBytes(int index)

Output only. The EvaluationRuns that this Evaluation is associated with.

repeated string evaluation_runs = 15 [(.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 evaluationRuns at the given index.

getEvaluationRunsCount()

public int getEvaluationRunsCount()

Output only. The EvaluationRuns that this Evaluation is associated with.

repeated string evaluation_runs = 15 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of evaluationRuns.

getEvaluationRunsList()

public ProtocolStringList getEvaluationRunsList()

Output only. The EvaluationRuns that this Evaluation is associated with.

repeated string evaluation_runs = 15 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the evaluationRuns.

getGolden()

public Evaluation.Golden getGolden()

Optional. The golden steps to be evaluated.

.google.cloud.ces.v1beta.Evaluation.Golden golden = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Evaluation.Golden

The golden.

getGoldenBuilder()

public Evaluation.Golden.Builder getGoldenBuilder()

Optional. The golden steps to be evaluated.

.google.cloud.ces.v1beta.Evaluation.Golden golden = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Evaluation.Golden.Builder

getGoldenOrBuilder()

public Evaluation.GoldenOrBuilder getGoldenOrBuilder()

Optional. The golden steps to be evaluated.

.google.cloud.ces.v1beta.Evaluation.Golden golden = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Evaluation.GoldenOrBuilder

getInputsCase()

public Evaluation.InputsCase getInputsCase()
Returns
Type Description
Evaluation.InputsCase

getInvalid()

public boolean getInvalid()

Output only. Whether the evaluation is invalid. This can happen if an evaluation is referencing a tool, toolset, or agent that has since been deleted.

bool invalid = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The invalid.

getLastCompletedResult()

public EvaluationResult getLastCompletedResult()

Output only. The latest evaluation result for this evaluation.

.google.cloud.ces.v1beta.EvaluationResult last_completed_result = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationResult

The lastCompletedResult.

getLastCompletedResultBuilder()

public EvaluationResult.Builder getLastCompletedResultBuilder()

Output only. The latest evaluation result for this evaluation.

.google.cloud.ces.v1beta.EvaluationResult last_completed_result = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationResult.Builder

getLastCompletedResultOrBuilder()

public EvaluationResultOrBuilder getLastCompletedResultOrBuilder()

Output only. The latest evaluation result for this evaluation.

.google.cloud.ces.v1beta.EvaluationResult last_completed_result = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationResultOrBuilder

getLastTenResults(int index)

public EvaluationResult getLastTenResults(int index)

Output only. The last 10 evaluation results for this evaluation. This is only populated if include_last_ten_results is set to true in the ListEvaluationsRequest or GetEvaluationRequest.

repeated .google.cloud.ces.v1beta.EvaluationResult last_ten_results = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
EvaluationResult

getLastTenResultsBuilder(int index)

public EvaluationResult.Builder getLastTenResultsBuilder(int index)

Output only. The last 10 evaluation results for this evaluation. This is only populated if include_last_ten_results is set to true in the ListEvaluationsRequest or GetEvaluationRequest.

repeated .google.cloud.ces.v1beta.EvaluationResult last_ten_results = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
EvaluationResult.Builder

getLastTenResultsBuilderList()

public List<EvaluationResult.Builder> getLastTenResultsBuilderList()

Output only. The last 10 evaluation results for this evaluation. This is only populated if include_last_ten_results is set to true in the ListEvaluationsRequest or GetEvaluationRequest.

repeated .google.cloud.ces.v1beta.EvaluationResult last_ten_results = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Builder>

getLastTenResultsCount()

public int getLastTenResultsCount()

Output only. The last 10 evaluation results for this evaluation. This is only populated if include_last_ten_results is set to true in the ListEvaluationsRequest or GetEvaluationRequest.

repeated .google.cloud.ces.v1beta.EvaluationResult last_ten_results = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getLastTenResultsList()

public List<EvaluationResult> getLastTenResultsList()

Output only. The last 10 evaluation results for this evaluation. This is only populated if include_last_ten_results is set to true in the ListEvaluationsRequest or GetEvaluationRequest.

repeated .google.cloud.ces.v1beta.EvaluationResult last_ten_results = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<EvaluationResult>

getLastTenResultsOrBuilder(int index)

public EvaluationResultOrBuilder getLastTenResultsOrBuilder(int index)

Output only. The last 10 evaluation results for this evaluation. This is only populated if include_last_ten_results is set to true in the ListEvaluationsRequest or GetEvaluationRequest.

repeated .google.cloud.ces.v1beta.EvaluationResult last_ten_results = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
EvaluationResultOrBuilder

getLastTenResultsOrBuilderList()

public List<? extends EvaluationResultOrBuilder> getLastTenResultsOrBuilderList()

Output only. The last 10 evaluation results for this evaluation. This is only populated if include_last_ten_results is set to true in the ListEvaluationsRequest or GetEvaluationRequest.

repeated .google.cloud.ces.v1beta.EvaluationResult last_ten_results = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getLastUpdatedBy()

public String getLastUpdatedBy()

Output only. The user who last updated the evaluation.

string last_updated_by = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The lastUpdatedBy.

getLastUpdatedByBytes()

public ByteString getLastUpdatedByBytes()

Output only. The user who last updated the evaluation.

string last_updated_by = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for lastUpdatedBy.

getName()

public String getName()

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

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

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

Returns
Type Description
ByteString

The bytes for name.

getScenario()

public Evaluation.Scenario getScenario()

Optional. The config for a scenario.

.google.cloud.ces.v1beta.Evaluation.Scenario scenario = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Evaluation.Scenario

The scenario.

getScenarioBuilder()

public Evaluation.Scenario.Builder getScenarioBuilder()

Optional. The config for a scenario.

.google.cloud.ces.v1beta.Evaluation.Scenario scenario = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Evaluation.Scenario.Builder

getScenarioOrBuilder()

public Evaluation.ScenarioOrBuilder getScenarioOrBuilder()

Optional. The config for a scenario.

.google.cloud.ces.v1beta.Evaluation.Scenario scenario = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Evaluation.ScenarioOrBuilder

getTags(int index)

public String getTags(int index)

Optional. User defined tags to categorize the evaluation.

repeated string tags = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The tags at the given index.

getTagsBytes(int index)

public ByteString getTagsBytes(int index)

Optional. User defined tags to categorize the evaluation.

repeated string tags = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the tags at the given index.

getTagsCount()

public int getTagsCount()

Optional. User defined tags to categorize the evaluation.

repeated string tags = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of tags.

getTagsList()

public ProtocolStringList getTagsList()

Optional. User defined tags to categorize the evaluation.

repeated string tags = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the tags.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp when the evaluation was last updated.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Timestamp when the evaluation was last updated.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when the evaluation was last updated.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasAggregatedMetrics()

public boolean hasAggregatedMetrics()

Output only. The aggregated metrics for this evaluation across all runs.

.google.cloud.ces.v1beta.AggregatedMetrics aggregated_metrics = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the aggregatedMetrics field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when the evaluation was created.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasGolden()

public boolean hasGolden()

Optional. The golden steps to be evaluated.

.google.cloud.ces.v1beta.Evaluation.Golden golden = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the golden field is set.

hasLastCompletedResult()

public boolean hasLastCompletedResult()

Output only. The latest evaluation result for this evaluation.

.google.cloud.ces.v1beta.EvaluationResult last_completed_result = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the lastCompletedResult field is set.

hasScenario()

public boolean hasScenario()

Optional. The config for a scenario.

.google.cloud.ces.v1beta.Evaluation.Scenario scenario = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the scenario field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Timestamp when the evaluation was last updated.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAggregatedMetrics(AggregatedMetrics value)

public Evaluation.Builder mergeAggregatedMetrics(AggregatedMetrics value)

Output only. The aggregated metrics for this evaluation across all runs.

.google.cloud.ces.v1beta.AggregatedMetrics aggregated_metrics = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value AggregatedMetrics
Returns
Type Description
Evaluation.Builder

mergeCreateTime(Timestamp value)

public Evaluation.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp when the evaluation was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Evaluation.Builder

mergeFrom(Evaluation other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeGolden(Evaluation.Golden value)

public Evaluation.Builder mergeGolden(Evaluation.Golden value)

Optional. The golden steps to be evaluated.

.google.cloud.ces.v1beta.Evaluation.Golden golden = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Evaluation.Golden
Returns
Type Description
Evaluation.Builder

mergeLastCompletedResult(EvaluationResult value)

public Evaluation.Builder mergeLastCompletedResult(EvaluationResult value)

Output only. The latest evaluation result for this evaluation.

.google.cloud.ces.v1beta.EvaluationResult last_completed_result = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value EvaluationResult
Returns
Type Description
Evaluation.Builder

mergeScenario(Evaluation.Scenario value)

public Evaluation.Builder mergeScenario(Evaluation.Scenario value)

Optional. The config for a scenario.

.google.cloud.ces.v1beta.Evaluation.Scenario scenario = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Evaluation.Scenario
Returns
Type Description
Evaluation.Builder

mergeUpdateTime(Timestamp value)

public Evaluation.Builder mergeUpdateTime(Timestamp value)

Output only. Timestamp when the evaluation was last updated.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Evaluation.Builder

removeLastTenResults(int index)

public Evaluation.Builder removeLastTenResults(int index)

Output only. The last 10 evaluation results for this evaluation. This is only populated if include_last_ten_results is set to true in the ListEvaluationsRequest or GetEvaluationRequest.

repeated .google.cloud.ces.v1beta.EvaluationResult last_ten_results = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Evaluation.Builder

setAggregatedMetrics(AggregatedMetrics value)

public Evaluation.Builder setAggregatedMetrics(AggregatedMetrics value)

Output only. The aggregated metrics for this evaluation across all runs.

.google.cloud.ces.v1beta.AggregatedMetrics aggregated_metrics = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value AggregatedMetrics
Returns
Type Description
Evaluation.Builder

setAggregatedMetrics(AggregatedMetrics.Builder builderForValue)

public Evaluation.Builder setAggregatedMetrics(AggregatedMetrics.Builder builderForValue)

Output only. The aggregated metrics for this evaluation across all runs.

.google.cloud.ces.v1beta.AggregatedMetrics aggregated_metrics = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue AggregatedMetrics.Builder
Returns
Type Description
Evaluation.Builder

setCreateTime(Timestamp value)

public Evaluation.Builder setCreateTime(Timestamp value)

Output only. Timestamp when the evaluation was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Evaluation.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Evaluation.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when the evaluation was created.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Evaluation.Builder

setCreatedBy(String value)

public Evaluation.Builder setCreatedBy(String value)

Output only. The user who created the evaluation.

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

Parameter
Name Description
value String

The createdBy to set.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

setCreatedByBytes(ByteString value)

public Evaluation.Builder setCreatedByBytes(ByteString value)

Output only. The user who created the evaluation.

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

Parameter
Name Description
value ByteString

The bytes for createdBy to set.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

setDescription(String value)

public Evaluation.Builder setDescription(String value)

Optional. User-defined description of the evaluation.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The description to set.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Evaluation.Builder setDescriptionBytes(ByteString value)

Optional. User-defined description of the evaluation.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

setDisplayName(String value)

public Evaluation.Builder setDisplayName(String value)

Required. User-defined display name of the evaluation. Unique within an App.

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

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Evaluation.Builder setDisplayNameBytes(ByteString value)

Required. User-defined display name of the evaluation. Unique within an App.

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

setEtag(String value)

public Evaluation.Builder setEtag(String value)

Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

string etag = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The etag to set.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public Evaluation.Builder setEtagBytes(ByteString value)

Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

string etag = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for etag to set.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

setEvaluationDatasets(int index, String value)

public Evaluation.Builder setEvaluationDatasets(int index, String value)

Output only. List of evaluation datasets the evaluation belongs to. Format: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}

repeated string evaluation_datasets = 5 [(.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 evaluationDatasets to set.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

setEvaluationRuns(int index, String value)

public Evaluation.Builder setEvaluationRuns(int index, String value)

Output only. The EvaluationRuns that this Evaluation is associated with.

repeated string evaluation_runs = 15 [(.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 evaluationRuns to set.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

setGolden(Evaluation.Golden value)

public Evaluation.Builder setGolden(Evaluation.Golden value)

Optional. The golden steps to be evaluated.

.google.cloud.ces.v1beta.Evaluation.Golden golden = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Evaluation.Golden
Returns
Type Description
Evaluation.Builder

setGolden(Evaluation.Golden.Builder builderForValue)

public Evaluation.Builder setGolden(Evaluation.Golden.Builder builderForValue)

Optional. The golden steps to be evaluated.

.google.cloud.ces.v1beta.Evaluation.Golden golden = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Evaluation.Golden.Builder
Returns
Type Description
Evaluation.Builder

setInvalid(boolean value)

public Evaluation.Builder setInvalid(boolean value)

Output only. Whether the evaluation is invalid. This can happen if an evaluation is referencing a tool, toolset, or agent that has since been deleted.

bool invalid = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The invalid to set.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

setLastCompletedResult(EvaluationResult value)

public Evaluation.Builder setLastCompletedResult(EvaluationResult value)

Output only. The latest evaluation result for this evaluation.

.google.cloud.ces.v1beta.EvaluationResult last_completed_result = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value EvaluationResult
Returns
Type Description
Evaluation.Builder

setLastCompletedResult(EvaluationResult.Builder builderForValue)

public Evaluation.Builder setLastCompletedResult(EvaluationResult.Builder builderForValue)

Output only. The latest evaluation result for this evaluation.

.google.cloud.ces.v1beta.EvaluationResult last_completed_result = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

setLastTenResults(int index, EvaluationResult value)

public Evaluation.Builder setLastTenResults(int index, EvaluationResult value)

Output only. The last 10 evaluation results for this evaluation. This is only populated if include_last_ten_results is set to true in the ListEvaluationsRequest or GetEvaluationRequest.

repeated .google.cloud.ces.v1beta.EvaluationResult last_ten_results = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value EvaluationResult
Returns
Type Description
Evaluation.Builder

setLastTenResults(int index, EvaluationResult.Builder builderForValue)

public Evaluation.Builder setLastTenResults(int index, EvaluationResult.Builder builderForValue)

Output only. The last 10 evaluation results for this evaluation. This is only populated if include_last_ten_results is set to true in the ListEvaluationsRequest or GetEvaluationRequest.

repeated .google.cloud.ces.v1beta.EvaluationResult last_ten_results = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue EvaluationResult.Builder
Returns
Type Description
Evaluation.Builder

setLastUpdatedBy(String value)

public Evaluation.Builder setLastUpdatedBy(String value)

Output only. The user who last updated the evaluation.

string last_updated_by = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The lastUpdatedBy to set.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

setLastUpdatedByBytes(ByteString value)

public Evaluation.Builder setLastUpdatedByBytes(ByteString value)

Output only. The user who last updated the evaluation.

string last_updated_by = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for lastUpdatedBy to set.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

setName(String value)

public Evaluation.Builder setName(String value)

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

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Evaluation.Builder setNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

setScenario(Evaluation.Scenario value)

public Evaluation.Builder setScenario(Evaluation.Scenario value)

Optional. The config for a scenario.

.google.cloud.ces.v1beta.Evaluation.Scenario scenario = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Evaluation.Scenario
Returns
Type Description
Evaluation.Builder

setScenario(Evaluation.Scenario.Builder builderForValue)

public Evaluation.Builder setScenario(Evaluation.Scenario.Builder builderForValue)

Optional. The config for a scenario.

.google.cloud.ces.v1beta.Evaluation.Scenario scenario = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Evaluation.Scenario.Builder
Returns
Type Description
Evaluation.Builder

setTags(int index, String value)

public Evaluation.Builder setTags(int index, String value)

Optional. User defined tags to categorize the evaluation.

repeated string tags = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value String

The tags to set.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

setUpdateTime(Timestamp value)

public Evaluation.Builder setUpdateTime(Timestamp value)

Output only. Timestamp when the evaluation was last updated.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Evaluation.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Evaluation.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when the evaluation was last updated.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Evaluation.Builder