Package com.google.cloud.datalabeling.v1beta1

Interface SearchEvaluationsRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    Optional.
    com.google.protobuf.ByteString
    getFilterBytes()
    Optional.
    int
    getPageSize()
    Optional.
    String
    getPageToken()
    Optional.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    Optional.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getParent

      String getParent()
       Required. Evaluation search parent (project ID). Format:
 "projects/<var>{project_id}</var>"
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. Evaluation search parent (project ID). Format:
 "projects/<var>{project_id}</var>"
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • getFilter

      String getFilter()
       Optional. To search evaluations, you can filter by the following:

 * evaluation<span>_</span>job.evaluation_job_id (the last part of
 [EvaluationJob.name][google.cloud.datalabeling.v1beta1.EvaluationJob.name])
 * evaluation<span>_</span>job.model_id (the <var>{model_name}</var> portion
 of [EvaluationJob.modelVersion][google.cloud.datalabeling.v1beta1.EvaluationJob.model_version])
 * evaluation<span>_</span>job.evaluation_job_run_time_start (Minimum
 threshold for the
 [evaluationJobRunTime][google.cloud.datalabeling.v1beta1.Evaluation.evaluation_job_run_time] that created
 the evaluation)
 * evaluation<span>_</span>job.evaluation_job_run_time_end (Maximum
 threshold for the
 [evaluationJobRunTime][google.cloud.datalabeling.v1beta1.Evaluation.evaluation_job_run_time] that created
 the evaluation)
 * evaluation<span>_</span>job.job_state ([EvaluationJob.state][google.cloud.datalabeling.v1beta1.EvaluationJob.state])
 * annotation<span>_</span>spec.display_name (the Evaluation contains a
 metric for the annotation spec with this
 [displayName][google.cloud.datalabeling.v1beta1.AnnotationSpec.display_name])

 To filter by multiple critiera, use the `AND` operator or the `OR`
 operator. The following examples shows a string that filters by several
 critiera:

 "evaluation<span>_</span>job.evaluation_job_id =
 <var>{evaluation_job_id}</var> AND evaluation<span>_</span>job.model_id =
 <var>{model_name}</var> AND
 evaluation<span>_</span>job.evaluation_job_run_time_start =
 <var>{timestamp_1}</var> AND
 evaluation<span>_</span>job.evaluation_job_run_time_end =
 <var>{timestamp_2}</var> AND annotation<span>_</span>spec.display_name =
 <var>{display_name}</var>"
      string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       Optional. To search evaluations, you can filter by the following:

 * evaluation<span>_</span>job.evaluation_job_id (the last part of
 [EvaluationJob.name][google.cloud.datalabeling.v1beta1.EvaluationJob.name])
 * evaluation<span>_</span>job.model_id (the <var>{model_name}</var> portion
 of [EvaluationJob.modelVersion][google.cloud.datalabeling.v1beta1.EvaluationJob.model_version])
 * evaluation<span>_</span>job.evaluation_job_run_time_start (Minimum
 threshold for the
 [evaluationJobRunTime][google.cloud.datalabeling.v1beta1.Evaluation.evaluation_job_run_time] that created
 the evaluation)
 * evaluation<span>_</span>job.evaluation_job_run_time_end (Maximum
 threshold for the
 [evaluationJobRunTime][google.cloud.datalabeling.v1beta1.Evaluation.evaluation_job_run_time] that created
 the evaluation)
 * evaluation<span>_</span>job.job_state ([EvaluationJob.state][google.cloud.datalabeling.v1beta1.EvaluationJob.state])
 * annotation<span>_</span>spec.display_name (the Evaluation contains a
 metric for the annotation spec with this
 [displayName][google.cloud.datalabeling.v1beta1.AnnotationSpec.display_name])

 To filter by multiple critiera, use the `AND` operator or the `OR`
 operator. The following examples shows a string that filters by several
 critiera:

 "evaluation<span>_</span>job.evaluation_job_id =
 <var>{evaluation_job_id}</var> AND evaluation<span>_</span>job.model_id =
 <var>{model_name}</var> AND
 evaluation<span>_</span>job.evaluation_job_run_time_start =
 <var>{timestamp_1}</var> AND
 evaluation<span>_</span>job.evaluation_job_run_time_end =
 <var>{timestamp_2}</var> AND annotation<span>_</span>spec.display_name =
 <var>{display_name}</var>"
      string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for filter.

    • getPageSize

      int getPageSize()
       Optional. Requested page size. Server may return fewer results than
 requested. Default value is 100.
      int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageSize.

    • getPageToken

      String getPageToken()
       Optional. A token identifying a page of results for the server to return.
 Typically obtained by the
 [nextPageToken][google.cloud.datalabeling.v1beta1.SearchEvaluationsResponse.next_page_token] of the response
 to a previous search request.

 If you don't specify this field, the API call requests the first page of
 the search.
      string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       Optional. A token identifying a page of results for the server to return.
 Typically obtained by the
 [nextPageToken][google.cloud.datalabeling.v1beta1.SearchEvaluationsResponse.next_page_token] of the response
 to a previous search request.

 If you don't specify this field, the API call requests the first page of
 the search.
      string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for pageToken.