Package com.google.cloud.discoveryengine.v1beta

Class Evaluation

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1beta.Evaluation
All Implemented Interfaces:
EvaluationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Evaluation extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • EVALUATION_SPEC_FIELD_NUMBER

      public static final int EVALUATION_SPEC_FIELD_NUMBER
      See Also:

    • QUALITY_METRICS_FIELD_NUMBER

      public static final int QUALITY_METRICS_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • ERROR_FIELD_NUMBER

      public static final int ERROR_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • END_TIME_FIELD_NUMBER

      public static final int END_TIME_FIELD_NUMBER
      See Also:

    • ERROR_SAMPLES_FIELD_NUMBER

      public static final int ERROR_SAMPLES_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public 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];
      Specified by:
      getName in interface EvaluationOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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];
      Specified by:
      getNameBytes in interface EvaluationOrBuilder
      Returns:
      The bytes for name.

    • hasEvaluationSpec

      public boolean hasEvaluationSpec()
       Required. The specification of the evaluation.
      .google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec evaluation_spec = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasEvaluationSpec in interface EvaluationOrBuilder
      Returns:
      Whether the evaluationSpec field is set.

    • getEvaluationSpec

      public Evaluation.EvaluationSpec getEvaluationSpec()
       Required. The specification of the evaluation.
      .google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec evaluation_spec = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getEvaluationSpec in interface EvaluationOrBuilder
      Returns:
      The evaluationSpec.

    • getEvaluationSpecOrBuilder

      public Evaluation.EvaluationSpecOrBuilder getEvaluationSpecOrBuilder()
       Required. The specification of the evaluation.
      .google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec evaluation_spec = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getEvaluationSpecOrBuilder in interface EvaluationOrBuilder

    • hasQualityMetrics

      public 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];
      Specified by:
      hasQualityMetrics in interface EvaluationOrBuilder
      Returns:
      Whether the qualityMetrics field is set.

    • getQualityMetrics

      public 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];
      Specified by:
      getQualityMetrics in interface EvaluationOrBuilder
      Returns:
      The qualityMetrics.

    • getQualityMetricsOrBuilder

      public 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];
      Specified by:
      getQualityMetricsOrBuilder in interface EvaluationOrBuilder

    • getStateValue

      public int getStateValue()
       Output only. The state of the evaluation.
      .google.cloud.discoveryengine.v1beta.Evaluation.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStateValue in interface EvaluationOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • getState

      public Evaluation.State getState()
       Output only. The state of the evaluation.
      .google.cloud.discoveryengine.v1beta.Evaluation.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getState in interface EvaluationOrBuilder
      Returns:
      The state.

    • 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];
      Specified by:
      hasError in interface EvaluationOrBuilder
      Returns:
      Whether the error field is set.

    • getError

      public 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];
      Specified by:
      getError in interface EvaluationOrBuilder
      Returns:
      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];
      Specified by:
      getErrorOrBuilder in interface EvaluationOrBuilder

    • hasCreateTime

      public 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];
      Specified by:
      hasCreateTime in interface EvaluationOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public 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];
      Specified by:
      getCreateTime in interface EvaluationOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public 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];
      Specified by:
      getCreateTimeOrBuilder in interface EvaluationOrBuilder

    • hasEndTime

      public 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];
      Specified by:
      hasEndTime in interface EvaluationOrBuilder
      Returns:
      Whether the endTime field is set.

    • getEndTime

      public 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];
      Specified by:
      getEndTime in interface EvaluationOrBuilder
      Returns:
      The endTime.

    • getEndTimeOrBuilder

      public 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];
      Specified by:
      getEndTimeOrBuilder in interface EvaluationOrBuilder

    • 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];
      Specified by:
      getErrorSamplesList in interface EvaluationOrBuilder

    • 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];
      Specified by:
      getErrorSamplesOrBuilderList in interface EvaluationOrBuilder

    • 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];
      Specified by:
      getErrorSamplesCount in interface EvaluationOrBuilder

    • getErrorSamples

      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];
      Specified by:
      getErrorSamples in interface EvaluationOrBuilder

    • getErrorSamplesOrBuilder

      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];
      Specified by:
      getErrorSamplesOrBuilder in interface EvaluationOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Evaluation parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Evaluation parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Evaluation parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Evaluation parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Evaluation parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Evaluation parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Evaluation parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Evaluation parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Evaluation parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Evaluation parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Evaluation parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Evaluation parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Evaluation.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Evaluation.Builder newBuilder()

    • newBuilder

      public static Evaluation.Builder newBuilder(Evaluation prototype)

    • toBuilder

      public Evaluation.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Evaluation.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Evaluation getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Evaluation> parser()

    • getParserForType

      public com.google.protobuf.Parser<Evaluation> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Evaluation getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder