Class SearchDataItemsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SearchDataItemsRequest.Builder>
com.google.cloud.aiplatform.v1.SearchDataItemsRequest.Builder
All Implemented Interfaces:
SearchDataItemsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SearchDataItemsRequest

public static final class SearchDataItemsRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<SearchDataItemsRequest.Builder> implements SearchDataItemsRequestOrBuilder
 Request message for
 [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems].
 
Protobuf type google.cloud.aiplatform.v1.SearchDataItemsRequest
  • 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<SearchDataItemsRequest.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<SearchDataItemsRequest.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<SearchDataItemsRequest.Builder>
    • getDefaultInstanceForType

      public SearchDataItemsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

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

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

      public SearchDataItemsRequest.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<SearchDataItemsRequest.Builder>
    • mergeFrom

    • isInitialized

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

      public SearchDataItemsRequest.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<SearchDataItemsRequest.Builder>
      Throws:
      IOException
    • getOrderCase

      public SearchDataItemsRequest.OrderCase getOrderCase()
      Specified by:
      getOrderCase in interface SearchDataItemsRequestOrBuilder
    • clearOrder

      public SearchDataItemsRequest.Builder clearOrder()
    • hasOrderByDataItem

      public boolean hasOrderByDataItem()
       A comma-separated list of data item fields to order by, sorted in
       ascending order. Use "desc" after a field name for descending.
       
      string order_by_data_item = 12;
      Specified by:
      hasOrderByDataItem in interface SearchDataItemsRequestOrBuilder
      Returns:
      Whether the orderByDataItem field is set.
    • getOrderByDataItem

      public String getOrderByDataItem()
       A comma-separated list of data item fields to order by, sorted in
       ascending order. Use "desc" after a field name for descending.
       
      string order_by_data_item = 12;
      Specified by:
      getOrderByDataItem in interface SearchDataItemsRequestOrBuilder
      Returns:
      The orderByDataItem.
    • getOrderByDataItemBytes

      public com.google.protobuf.ByteString getOrderByDataItemBytes()
       A comma-separated list of data item fields to order by, sorted in
       ascending order. Use "desc" after a field name for descending.
       
      string order_by_data_item = 12;
      Specified by:
      getOrderByDataItemBytes in interface SearchDataItemsRequestOrBuilder
      Returns:
      The bytes for orderByDataItem.
    • setOrderByDataItem

      public SearchDataItemsRequest.Builder setOrderByDataItem(String value)
       A comma-separated list of data item fields to order by, sorted in
       ascending order. Use "desc" after a field name for descending.
       
      string order_by_data_item = 12;
      Parameters:
      value - The orderByDataItem to set.
      Returns:
      This builder for chaining.
    • clearOrderByDataItem

      public SearchDataItemsRequest.Builder clearOrderByDataItem()
       A comma-separated list of data item fields to order by, sorted in
       ascending order. Use "desc" after a field name for descending.
       
      string order_by_data_item = 12;
      Returns:
      This builder for chaining.
    • setOrderByDataItemBytes

      public SearchDataItemsRequest.Builder setOrderByDataItemBytes(com.google.protobuf.ByteString value)
       A comma-separated list of data item fields to order by, sorted in
       ascending order. Use "desc" after a field name for descending.
       
      string order_by_data_item = 12;
      Parameters:
      value - The bytes for orderByDataItem to set.
      Returns:
      This builder for chaining.
    • hasOrderByAnnotation

      public boolean hasOrderByAnnotation()
       Expression that allows ranking results based on annotation's property.
       
      .google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;
      Specified by:
      hasOrderByAnnotation in interface SearchDataItemsRequestOrBuilder
      Returns:
      Whether the orderByAnnotation field is set.
    • getOrderByAnnotation

      public SearchDataItemsRequest.OrderByAnnotation getOrderByAnnotation()
       Expression that allows ranking results based on annotation's property.
       
      .google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;
      Specified by:
      getOrderByAnnotation in interface SearchDataItemsRequestOrBuilder
      Returns:
      The orderByAnnotation.
    • setOrderByAnnotation

       Expression that allows ranking results based on annotation's property.
       
      .google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;
    • setOrderByAnnotation

       Expression that allows ranking results based on annotation's property.
       
      .google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;
    • mergeOrderByAnnotation

       Expression that allows ranking results based on annotation's property.
       
      .google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;
    • clearOrderByAnnotation

      public SearchDataItemsRequest.Builder clearOrderByAnnotation()
       Expression that allows ranking results based on annotation's property.
       
      .google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;
    • getOrderByAnnotationBuilder

      public SearchDataItemsRequest.OrderByAnnotation.Builder getOrderByAnnotationBuilder()
       Expression that allows ranking results based on annotation's property.
       
      .google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;
    • getOrderByAnnotationOrBuilder

      public SearchDataItemsRequest.OrderByAnnotationOrBuilder getOrderByAnnotationOrBuilder()
       Expression that allows ranking results based on annotation's property.
       
      .google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;
      Specified by:
      getOrderByAnnotationOrBuilder in interface SearchDataItemsRequestOrBuilder
    • getDataset

      public String getDataset()
       Required. The resource name of the Dataset from which to search DataItems.
       Format:
       `projects/{project}/locations/{location}/datasets/{dataset}`
       
      string dataset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getDataset in interface SearchDataItemsRequestOrBuilder
      Returns:
      The dataset.
    • getDatasetBytes

      public com.google.protobuf.ByteString getDatasetBytes()
       Required. The resource name of the Dataset from which to search DataItems.
       Format:
       `projects/{project}/locations/{location}/datasets/{dataset}`
       
      string dataset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getDatasetBytes in interface SearchDataItemsRequestOrBuilder
      Returns:
      The bytes for dataset.
    • setDataset

      public SearchDataItemsRequest.Builder setDataset(String value)
       Required. The resource name of the Dataset from which to search DataItems.
       Format:
       `projects/{project}/locations/{location}/datasets/{dataset}`
       
      string dataset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The dataset to set.
      Returns:
      This builder for chaining.
    • clearDataset

      public SearchDataItemsRequest.Builder clearDataset()
       Required. The resource name of the Dataset from which to search DataItems.
       Format:
       `projects/{project}/locations/{location}/datasets/{dataset}`
       
      string dataset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.
    • setDatasetBytes

      public SearchDataItemsRequest.Builder setDatasetBytes(com.google.protobuf.ByteString value)
       Required. The resource name of the Dataset from which to search DataItems.
       Format:
       `projects/{project}/locations/{location}/datasets/{dataset}`
       
      string dataset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for dataset to set.
      Returns:
      This builder for chaining.
    • getSavedQuery

      @Deprecated public String getSavedQuery()
      Deprecated.
      google.cloud.aiplatform.v1.SearchDataItemsRequest.saved_query is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=682
       The resource name of a SavedQuery(annotation set in UI).
       Format:
       `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`
       All of the search will be done in the context of this SavedQuery.
       
      string saved_query = 2 [deprecated = true, (.google.api.resource_reference) = { ... }
      Specified by:
      getSavedQuery in interface SearchDataItemsRequestOrBuilder
      Returns:
      The savedQuery.
    • getSavedQueryBytes

      @Deprecated public com.google.protobuf.ByteString getSavedQueryBytes()
      Deprecated.
      google.cloud.aiplatform.v1.SearchDataItemsRequest.saved_query is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=682
       The resource name of a SavedQuery(annotation set in UI).
       Format:
       `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`
       All of the search will be done in the context of this SavedQuery.
       
      string saved_query = 2 [deprecated = true, (.google.api.resource_reference) = { ... }
      Specified by:
      getSavedQueryBytes in interface SearchDataItemsRequestOrBuilder
      Returns:
      The bytes for savedQuery.
    • setSavedQuery

      @Deprecated public SearchDataItemsRequest.Builder setSavedQuery(String value)
      Deprecated.
      google.cloud.aiplatform.v1.SearchDataItemsRequest.saved_query is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=682
       The resource name of a SavedQuery(annotation set in UI).
       Format:
       `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`
       All of the search will be done in the context of this SavedQuery.
       
      string saved_query = 2 [deprecated = true, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The savedQuery to set.
      Returns:
      This builder for chaining.
    • clearSavedQuery

      @Deprecated public SearchDataItemsRequest.Builder clearSavedQuery()
      Deprecated.
      google.cloud.aiplatform.v1.SearchDataItemsRequest.saved_query is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=682
       The resource name of a SavedQuery(annotation set in UI).
       Format:
       `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`
       All of the search will be done in the context of this SavedQuery.
       
      string saved_query = 2 [deprecated = true, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.
    • setSavedQueryBytes

      @Deprecated public SearchDataItemsRequest.Builder setSavedQueryBytes(com.google.protobuf.ByteString value)
      Deprecated.
      google.cloud.aiplatform.v1.SearchDataItemsRequest.saved_query is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=682
       The resource name of a SavedQuery(annotation set in UI).
       Format:
       `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`
       All of the search will be done in the context of this SavedQuery.
       
      string saved_query = 2 [deprecated = true, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for savedQuery to set.
      Returns:
      This builder for chaining.
    • getDataLabelingJob

      public String getDataLabelingJob()
       The resource name of a DataLabelingJob.
       Format:
       `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
       If this field is set, all of the search will be done in the context of
       this DataLabelingJob.
       
      string data_labeling_job = 3;
      Specified by:
      getDataLabelingJob in interface SearchDataItemsRequestOrBuilder
      Returns:
      The dataLabelingJob.
    • getDataLabelingJobBytes

      public com.google.protobuf.ByteString getDataLabelingJobBytes()
       The resource name of a DataLabelingJob.
       Format:
       `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
       If this field is set, all of the search will be done in the context of
       this DataLabelingJob.
       
      string data_labeling_job = 3;
      Specified by:
      getDataLabelingJobBytes in interface SearchDataItemsRequestOrBuilder
      Returns:
      The bytes for dataLabelingJob.
    • setDataLabelingJob

      public SearchDataItemsRequest.Builder setDataLabelingJob(String value)
       The resource name of a DataLabelingJob.
       Format:
       `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
       If this field is set, all of the search will be done in the context of
       this DataLabelingJob.
       
      string data_labeling_job = 3;
      Parameters:
      value - The dataLabelingJob to set.
      Returns:
      This builder for chaining.
    • clearDataLabelingJob

      public SearchDataItemsRequest.Builder clearDataLabelingJob()
       The resource name of a DataLabelingJob.
       Format:
       `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
       If this field is set, all of the search will be done in the context of
       this DataLabelingJob.
       
      string data_labeling_job = 3;
      Returns:
      This builder for chaining.
    • setDataLabelingJobBytes

      public SearchDataItemsRequest.Builder setDataLabelingJobBytes(com.google.protobuf.ByteString value)
       The resource name of a DataLabelingJob.
       Format:
       `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
       If this field is set, all of the search will be done in the context of
       this DataLabelingJob.
       
      string data_labeling_job = 3;
      Parameters:
      value - The bytes for dataLabelingJob to set.
      Returns:
      This builder for chaining.
    • getDataItemFilter

      public String getDataItemFilter()
       An expression for filtering the DataItem that will be returned.
      
       * `data_item_id` - for = or !=.
       * `labeled` - for = or !=.
       * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that
       have at least one annotation with annotation_spec_id =
       `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob.
      
       For example:
      
       * `data_item=1`
       * `has_annotation(5)`
       
      string data_item_filter = 4;
      Specified by:
      getDataItemFilter in interface SearchDataItemsRequestOrBuilder
      Returns:
      The dataItemFilter.
    • getDataItemFilterBytes

      public com.google.protobuf.ByteString getDataItemFilterBytes()
       An expression for filtering the DataItem that will be returned.
      
       * `data_item_id` - for = or !=.
       * `labeled` - for = or !=.
       * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that
       have at least one annotation with annotation_spec_id =
       `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob.
      
       For example:
      
       * `data_item=1`
       * `has_annotation(5)`
       
      string data_item_filter = 4;
      Specified by:
      getDataItemFilterBytes in interface SearchDataItemsRequestOrBuilder
      Returns:
      The bytes for dataItemFilter.
    • setDataItemFilter

      public SearchDataItemsRequest.Builder setDataItemFilter(String value)
       An expression for filtering the DataItem that will be returned.
      
       * `data_item_id` - for = or !=.
       * `labeled` - for = or !=.
       * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that
       have at least one annotation with annotation_spec_id =
       `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob.
      
       For example:
      
       * `data_item=1`
       * `has_annotation(5)`
       
      string data_item_filter = 4;
      Parameters:
      value - The dataItemFilter to set.
      Returns:
      This builder for chaining.
    • clearDataItemFilter

      public SearchDataItemsRequest.Builder clearDataItemFilter()
       An expression for filtering the DataItem that will be returned.
      
       * `data_item_id` - for = or !=.
       * `labeled` - for = or !=.
       * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that
       have at least one annotation with annotation_spec_id =
       `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob.
      
       For example:
      
       * `data_item=1`
       * `has_annotation(5)`
       
      string data_item_filter = 4;
      Returns:
      This builder for chaining.
    • setDataItemFilterBytes

      public SearchDataItemsRequest.Builder setDataItemFilterBytes(com.google.protobuf.ByteString value)
       An expression for filtering the DataItem that will be returned.
      
       * `data_item_id` - for = or !=.
       * `labeled` - for = or !=.
       * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that
       have at least one annotation with annotation_spec_id =
       `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob.
      
       For example:
      
       * `data_item=1`
       * `has_annotation(5)`
       
      string data_item_filter = 4;
      Parameters:
      value - The bytes for dataItemFilter to set.
      Returns:
      This builder for chaining.
    • getAnnotationsFilter

      @Deprecated public String getAnnotationsFilter()
      Deprecated.
      google.cloud.aiplatform.v1.SearchDataItemsRequest.annotations_filter is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=713
       An expression for filtering the Annotations that will be returned per
       DataItem.
       * `annotation_spec_id` - for = or !=.
       
      string annotations_filter = 5 [deprecated = true];
      Specified by:
      getAnnotationsFilter in interface SearchDataItemsRequestOrBuilder
      Returns:
      The annotationsFilter.
    • getAnnotationsFilterBytes

      @Deprecated public com.google.protobuf.ByteString getAnnotationsFilterBytes()
      Deprecated.
      google.cloud.aiplatform.v1.SearchDataItemsRequest.annotations_filter is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=713
       An expression for filtering the Annotations that will be returned per
       DataItem.
       * `annotation_spec_id` - for = or !=.
       
      string annotations_filter = 5 [deprecated = true];
      Specified by:
      getAnnotationsFilterBytes in interface SearchDataItemsRequestOrBuilder
      Returns:
      The bytes for annotationsFilter.
    • setAnnotationsFilter

      @Deprecated public SearchDataItemsRequest.Builder setAnnotationsFilter(String value)
      Deprecated.
      google.cloud.aiplatform.v1.SearchDataItemsRequest.annotations_filter is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=713
       An expression for filtering the Annotations that will be returned per
       DataItem.
       * `annotation_spec_id` - for = or !=.
       
      string annotations_filter = 5 [deprecated = true];
      Parameters:
      value - The annotationsFilter to set.
      Returns:
      This builder for chaining.
    • clearAnnotationsFilter

      @Deprecated public SearchDataItemsRequest.Builder clearAnnotationsFilter()
      Deprecated.
      google.cloud.aiplatform.v1.SearchDataItemsRequest.annotations_filter is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=713
       An expression for filtering the Annotations that will be returned per
       DataItem.
       * `annotation_spec_id` - for = or !=.
       
      string annotations_filter = 5 [deprecated = true];
      Returns:
      This builder for chaining.
    • setAnnotationsFilterBytes

      @Deprecated public SearchDataItemsRequest.Builder setAnnotationsFilterBytes(com.google.protobuf.ByteString value)
      Deprecated.
      google.cloud.aiplatform.v1.SearchDataItemsRequest.annotations_filter is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=713
       An expression for filtering the Annotations that will be returned per
       DataItem.
       * `annotation_spec_id` - for = or !=.
       
      string annotations_filter = 5 [deprecated = true];
      Parameters:
      value - The bytes for annotationsFilter to set.
      Returns:
      This builder for chaining.
    • getAnnotationFiltersList

      public com.google.protobuf.ProtocolStringList getAnnotationFiltersList()
       An expression that specifies what Annotations will be returned per
       DataItem. Annotations satisfied either of the conditions will be returned.
       * `annotation_spec_id` - for = or !=.
       Must specify `saved_query_id=` - saved query id that annotations should
       belong to.
       
      repeated string annotation_filters = 11;
      Specified by:
      getAnnotationFiltersList in interface SearchDataItemsRequestOrBuilder
      Returns:
      A list containing the annotationFilters.
    • getAnnotationFiltersCount

      public int getAnnotationFiltersCount()
       An expression that specifies what Annotations will be returned per
       DataItem. Annotations satisfied either of the conditions will be returned.
       * `annotation_spec_id` - for = or !=.
       Must specify `saved_query_id=` - saved query id that annotations should
       belong to.
       
      repeated string annotation_filters = 11;
      Specified by:
      getAnnotationFiltersCount in interface SearchDataItemsRequestOrBuilder
      Returns:
      The count of annotationFilters.
    • getAnnotationFilters

      public String getAnnotationFilters(int index)
       An expression that specifies what Annotations will be returned per
       DataItem. Annotations satisfied either of the conditions will be returned.
       * `annotation_spec_id` - for = or !=.
       Must specify `saved_query_id=` - saved query id that annotations should
       belong to.
       
      repeated string annotation_filters = 11;
      Specified by:
      getAnnotationFilters in interface SearchDataItemsRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The annotationFilters at the given index.
    • getAnnotationFiltersBytes

      public com.google.protobuf.ByteString getAnnotationFiltersBytes(int index)
       An expression that specifies what Annotations will be returned per
       DataItem. Annotations satisfied either of the conditions will be returned.
       * `annotation_spec_id` - for = or !=.
       Must specify `saved_query_id=` - saved query id that annotations should
       belong to.
       
      repeated string annotation_filters = 11;
      Specified by:
      getAnnotationFiltersBytes in interface SearchDataItemsRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the annotationFilters at the given index.
    • setAnnotationFilters

      public SearchDataItemsRequest.Builder setAnnotationFilters(int index, String value)
       An expression that specifies what Annotations will be returned per
       DataItem. Annotations satisfied either of the conditions will be returned.
       * `annotation_spec_id` - for = or !=.
       Must specify `saved_query_id=` - saved query id that annotations should
       belong to.
       
      repeated string annotation_filters = 11;
      Parameters:
      index - The index to set the value at.
      value - The annotationFilters to set.
      Returns:
      This builder for chaining.
    • addAnnotationFilters

      public SearchDataItemsRequest.Builder addAnnotationFilters(String value)
       An expression that specifies what Annotations will be returned per
       DataItem. Annotations satisfied either of the conditions will be returned.
       * `annotation_spec_id` - for = or !=.
       Must specify `saved_query_id=` - saved query id that annotations should
       belong to.
       
      repeated string annotation_filters = 11;
      Parameters:
      value - The annotationFilters to add.
      Returns:
      This builder for chaining.
    • addAllAnnotationFilters

      public SearchDataItemsRequest.Builder addAllAnnotationFilters(Iterable<String> values)
       An expression that specifies what Annotations will be returned per
       DataItem. Annotations satisfied either of the conditions will be returned.
       * `annotation_spec_id` - for = or !=.
       Must specify `saved_query_id=` - saved query id that annotations should
       belong to.
       
      repeated string annotation_filters = 11;
      Parameters:
      values - The annotationFilters to add.
      Returns:
      This builder for chaining.
    • clearAnnotationFilters

      public SearchDataItemsRequest.Builder clearAnnotationFilters()
       An expression that specifies what Annotations will be returned per
       DataItem. Annotations satisfied either of the conditions will be returned.
       * `annotation_spec_id` - for = or !=.
       Must specify `saved_query_id=` - saved query id that annotations should
       belong to.
       
      repeated string annotation_filters = 11;
      Returns:
      This builder for chaining.
    • addAnnotationFiltersBytes

      public SearchDataItemsRequest.Builder addAnnotationFiltersBytes(com.google.protobuf.ByteString value)
       An expression that specifies what Annotations will be returned per
       DataItem. Annotations satisfied either of the conditions will be returned.
       * `annotation_spec_id` - for = or !=.
       Must specify `saved_query_id=` - saved query id that annotations should
       belong to.
       
      repeated string annotation_filters = 11;
      Parameters:
      value - The bytes of the annotationFilters to add.
      Returns:
      This builder for chaining.
    • hasFieldMask

      public boolean hasFieldMask()
       Mask specifying which fields of
       [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.
       
      .google.protobuf.FieldMask field_mask = 6;
      Specified by:
      hasFieldMask in interface SearchDataItemsRequestOrBuilder
      Returns:
      Whether the fieldMask field is set.
    • getFieldMask

      public com.google.protobuf.FieldMask getFieldMask()
       Mask specifying which fields of
       [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.
       
      .google.protobuf.FieldMask field_mask = 6;
      Specified by:
      getFieldMask in interface SearchDataItemsRequestOrBuilder
      Returns:
      The fieldMask.
    • setFieldMask

      public SearchDataItemsRequest.Builder setFieldMask(com.google.protobuf.FieldMask value)
       Mask specifying which fields of
       [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.
       
      .google.protobuf.FieldMask field_mask = 6;
    • setFieldMask

      public SearchDataItemsRequest.Builder setFieldMask(com.google.protobuf.FieldMask.Builder builderForValue)
       Mask specifying which fields of
       [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.
       
      .google.protobuf.FieldMask field_mask = 6;
    • mergeFieldMask

      public SearchDataItemsRequest.Builder mergeFieldMask(com.google.protobuf.FieldMask value)
       Mask specifying which fields of
       [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.
       
      .google.protobuf.FieldMask field_mask = 6;
    • clearFieldMask

      public SearchDataItemsRequest.Builder clearFieldMask()
       Mask specifying which fields of
       [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.
       
      .google.protobuf.FieldMask field_mask = 6;
    • getFieldMaskBuilder

      public com.google.protobuf.FieldMask.Builder getFieldMaskBuilder()
       Mask specifying which fields of
       [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.
       
      .google.protobuf.FieldMask field_mask = 6;
    • getFieldMaskOrBuilder

      public com.google.protobuf.FieldMaskOrBuilder getFieldMaskOrBuilder()
       Mask specifying which fields of
       [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.
       
      .google.protobuf.FieldMask field_mask = 6;
      Specified by:
      getFieldMaskOrBuilder in interface SearchDataItemsRequestOrBuilder
    • getAnnotationsLimit

      public int getAnnotationsLimit()
       If set, only up to this many of Annotations will be returned per
       DataItemView. The maximum value is 1000. If not set, the maximum value will
       be used.
       
      int32 annotations_limit = 7;
      Specified by:
      getAnnotationsLimit in interface SearchDataItemsRequestOrBuilder
      Returns:
      The annotationsLimit.
    • setAnnotationsLimit

      public SearchDataItemsRequest.Builder setAnnotationsLimit(int value)
       If set, only up to this many of Annotations will be returned per
       DataItemView. The maximum value is 1000. If not set, the maximum value will
       be used.
       
      int32 annotations_limit = 7;
      Parameters:
      value - The annotationsLimit to set.
      Returns:
      This builder for chaining.
    • clearAnnotationsLimit

      public SearchDataItemsRequest.Builder clearAnnotationsLimit()
       If set, only up to this many of Annotations will be returned per
       DataItemView. The maximum value is 1000. If not set, the maximum value will
       be used.
       
      int32 annotations_limit = 7;
      Returns:
      This builder for chaining.
    • getPageSize

      public int getPageSize()
       Requested page size. Server may return fewer results than requested.
       Default and maximum page size is 100.
       
      int32 page_size = 8;
      Specified by:
      getPageSize in interface SearchDataItemsRequestOrBuilder
      Returns:
      The pageSize.
    • setPageSize

      public SearchDataItemsRequest.Builder setPageSize(int value)
       Requested page size. Server may return fewer results than requested.
       Default and maximum page size is 100.
       
      int32 page_size = 8;
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.
    • clearPageSize

      public SearchDataItemsRequest.Builder clearPageSize()
       Requested page size. Server may return fewer results than requested.
       Default and maximum page size is 100.
       
      int32 page_size = 8;
      Returns:
      This builder for chaining.
    • getOrderBy

      @Deprecated public String getOrderBy()
      Deprecated.
      google.cloud.aiplatform.v1.SearchDataItemsRequest.order_by is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=737
       A comma-separated list of fields to order by, sorted in ascending order.
       Use "desc" after a field name for descending.
       
      string order_by = 9 [deprecated = true];
      Specified by:
      getOrderBy in interface SearchDataItemsRequestOrBuilder
      Returns:
      The orderBy.
    • getOrderByBytes

      @Deprecated public com.google.protobuf.ByteString getOrderByBytes()
      Deprecated.
      google.cloud.aiplatform.v1.SearchDataItemsRequest.order_by is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=737
       A comma-separated list of fields to order by, sorted in ascending order.
       Use "desc" after a field name for descending.
       
      string order_by = 9 [deprecated = true];
      Specified by:
      getOrderByBytes in interface SearchDataItemsRequestOrBuilder
      Returns:
      The bytes for orderBy.
    • setOrderBy

      Deprecated.
      google.cloud.aiplatform.v1.SearchDataItemsRequest.order_by is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=737
       A comma-separated list of fields to order by, sorted in ascending order.
       Use "desc" after a field name for descending.
       
      string order_by = 9 [deprecated = true];
      Parameters:
      value - The orderBy to set.
      Returns:
      This builder for chaining.
    • clearOrderBy

      Deprecated.
      google.cloud.aiplatform.v1.SearchDataItemsRequest.order_by is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=737
       A comma-separated list of fields to order by, sorted in ascending order.
       Use "desc" after a field name for descending.
       
      string order_by = 9 [deprecated = true];
      Returns:
      This builder for chaining.
    • setOrderByBytes

      @Deprecated public SearchDataItemsRequest.Builder setOrderByBytes(com.google.protobuf.ByteString value)
      Deprecated.
      google.cloud.aiplatform.v1.SearchDataItemsRequest.order_by is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=737
       A comma-separated list of fields to order by, sorted in ascending order.
       Use "desc" after a field name for descending.
       
      string order_by = 9 [deprecated = true];
      Parameters:
      value - The bytes for orderBy to set.
      Returns:
      This builder for chaining.
    • getPageToken

      public String getPageToken()
       A token identifying a page of results for the server to return
       Typically obtained via
       [SearchDataItemsResponse.next_page_token][google.cloud.aiplatform.v1.SearchDataItemsResponse.next_page_token]
       of the previous
       [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems]
       call.
       
      string page_token = 10;
      Specified by:
      getPageToken in interface SearchDataItemsRequestOrBuilder
      Returns:
      The pageToken.
    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       A token identifying a page of results for the server to return
       Typically obtained via
       [SearchDataItemsResponse.next_page_token][google.cloud.aiplatform.v1.SearchDataItemsResponse.next_page_token]
       of the previous
       [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems]
       call.
       
      string page_token = 10;
      Specified by:
      getPageTokenBytes in interface SearchDataItemsRequestOrBuilder
      Returns:
      The bytes for pageToken.
    • setPageToken

      public SearchDataItemsRequest.Builder setPageToken(String value)
       A token identifying a page of results for the server to return
       Typically obtained via
       [SearchDataItemsResponse.next_page_token][google.cloud.aiplatform.v1.SearchDataItemsResponse.next_page_token]
       of the previous
       [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems]
       call.
       
      string page_token = 10;
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.
    • clearPageToken

      public SearchDataItemsRequest.Builder clearPageToken()
       A token identifying a page of results for the server to return
       Typically obtained via
       [SearchDataItemsResponse.next_page_token][google.cloud.aiplatform.v1.SearchDataItemsResponse.next_page_token]
       of the previous
       [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems]
       call.
       
      string page_token = 10;
      Returns:
      This builder for chaining.
    • setPageTokenBytes

      public SearchDataItemsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       A token identifying a page of results for the server to return
       Typically obtained via
       [SearchDataItemsResponse.next_page_token][google.cloud.aiplatform.v1.SearchDataItemsResponse.next_page_token]
       of the previous
       [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems]
       call.
       
      string page_token = 10;
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.