Package com.google.cloud.discoveryengine.v1beta

Interface EvaluationOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Evaluation, Evaluation.Builder
@Generated public interface EvaluationOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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];
      Returns:
      The name.

    • getNameBytes

      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];
      Returns:
      The bytes for name.

    • hasEvaluationSpec

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

    • getEvaluationSpec

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

    • getEvaluationSpecOrBuilder

      Evaluation.EvaluationSpecOrBuilder getEvaluationSpecOrBuilder()
       Required. The specification of the evaluation.
      .google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec evaluation_spec = 2 [(.google.api.field_behavior) = REQUIRED];

    • hasQualityMetrics

      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];
      Returns:
      Whether the qualityMetrics field is set.

    • getQualityMetrics

      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];
      Returns:
      The qualityMetrics.

    • getQualityMetricsOrBuilder

      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];

    • getStateValue

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

    • getState

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

    • hasError

      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:
      Whether the error field is set.

    • getError

      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:
      The error.

    • getErrorOrBuilder

      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];

    • hasCreateTime

      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];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      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];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      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];

    • hasEndTime

      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];
      Returns:
      Whether the endTime field is set.

    • getEndTime

      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];
      Returns:
      The endTime.

    • getEndTimeOrBuilder

      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];

    • getErrorSamplesList

      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];

    • getErrorSamples

      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];

    • getErrorSamplesCount

      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];

    • getErrorSamplesOrBuilderList

      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];

    • getErrorSamplesOrBuilder

      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];