/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/datalabeling/v1beta1/data_labeling_service.proto
package com.google.cloud.datalabeling.v1beta1;
public interface SearchEvaluationsRequestOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.datalabeling.v1beta1.SearchEvaluationsRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Required. Evaluation search parent (project ID). Format:
* "projects/<var>{project_id}</var>"
*
*
*
* string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
*
*
* @return The parent.
*/
java.lang.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) = { ... }
*
*
* @return The bytes for parent.
*/
com.google.protobuf.ByteString getParentBytes();
/**
*
*
*
* 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];
*
* @return The filter.
*/
java.lang.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];
*
* @return The bytes for filter.
*/
com.google.protobuf.ByteString getFilterBytes();
/**
*
*
*
* Optional. Requested page size. Server may return fewer results than
* requested. Default value is 100.
*
*
* int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The pageSize.
*/
int getPageSize();
/**
*
*
*
* 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];
*
* @return The pageToken.
*/
java.lang.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];
*
* @return The bytes for pageToken.
*/
com.google.protobuf.ByteString getPageTokenBytes();
}