Interface EvaluationOrBuilder (0.3.0)

0.3.0 (latest) 0.1.0

public interface EvaluationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAggregatedMetrics()

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

getAggregatedMetricsOrBuilder()

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

getCreateTimeOrBuilder()

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

getDescription()

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

getDisplayName()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>	A list containing the evaluationDatasets.

getEvaluationRuns(int index)

public abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>	A list containing the evaluationRuns.

getGolden()

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

getGoldenOrBuilder()

public abstract 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 abstract Evaluation.InputsCase getInputsCase()

Returns
Type	Description
Evaluation.InputsCase

getInvalid()

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

getLastCompletedResultOrBuilder()

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

getLastTenResultsCount()

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

getScenarioOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> getTagsList()

Optional. User defined tags to categorize the evaluation.

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

Returns
Type	Description
List<String>	A list containing the tags.

getUpdateTime()

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

getUpdateTimeOrBuilder()

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