Package com.google.cloud.aiplatform.v1

Class SearchDataItemsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.SearchDataItemsRequest
All Implemented Interfaces:
SearchDataItemsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SearchDataItemsRequest extends com.google.protobuf.GeneratedMessage implements SearchDataItemsRequestOrBuilder
 Request message for
 [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems].
Protobuf type google.cloud.aiplatform.v1.SearchDataItemsRequest
See Also:

  • Field Details

    • ORDER_BY_DATA_ITEM_FIELD_NUMBER

      public static final int ORDER_BY_DATA_ITEM_FIELD_NUMBER
      See Also:

    • ORDER_BY_ANNOTATION_FIELD_NUMBER

      public static final int ORDER_BY_ANNOTATION_FIELD_NUMBER
      See Also:

    • DATASET_FIELD_NUMBER

      public static final int DATASET_FIELD_NUMBER
      See Also:

    • SAVED_QUERY_FIELD_NUMBER

      public static final int SAVED_QUERY_FIELD_NUMBER
      See Also:

    • DATA_LABELING_JOB_FIELD_NUMBER

      public static final int DATA_LABELING_JOB_FIELD_NUMBER
      See Also:

    • DATA_ITEM_FILTER_FIELD_NUMBER

      public static final int DATA_ITEM_FILTER_FIELD_NUMBER
      See Also:

    • ANNOTATIONS_FILTER_FIELD_NUMBER

      public static final int ANNOTATIONS_FILTER_FIELD_NUMBER
      See Also:

    • ANNOTATION_FILTERS_FIELD_NUMBER

      public static final int ANNOTATION_FILTERS_FIELD_NUMBER
      See Also:

    • FIELD_MASK_FIELD_NUMBER

      public static final int FIELD_MASK_FIELD_NUMBER
      See Also:

    • ANNOTATIONS_LIMIT_FIELD_NUMBER

      public static final int ANNOTATIONS_LIMIT_FIELD_NUMBER
      See Also:

    • PAGE_SIZE_FIELD_NUMBER

      public static final int PAGE_SIZE_FIELD_NUMBER
      See Also:

    • ORDER_BY_FIELD_NUMBER

      public static final int ORDER_BY_FIELD_NUMBER
      See Also:

    • PAGE_TOKEN_FIELD_NUMBER

      public static final int PAGE_TOKEN_FIELD_NUMBER
      See Also:

  • 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

    • getOrderCase

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    • isInitialized

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

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

    • getSerializedSize

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

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static SearchDataItemsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchDataItemsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchDataItemsRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchDataItemsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchDataItemsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchDataItemsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static SearchDataItemsRequest.Builder newBuilder()

    • newBuilder

      public static SearchDataItemsRequest.Builder newBuilder(SearchDataItemsRequest prototype)

    • toBuilder

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

    • newBuilderForType

      protected SearchDataItemsRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static SearchDataItemsRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SearchDataItemsRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<SearchDataItemsRequest> 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.GeneratedMessage

    • getDefaultInstanceForType

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