public final class Evaluation extends GeneratedMessageV3 implements EvaluationOrBuilder
An evaluation is a single execution (or run) of an evaluation process. It
encapsulates the state of the evaluation and the resulting data.
Protobuf type google.cloud.discoveryengine.v1alpha.Evaluation
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
END_TIME_FIELD_NUMBER
public static final int END_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ERROR_FIELD_NUMBER
public static final int ERROR_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ERROR_SAMPLES_FIELD_NUMBER
public static final int ERROR_SAMPLES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
EVALUATION_SPEC_FIELD_NUMBER
public static final int EVALUATION_SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
QUALITY_METRICS_FIELD_NUMBER
public static final int QUALITY_METRICS_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 Evaluation getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Evaluation.Builder newBuilder()
newBuilder(Evaluation prototype)
public static Evaluation.Builder newBuilder(Evaluation prototype)
public static Evaluation parseDelimitedFrom(InputStream input)
public static Evaluation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Evaluation parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Evaluation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Evaluation parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Evaluation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Evaluation parseFrom(CodedInputStream input)
public static Evaluation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Evaluation parseFrom(InputStream input)
public static Evaluation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Evaluation parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Evaluation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Evaluation> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getCreateTime()
public 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 TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp the
Evaluation was created
at.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Evaluation getDefaultInstanceForType()
getEndTime()
public 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 TimestampOrBuilder getEndTimeOrBuilder()
Output only. Timestamp the
Evaluation was completed
at.
.google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
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 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 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 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 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 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 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 Evaluation.EvaluationSpec getEvaluationSpec()
Required. The specification of the evaluation.
.google.cloud.discoveryengine.v1alpha.Evaluation.EvaluationSpec evaluation_spec = 2 [(.google.api.field_behavior) = REQUIRED];
getEvaluationSpecOrBuilder()
public Evaluation.EvaluationSpecOrBuilder getEvaluationSpecOrBuilder()
Required. The specification of the evaluation.
.google.cloud.discoveryengine.v1alpha.Evaluation.EvaluationSpec evaluation_spec = 2 [(.google.api.field_behavior) = REQUIRED];
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 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.
|
getParserForType()
public Parser<Evaluation> getParserForType()
Overrides
getQualityMetrics()
public 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];
getQualityMetricsOrBuilder()
public 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];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getState()
public Evaluation.State getState()
Output only. The state of the evaluation.
.google.cloud.discoveryengine.v1alpha.Evaluation.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue()
public 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 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 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 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 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 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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Evaluation.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Evaluation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Evaluation.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
