com.google.cloud.aiplatform.v1beta1

Interface SearchDataItemsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SearchDataItemsRequest, SearchDataItemsRequest.Builder

public interface SearchDataItemsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getAnnotationFilters(int index) An expression that specifies what Annotations will be returned per DataItem.
com.google.protobuf.ByteString	getAnnotationFiltersBytes(int index) An expression that specifies what Annotations will be returned per DataItem.
int	getAnnotationFiltersCount() An expression that specifies what Annotations will be returned per DataItem.
List<String>	getAnnotationFiltersList() An expression that specifies what Annotations will be returned per DataItem.
String	getAnnotationsFilter() Deprecated. google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.annotations_filter is deprecated. See google/cloud/aiplatform/v1beta1/dataset_service.proto;l=660
com.google.protobuf.ByteString	getAnnotationsFilterBytes() Deprecated. google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.annotations_filter is deprecated. See google/cloud/aiplatform/v1beta1/dataset_service.proto;l=660
int	getAnnotationsLimit() If set, only up to this many of Annotations will be returned per DataItemView.
String	getDataItemFilter() An expression for filtering the DataItem that will be returned.
com.google.protobuf.ByteString	getDataItemFilterBytes() An expression for filtering the DataItem that will be returned.
String	getDataLabelingJob() The resource name of a DataLabelingJob.
com.google.protobuf.ByteString	getDataLabelingJobBytes() The resource name of a DataLabelingJob.
String	getDataset() Required.
com.google.protobuf.ByteString	getDatasetBytes() Required.
com.google.protobuf.FieldMask	getFieldMask() Mask specifying which fields of [DataItemView][google.cloud.aiplatform.v1beta1.DataItemView] to read.
com.google.protobuf.FieldMaskOrBuilder	getFieldMaskOrBuilder() Mask specifying which fields of [DataItemView][google.cloud.aiplatform.v1beta1.DataItemView] to read.
String	getOrderBy() Deprecated. google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.order_by is deprecated. See google/cloud/aiplatform/v1beta1/dataset_service.proto;l=684
SearchDataItemsRequest.OrderByAnnotation	getOrderByAnnotation() Expression that allows ranking results based on annotation's property.
SearchDataItemsRequest.OrderByAnnotationOrBuilder	getOrderByAnnotationOrBuilder() Expression that allows ranking results based on annotation's property.
com.google.protobuf.ByteString	getOrderByBytes() Deprecated. google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.order_by is deprecated. See google/cloud/aiplatform/v1beta1/dataset_service.proto;l=684
String	getOrderByDataItem() A comma-separated list of data item fields to order by, sorted in ascending order.
com.google.protobuf.ByteString	getOrderByDataItemBytes() A comma-separated list of data item fields to order by, sorted in ascending order.
SearchDataItemsRequest.OrderCase	getOrderCase()
int	getPageSize() Requested page size.
String	getPageToken() A token identifying a page of results for the server to return Typically obtained via [SearchDataItemsResponse.next_page_token][google.cloud.aiplatform.v1beta1.SearchDataItemsResponse.next_page_token] of the previous [DatasetService.SearchDataItems][google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems] call.
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.v1beta1.SearchDataItemsResponse.next_page_token] of the previous [DatasetService.SearchDataItems][google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems] call.
String	getSavedQuery() Deprecated. google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.saved_query is deprecated. See google/cloud/aiplatform/v1beta1/dataset_service.proto;l=629
com.google.protobuf.ByteString	getSavedQueryBytes() Deprecated. google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.saved_query is deprecated. See google/cloud/aiplatform/v1beta1/dataset_service.proto;l=629
boolean	hasFieldMask() Mask specifying which fields of [DataItemView][google.cloud.aiplatform.v1beta1.DataItemView] to read.
boolean	hasOrderByAnnotation() Expression that allows ranking results based on annotation's property.
boolean	hasOrderByDataItem() A comma-separated list of data item fields to order by, sorted in ascending order.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasOrderByDataItem

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;

Returns:

Whether the orderByDataItem field is set.

getOrderByDataItem

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;

Returns:

The orderByDataItem.

getOrderByDataItemBytes

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;

Returns:

The bytes for orderByDataItem.

hasOrderByAnnotation

boolean hasOrderByAnnotation()

 Expression that allows ranking results based on annotation's property.
 

.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;

Returns:

Whether the orderByAnnotation field is set.

getOrderByAnnotation

SearchDataItemsRequest.OrderByAnnotation getOrderByAnnotation()

 Expression that allows ranking results based on annotation's property.
 

.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;

Returns:

The orderByAnnotation.

getOrderByAnnotationOrBuilder

