public final class EvaluationRun extends GeneratedMessage implements EvaluationRunOrBuilderAn evaluation run represents an all the evaluation results from an evaluation execution.
Protobuf type google.cloud.ces.v1beta.EvaluationRun
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > EvaluationRunImplements
EvaluationRunOrBuilderStatic Fields
APP_VERSION_DISPLAY_NAME_FIELD_NUMBER
public static final int APP_VERSION_DISPLAY_NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
APP_VERSION_FIELD_NUMBER
public static final int APP_VERSION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CHANGELOG_CREATE_TIME_FIELD_NUMBER
public static final int CHANGELOG_CREATE_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CHANGELOG_FIELD_NUMBER
public static final int CHANGELOG_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CONFIG_FIELD_NUMBER
public static final int CONFIG_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ERROR_FIELD_NUMBER
public static final int ERROR_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ERROR_INFO_FIELD_NUMBER
public static final int ERROR_INFO_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
EVALUATIONS_FIELD_NUMBER
public static final int EVALUATIONS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
EVALUATION_DATASET_FIELD_NUMBER
public static final int EVALUATION_DATASET_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
EVALUATION_RESULTS_FIELD_NUMBER
public static final int EVALUATION_RESULTS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
EVALUATION_RUN_SUMMARIES_FIELD_NUMBER
public static final int EVALUATION_RUN_SUMMARIES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
EVALUATION_TYPE_FIELD_NUMBER
public static final int EVALUATION_TYPE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
GOLDEN_RUN_METHOD_FIELD_NUMBER
public static final int GOLDEN_RUN_METHOD_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
INITIATED_BY_FIELD_NUMBER
public static final int INITIATED_BY_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
LATENCY_REPORT_FIELD_NUMBER
public static final int LATENCY_REPORT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
OPTIMIZATION_CONFIG_FIELD_NUMBER
public static final int OPTIMIZATION_CONFIG_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PERSONA_RUN_CONFIGS_FIELD_NUMBER
public static final int PERSONA_RUN_CONFIGS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PROGRESS_FIELD_NUMBER
public static final int PROGRESS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
RUN_COUNT_FIELD_NUMBER
public static final int RUN_COUNT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SCHEDULED_EVALUATION_RUN_FIELD_NUMBER
public static final int SCHEDULED_EVALUATION_RUN_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static EvaluationRun getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
EvaluationRun |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static EvaluationRun.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
EvaluationRun.Builder |
|
newBuilder(EvaluationRun prototype)
public static EvaluationRun.Builder newBuilder(EvaluationRun prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
EvaluationRun |
| Returns | |
|---|---|
| Type | Description |
EvaluationRun.Builder |
|
parseDelimitedFrom(InputStream input)
public static EvaluationRun parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
EvaluationRun |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static EvaluationRun parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
EvaluationRun |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static EvaluationRun parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
EvaluationRun |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static EvaluationRun parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
EvaluationRun |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static EvaluationRun parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
EvaluationRun |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static EvaluationRun parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
EvaluationRun |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static EvaluationRun parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
EvaluationRun |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static EvaluationRun parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
EvaluationRun |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static EvaluationRun parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
EvaluationRun |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static EvaluationRun parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
EvaluationRun |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static EvaluationRun parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
EvaluationRun |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static EvaluationRun parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
EvaluationRun |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<EvaluationRun> parser()| Returns | |
|---|---|
| Type | Description |
Parser<EvaluationRun> |
|
Methods
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 |
|
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| 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. |
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. |
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. |
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 |
|
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. |
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. |
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 |
intThe 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 |
intThe 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()Use #getEvaluationRunSummariesMap() instead.
| 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 |
intThe 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 |
intThe 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. |
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 |
|
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. |
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 |
|
getParserForType()
public Parser<EvaluationRun> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<EvaluationRun> |
|
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 |
|
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. |
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. |
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public EvaluationRun.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
EvaluationRun.Builder |
|
newBuilderForType(AbstractMessage.BuilderParent parent)
protected EvaluationRun.Builder newBuilderForType(AbstractMessage.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
EvaluationRun.Builder |
|
toBuilder()
public EvaluationRun.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
EvaluationRun.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|