Package com.google.cloud.datalabeling.v1beta1

Class SearchEvaluationsRequest

  • All Implemented Interfaces:
    SearchEvaluationsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class SearchEvaluationsRequest
extends com.google.protobuf.GeneratedMessageV3
implements SearchEvaluationsRequestOrBuilder
     Request message for SearchEvaluation.
    Protobuf type google.cloud.datalabeling.v1beta1.SearchEvaluationsRequest
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • getParent

        public 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) = { ... }
        Specified by:
        getParent in interface SearchEvaluationsRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public 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) = { ... }
        Specified by:
        getParentBytes in interface SearchEvaluationsRequestOrBuilder
        Returns:
        The bytes for parent.

      • getFilter

        public 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];
        Specified by:
        getFilter in interface SearchEvaluationsRequestOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public 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];
        Specified by:
        getFilterBytes in interface SearchEvaluationsRequestOrBuilder
        Returns:
        The bytes for filter.

      • getPageSize

        public 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];
        Specified by:
        getPageSize in interface SearchEvaluationsRequestOrBuilder
        Returns:
        The pageSize.

      • getPageToken

        public 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];
        Specified by:
        getPageToken in interface SearchEvaluationsRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public 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];
        Specified by:
        getPageTokenBytes in interface SearchEvaluationsRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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 SearchEvaluationsRequest parseFrom​(ByteBuffer data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected SearchEvaluationsRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<SearchEvaluationsRequest> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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