- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public interface SearchDataItemsRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAnnotationFilters(int index)
public abstract 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 specifysaved_query_id=- saved query id that annotations should belong to.
repeated string annotation_filters = 11;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The annotationFilters at the given index. |
getAnnotationFiltersBytes(int index)
public abstract 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 specifysaved_query_id=- saved query id that annotations should belong to.
repeated string annotation_filters = 11;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the annotationFilters at the given index. |
getAnnotationFiltersCount()
public abstract 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 specifysaved_query_id=- saved query id that annotations should belong to.
repeated string annotation_filters = 11;
| Returns | |
|---|---|
| Type | Description |
int |
The count of annotationFilters. |
getAnnotationFiltersList()
public abstract 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 specifysaved_query_id=- saved query id that annotations should belong to.
repeated string annotation_filters = 11;
| Returns | |
|---|---|
| Type | Description |
List<String> |
A list containing the annotationFilters. |
getAnnotationsFilter() (deprecated)
public abstract String getAnnotationsFilter()Deprecated. google.cloud.aiplatform.v1.SearchDataItemsRequest.annotations_filter is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=717
An expression for filtering the Annotations that will be returned per DataItem.
annotation_spec_id- for = or !=.
string annotations_filter = 5 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
String |
The annotationsFilter. |
getAnnotationsFilterBytes() (deprecated)
public abstract ByteString getAnnotationsFilterBytes()Deprecated. google.cloud.aiplatform.v1.SearchDataItemsRequest.annotations_filter is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=717
An expression for filtering the Annotations that will be returned per DataItem.
annotation_spec_id- for = or !=.
string annotations_filter = 5 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for annotationsFilter. |
getAnnotationsLimit()
public abstract 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 | |
|---|---|
| Type | Description |
int |
The annotationsLimit. |
getDataItemFilter()
public abstract 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_IDin the context of SavedQuery or DataLabelingJob.For example:
data_item=1has_annotation(5)
string data_item_filter = 4;
| Returns | |
|---|---|
| Type | Description |
String |
The dataItemFilter. |
getDataItemFilterBytes()
public abstract 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_IDin the context of SavedQuery or DataLabelingJob.For example:
data_item=1has_annotation(5)
string data_item_filter = 4;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for dataItemFilter. |
getDataLabelingJob()
public abstract 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 | |
|---|---|
| Type | Description |
String |
The dataLabelingJob. |
getDataLabelingJobBytes()
public abstract 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for dataLabelingJob. |
getDataset()
public abstract 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 | |
|---|---|
| Type | Description |
String |
The dataset. |
getDatasetBytes()
public abstract 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for dataset. |
getFieldMask()
public abstract FieldMask getFieldMask()Mask specifying which fields of DataItemView to read.
.google.protobuf.FieldMask field_mask = 6;
| Returns | |
|---|---|
| Type | Description |
FieldMask |
The fieldMask. |
getFieldMaskOrBuilder()
public abstract FieldMaskOrBuilder getFieldMaskOrBuilder()Mask specifying which fields of DataItemView to read.
.google.protobuf.FieldMask field_mask = 6;
| Returns | |
|---|---|
| Type | Description |
FieldMaskOrBuilder |
|
getOrderBy() (deprecated)
public abstract String getOrderBy()Deprecated. google.cloud.aiplatform.v1.SearchDataItemsRequest.order_by is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=741
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 | |
|---|---|
| Type | Description |
String |
The orderBy. |
getOrderByAnnotation()
public abstract SearchDataItemsRequest.OrderByAnnotation getOrderByAnnotation()Expression that allows ranking results based on annotation's property.
.google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;
| Returns | |
|---|---|
| Type | Description |
SearchDataItemsRequest.OrderByAnnotation |
The orderByAnnotation. |
getOrderByAnnotationOrBuilder()
public abstract SearchDataItemsRequest.OrderByAnnotationOrBuilder getOrderByAnnotationOrBuilder()Expression that allows ranking results based on annotation's property.
.google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;
| Returns | |
|---|---|
| Type | Description |
SearchDataItemsRequest.OrderByAnnotationOrBuilder |
|
getOrderByBytes() (deprecated)
public abstract ByteString getOrderByBytes()Deprecated. google.cloud.aiplatform.v1.SearchDataItemsRequest.order_by is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=741
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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for orderBy. |
getOrderByDataItem()
public abstract 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 | |
|---|---|
| Type | Description |
String |
The orderByDataItem. |
getOrderByDataItemBytes()
public abstract 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for orderByDataItem. |
getOrderCase()
public abstract SearchDataItemsRequest.OrderCase getOrderCase()| Returns | |
|---|---|
| Type | Description |
SearchDataItemsRequest.OrderCase |
|
getPageSize()
public abstract int getPageSize()Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.
int32 page_size = 8;
| Returns | |
|---|---|
| Type | Description |
int |
The pageSize. |
getPageToken()
public abstract String getPageToken()A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call.
string page_token = 10;
| Returns | |
|---|---|
| Type | Description |
String |
The pageToken. |
getPageTokenBytes()
public abstract ByteString getPageTokenBytes()A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call.
string page_token = 10;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for pageToken. |
getSavedQuery() (deprecated)
public abstract String getSavedQuery()Deprecated. google.cloud.aiplatform.v1.SearchDataItemsRequest.saved_query is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=686
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 | |
|---|---|
| Type | Description |
String |
The savedQuery. |
getSavedQueryBytes() (deprecated)
public abstract ByteString getSavedQueryBytes()Deprecated. google.cloud.aiplatform.v1.SearchDataItemsRequest.saved_query is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=686
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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for savedQuery. |
hasFieldMask()
public abstract boolean hasFieldMask()Mask specifying which fields of DataItemView to read.
.google.protobuf.FieldMask field_mask = 6;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the fieldMask field is set. |
hasOrderByAnnotation()
public abstract boolean hasOrderByAnnotation()Expression that allows ranking results based on annotation's property.
.google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the orderByAnnotation field is set. |
hasOrderByDataItem()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the orderByDataItem field is set. |