SearchDataItemsRequest.OrderByAnnotationOrBuilder getOrderByAnnotationOrBuilder()

 Expression that allows ranking results based on annotation's property.
 

.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;

getDataset

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) = { ... }

Returns:

The dataset.

getDatasetBytes

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) = { ... }

Returns:

The bytes for dataset.

getSavedQuery

@Deprecated
String getSavedQuery()

Deprecated. google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.saved_query is deprecated. See google/cloud/aiplatform/v1beta1/dataset_service.proto;l=629

 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:

The savedQuery.

getSavedQueryBytes

@Deprecated
com.google.protobuf.ByteString getSavedQueryBytes()

Deprecated. google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.saved_query is deprecated. See google/cloud/aiplatform/v1beta1/dataset_service.proto;l=629

 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:

The bytes for savedQuery.

getDataLabelingJob

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;

Returns:

The dataLabelingJob.

getDataLabelingJobBytes

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;

Returns:

The bytes for dataLabelingJob.

getDataItemFilter

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;

Returns:

The dataItemFilter.

getDataItemFilterBytes

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;

Returns:

The bytes for dataItemFilter.

getAnnotationsFilter

@Deprecated
String getAnnotationsFilter()

Deprecated. google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.annotations_filter is deprecated. See google/cloud/aiplatform/v1beta1/dataset_service.proto;l=660

 An expression for filtering the Annotations that will be returned per
 DataItem.
   * `annotation_spec_id` - for = or !=.
 

string annotations_filter = 5 [deprecated = true];

Returns:

The annotationsFilter.

getAnnotationsFilterBytes

@Deprecated
com.google.protobuf.ByteString getAnnotationsFilterBytes()

Deprecated. google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.annotations_filter is deprecated. See google/cloud/aiplatform/v1beta1/dataset_service.proto;l=660

 An expression for filtering the Annotations that will be returned per
 DataItem.
   * `annotation_spec_id` - for = or !=.
 

string annotations_filter = 5 [deprecated = true];

Returns:

The bytes for annotationsFilter.

getAnnotationFiltersList

List<String> 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;

Returns:

A list containing the annotationFilters.

getAnnotationFiltersCount

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;

Returns:

The count of annotationFilters.

getAnnotationFilters

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;

Parameters:

index - The index of the element to return.

Returns:

The annotationFilters at the given index.

getAnnotationFiltersBytes

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;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the annotationFilters at the given index.

hasFieldMask

boolean hasFieldMask()

 Mask specifying which fields of
 [DataItemView][google.cloud.aiplatform.v1beta1.DataItemView] to read.
 

.google.protobuf.FieldMask field_mask = 6;

Returns:

Whether the fieldMask field is set.

getFieldMask

com.google.protobuf.FieldMask getFieldMask()

 Mask specifying which fields of
 [DataItemView][google.cloud.aiplatform.v1beta1.DataItemView] to read.
 

.google.protobuf.FieldMask field_mask = 6;

Returns:

The fieldMask.

getFieldMaskOrBuilder

com.google.protobuf.FieldMaskOrBuilder getFieldMaskOrBuilder()

 Mask specifying which fields of
 [DataItemView][google.cloud.aiplatform.v1beta1.DataItemView] to read.
 

.google.protobuf.FieldMask field_mask = 6;

getAnnotationsLimit

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;

Returns:

The annotationsLimit.

getPageSize

int getPageSize()

 Requested page size. Server may return fewer results than requested.
 Default and maximum page size is 100.
 

int32 page_size = 8;

Returns:

The pageSize.

getOrderBy

@Deprecated
String getOrderBy()

Deprecated. google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.order_by is deprecated. See google/cloud/aiplatform/v1beta1/dataset_service.proto;l=684

 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:

The orderBy.

getOrderByBytes

@Deprecated
com.google.protobuf.ByteString getOrderByBytes()

Deprecated. google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.order_by is deprecated. See google/cloud/aiplatform/v1beta1/dataset_service.proto;l=684

 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:

The bytes for orderBy.

getPageToken

String getPageToken()

 A token identifying a page of results for the server to return
 Typically obtained via
 [SearchDataItemsResponse.next_page_token][google.cloud.aiplatform.v1beta1.SearchDataItemsResponse.next_page_token]
 of the previous
 [DatasetService.SearchDataItems][google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems]
 call.
 

string page_token = 10;

Returns:

The pageToken.

getPageTokenBytes

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.v1beta1.SearchDataItemsResponse.next_page_token]
 of the previous
 [DatasetService.SearchDataItems][google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems]
 call.
 

string page_token = 10;

Returns:

The bytes for pageToken.

getOrderCase

SearchDataItemsRequest.OrderCase getOrderCase()