public final class Evaluation extends com.google.protobuf.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.v1beta.Evaluation| Modifier and Type | Class and Description |
|---|---|
static class |
Evaluation.Builder
An evaluation is a single execution (or run) of an evaluation process.
|
static class |
Evaluation.EvaluationSpec
Describes the specification of the evaluation.
|
static interface |
Evaluation.EvaluationSpecOrBuilder |
static class |
Evaluation.State
Describes the state of an evaluation.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
CREATE_TIME_FIELD_NUMBER |
static int |
END_TIME_FIELD_NUMBER |
static int |
ERROR_FIELD_NUMBER |
static int |
ERROR_SAMPLES_FIELD_NUMBER |
static int |
EVALUATION_SPEC_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
QUALITY_METRICS_FIELD_NUMBER |
static int |
STATE_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
static Evaluation |
getDefaultInstance() |
Evaluation |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Timestamp |
getEndTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getEndTimeOrBuilder()
Output only.
|
com.google.rpc.Status |
getError()
Output only.
|
com.google.rpc.StatusOrBuilder |
getErrorOrBuilder()
Output only.
|
com.google.rpc.Status |
getErrorSamples(int index)
Output only.
|
int |
getErrorSamplesCount()
Output only.
|
List<com.google.rpc.Status> |
getErrorSamplesList()
Output only.
|
com.google.rpc.StatusOrBuilder |
getErrorSamplesOrBuilder(int index)
Output only.
|
List<? extends com.google.rpc.StatusOrBuilder> |
getErrorSamplesOrBuilderList()
Output only.
|
Evaluation.EvaluationSpec |
getEvaluationSpec()
Required.
|
Evaluation.EvaluationSpecOrBuilder |
getEvaluationSpecOrBuilder()
Required.
|
String |
getName()
Identifier.
|
com.google.protobuf.ByteString |
getNameBytes()
Identifier.
|
com.google.protobuf.Parser<Evaluation> |
getParserForType() |
QualityMetrics |
getQualityMetrics()
Output only.
|
QualityMetricsOrBuilder |
getQualityMetricsOrBuilder()
Output only.
|
int |
getSerializedSize() |
Evaluation.State |
getState()
Output only.
|
int |
getStateValue()
Output only.
|
boolean |
hasCreateTime()
Output only.
|
boolean |
hasEndTime()
Output only.
|
boolean |
hasError()
Output only.
|
boolean |
hasEvaluationSpec()
Required.
|
int |
hashCode() |
boolean |
hasQualityMetrics()
Output only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static Evaluation.Builder |
newBuilder() |
static Evaluation.Builder |
newBuilder(Evaluation prototype) |
Evaluation.Builder |
newBuilderForType() |
protected Evaluation.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Evaluation |
parseDelimitedFrom(InputStream input) |
static Evaluation |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Evaluation |
parseFrom(byte[] data) |
static Evaluation |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Evaluation |
parseFrom(ByteBuffer data) |
static Evaluation |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Evaluation |
parseFrom(com.google.protobuf.ByteString data) |
static Evaluation |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Evaluation |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Evaluation |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Evaluation |
parseFrom(InputStream input) |
static Evaluation |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Evaluation> |
parser() |
Evaluation.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int EVALUATION_SPEC_FIELD_NUMBER
public static final int QUALITY_METRICS_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
public static final int ERROR_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
public static final int END_TIME_FIELD_NUMBER
public static final int ERROR_SAMPLES_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getName()
Identifier. The full resource name of the
[Evaluation][google.cloud.discoveryengine.v1beta.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];getName in interface EvaluationOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Identifier. The full resource name of the
[Evaluation][google.cloud.discoveryengine.v1beta.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];getNameBytes in interface EvaluationOrBuilderpublic boolean hasEvaluationSpec()
Required. The specification of the evaluation.
.google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec evaluation_spec = 2 [(.google.api.field_behavior) = REQUIRED];
hasEvaluationSpec in interface EvaluationOrBuilderpublic Evaluation.EvaluationSpec getEvaluationSpec()
Required. The specification of the evaluation.
.google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec evaluation_spec = 2 [(.google.api.field_behavior) = REQUIRED];
getEvaluationSpec in interface EvaluationOrBuilderpublic Evaluation.EvaluationSpecOrBuilder getEvaluationSpecOrBuilder()
Required. The specification of the evaluation.
.google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec evaluation_spec = 2 [(.google.api.field_behavior) = REQUIRED];
getEvaluationSpecOrBuilder in interface EvaluationOrBuilderpublic boolean hasQualityMetrics()
Output only. The metrics produced by the evaluation, averaged across all [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s in the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]. Only populated when the evaluation's state is SUCCEEDED.
.google.cloud.discoveryengine.v1beta.QualityMetrics quality_metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasQualityMetrics in interface EvaluationOrBuilderpublic QualityMetrics getQualityMetrics()
Output only. The metrics produced by the evaluation, averaged across all [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s in the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]. Only populated when the evaluation's state is SUCCEEDED.
.google.cloud.discoveryengine.v1beta.QualityMetrics quality_metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getQualityMetrics in interface EvaluationOrBuilderpublic QualityMetricsOrBuilder getQualityMetricsOrBuilder()
Output only. The metrics produced by the evaluation, averaged across all [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s in the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]. Only populated when the evaluation's state is SUCCEEDED.
.google.cloud.discoveryengine.v1beta.QualityMetrics quality_metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getQualityMetricsOrBuilder in interface EvaluationOrBuilderpublic int getStateValue()
Output only. The state of the evaluation.
.google.cloud.discoveryengine.v1beta.Evaluation.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue in interface EvaluationOrBuilderpublic Evaluation.State getState()
Output only. The state of the evaluation.
.google.cloud.discoveryengine.v1beta.Evaluation.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getState in interface EvaluationOrBuilderpublic 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];hasError in interface EvaluationOrBuilderpublic com.google.rpc.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];getError in interface EvaluationOrBuilderpublic com.google.rpc.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];getErrorOrBuilder in interface EvaluationOrBuilderpublic boolean hasCreateTime()
Output only. Timestamp the [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation] was created at.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime in interface EvaluationOrBuilderpublic com.google.protobuf.Timestamp getCreateTime()
Output only. Timestamp the [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation] was created at.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTime in interface EvaluationOrBuilderpublic com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp the [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation] was created at.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder in interface EvaluationOrBuilderpublic boolean hasEndTime()
Output only. Timestamp the [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation] was completed at.
.google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasEndTime in interface EvaluationOrBuilderpublic com.google.protobuf.Timestamp getEndTime()
Output only. Timestamp the [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation] was completed at.
.google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getEndTime in interface EvaluationOrBuilderpublic com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
Output only. Timestamp the [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation] was completed at.
.google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getEndTimeOrBuilder in interface EvaluationOrBuilderpublic List<com.google.rpc.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];
getErrorSamplesList in interface EvaluationOrBuilderpublic List<? extends com.google.rpc.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];
getErrorSamplesOrBuilderList in interface EvaluationOrBuilderpublic 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];
getErrorSamplesCount in interface EvaluationOrBuilderpublic com.google.rpc.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];
getErrorSamples in interface EvaluationOrBuilderpublic com.google.rpc.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];
getErrorSamplesOrBuilder in interface EvaluationOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Evaluation parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Evaluation parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Evaluation parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Evaluation parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Evaluation parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Evaluation parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Evaluation parseFrom(InputStream input) throws IOException
IOExceptionpublic static Evaluation parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Evaluation parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Evaluation parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Evaluation parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Evaluation parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Evaluation.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Evaluation.Builder newBuilder()
public static Evaluation.Builder newBuilder(Evaluation prototype)
public Evaluation.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Evaluation.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Evaluation getDefaultInstance()
public static com.google.protobuf.Parser<Evaluation> parser()
public com.google.protobuf.Parser<Evaluation> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Evaluation getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2025 Google LLC. All rights reserved.