Class Evaluation (0.3.0)

public final class Evaluation extends GeneratedMessage 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 Fields

AGGREGATED_METRICS_FIELD_NUMBER

public static final int AGGREGATED_METRICS_FIELD_NUMBER
Field Value
Type Description
int

CREATED_BY_FIELD_NUMBER

public static final int CREATED_BY_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

EVALUATION_DATASETS_FIELD_NUMBER

public static final int EVALUATION_DATASETS_FIELD_NUMBER
Field Value
Type Description
int

EVALUATION_RUNS_FIELD_NUMBER

public static final int EVALUATION_RUNS_FIELD_NUMBER
Field Value
Type Description
int

GOLDEN_FIELD_NUMBER

public static final int GOLDEN_FIELD_NUMBER
Field Value
Type Description
int

INVALID_FIELD_NUMBER

public static final int INVALID_FIELD_NUMBER
Field Value
Type Description
int

LAST_COMPLETED_RESULT_FIELD_NUMBER

public static final int LAST_COMPLETED_RESULT_FIELD_NUMBER
Field Value
Type Description
int

LAST_TEN_RESULTS_FIELD_NUMBER

public static final int LAST_TEN_RESULTS_FIELD_NUMBER
Field Value
Type Description
int

LAST_UPDATED_BY_FIELD_NUMBER

public static final int LAST_UPDATED_BY_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SCENARIO_FIELD_NUMBER

public static final int SCENARIO_FIELD_NUMBER
Field Value
Type Description
int

TAGS_FIELD_NUMBER

public static final int TAGS_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Evaluation getDefaultInstance()
Returns
Type Description
Evaluation

getDescriptor()

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

newBuilder()

public static Evaluation.Builder newBuilder()
Returns
Type Description
Evaluation.Builder

newBuilder(Evaluation prototype)

public static Evaluation.Builder newBuilder(Evaluation prototype)
Parameter
Name Description
prototype Evaluation
Returns
Type Description
Evaluation.Builder

parseDelimitedFrom(InputStream input)

public static Evaluation parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Evaluation
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Evaluation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Evaluation parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Evaluation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Evaluation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Evaluation parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Evaluation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Evaluation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Evaluation parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Evaluation
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Evaluation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Evaluation parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Evaluation
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Evaluation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Evaluation parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Evaluation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Evaluation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Evaluation> parser()
Returns
Type Description
Parser<Evaluation>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.

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.

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.

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.

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.

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

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.

getParserForType()

public Parser<Evaluation> getParserForType()
Returns
Type Description
Parser<Evaluation>
Overrides

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Evaluation.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Evaluation.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException