Package com.google.cloud.datalabeling.v1beta1

Class SearchEvaluationsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SearchEvaluationsRequest.Builder>
com.google.cloud.datalabeling.v1beta1.SearchEvaluationsRequest.Builder
All Implemented Interfaces:
SearchEvaluationsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SearchEvaluationsRequest
public static final class SearchEvaluationsRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<SearchEvaluationsRequest.Builder> implements SearchEvaluationsRequestOrBuilder
 Request message for SearchEvaluation.
Protobuf type google.cloud.datalabeling.v1beta1.SearchEvaluationsRequest

  • 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.Builder<SearchEvaluationsRequest.Builder>

    • clear

      public SearchEvaluationsRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<SearchEvaluationsRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<SearchEvaluationsRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public SearchEvaluationsRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchEvaluationsRequest.Builder>

    • mergeFrom

      public SearchEvaluationsRequest.Builder mergeFrom(SearchEvaluationsRequest other)

    • isInitialized

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

    • mergeFrom

      public SearchEvaluationsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchEvaluationsRequest.Builder>
      Throws:
      IOException

    • 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.

    • setParent

      public SearchEvaluationsRequest.Builder setParent(String value)
       Required. Evaluation search parent (project ID). Format:
 "projects/<var>{project_id}</var>"
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      This builder for chaining.

    • clearParent

      public SearchEvaluationsRequest.Builder clearParent()
       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:
      This builder for chaining.

    • setParentBytes

      public SearchEvaluationsRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
       Required. Evaluation search parent (project ID). Format:
 "projects/<var>{project_id}</var>"
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.

    • 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.

    • setFilter

      public SearchEvaluationsRequest.Builder setFilter(String value)
       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];
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.

    • clearFilter

      public SearchEvaluationsRequest.Builder clearFilter()
       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:
      This builder for chaining.

    • setFilterBytes

      public SearchEvaluationsRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.

    • 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.

    • setPageSize

      public SearchEvaluationsRequest.Builder setPageSize(int value)
       Optional. Requested page size. Server may return fewer results than
 requested. Default value is 100.
      int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public SearchEvaluationsRequest.Builder clearPageSize()
       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:
      This builder for chaining.

    • 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.

    • setPageToken

      public SearchEvaluationsRequest.Builder setPageToken(String value)
       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];
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public SearchEvaluationsRequest.Builder clearPageToken()
       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:
      This builder for chaining.

    • setPageTokenBytes

      public SearchEvaluationsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.