public interface EvaluationOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getCreateTime()
public abstract Timestamp getCreateTime()Output only. Timestamp the Evaluation was created at.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeOrBuilder()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()Output only. Timestamp the Evaluation was created at.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getEndTime()
public abstract Timestamp getEndTime()Output only. Timestamp the Evaluation was completed at.
.google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The endTime. |
getEndTimeOrBuilder()
public abstract TimestampOrBuilder getEndTimeOrBuilder()Output only. Timestamp the Evaluation was completed at.
.google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getError()
public abstract Status getError()Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.
.google.rpc.Status error = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.Status |
The error. |
getErrorOrBuilder()
public abstract StatusOrBuilder getErrorOrBuilder()Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.
.google.rpc.Status error = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.StatusOrBuilder |
|
getErrorSamples(int index)
public abstract Status getErrorSamples(int index)Output only. A sample of errors encountered while processing the request.
repeated .google.rpc.Status error_samples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.Status |
|
getErrorSamplesCount()
public abstract int getErrorSamplesCount()Output only. A sample of errors encountered while processing the request.
repeated .google.rpc.Status error_samples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
|
getErrorSamplesList()
public abstract List<Status> getErrorSamplesList()Output only. A sample of errors encountered while processing the request.
repeated .google.rpc.Status error_samples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<com.google.rpc.Status> |
|
getErrorSamplesOrBuilder(int index)
public abstract StatusOrBuilder getErrorSamplesOrBuilder(int index)Output only. A sample of errors encountered while processing the request.
repeated .google.rpc.Status error_samples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.StatusOrBuilder |
|
getErrorSamplesOrBuilderList()
public abstract List<? extends StatusOrBuilder> getErrorSamplesOrBuilderList()Output only. A sample of errors encountered while processing the request.
repeated .google.rpc.Status error_samples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.rpc.StatusOrBuilder> |
|
getEvaluationSpec()
public abstract Evaluation.EvaluationSpec getEvaluationSpec()Required. The specification of the evaluation.
.google.cloud.discoveryengine.v1alpha.Evaluation.EvaluationSpec evaluation_spec = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Evaluation.EvaluationSpec |
The evaluationSpec. |
getEvaluationSpecOrBuilder()
public abstract Evaluation.EvaluationSpecOrBuilder getEvaluationSpecOrBuilder()Required. The specification of the evaluation.
.google.cloud.discoveryengine.v1alpha.Evaluation.EvaluationSpec evaluation_spec = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Evaluation.EvaluationSpecOrBuilder |
|
getName()
public abstract String getName() Identifier. The full resource name of the
Evaluation, in the
format of
projects/{project}/locations/{location}/evaluations/{evaluation}.
This field must be a UTF-8 encoded string with a length limit of 1024 characters.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes() Identifier. The full resource name of the
Evaluation, in the
format of
projects/{project}/locations/{location}/evaluations/{evaluation}.
This field must be a UTF-8 encoded string with a length limit of 1024 characters.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getQualityMetrics()
public abstract QualityMetrics getQualityMetrics()Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet.
Only populated when the evaluation's state is SUCCEEDED.
.google.cloud.discoveryengine.v1alpha.QualityMetrics quality_metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
QualityMetrics |
The qualityMetrics. |
getQualityMetricsOrBuilder()
public abstract QualityMetricsOrBuilder getQualityMetricsOrBuilder()Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet.
Only populated when the evaluation's state is SUCCEEDED.
.google.cloud.discoveryengine.v1alpha.QualityMetrics quality_metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
QualityMetricsOrBuilder |
|
getState()
public abstract Evaluation.State getState()Output only. The state of the evaluation.
.google.cloud.discoveryengine.v1alpha.Evaluation.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Evaluation.State |
The state. |
getStateValue()
public abstract int getStateValue()Output only. The state of the evaluation.
.google.cloud.discoveryengine.v1alpha.Evaluation.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for state. |
hasCreateTime()
public abstract boolean hasCreateTime()Output only. Timestamp the Evaluation was created at.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the createTime field is set. |
hasEndTime()
public abstract boolean hasEndTime()Output only. Timestamp the Evaluation was completed at.
.google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the endTime field is set. |
hasError()
public abstract boolean hasError()Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.
.google.rpc.Status error = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the error field is set. |
hasEvaluationSpec()
public abstract boolean hasEvaluationSpec()Required. The specification of the evaluation.
.google.cloud.discoveryengine.v1alpha.Evaluation.EvaluationSpec evaluation_spec = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the evaluationSpec field is set. |
hasQualityMetrics()
public abstract boolean hasQualityMetrics()Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet.
Only populated when the evaluation's state is SUCCEEDED.
.google.cloud.discoveryengine.v1alpha.QualityMetrics quality_metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the qualityMetrics field is set. |