public static final class SearchDataItemsRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<SearchDataItemsRequest.Builder> implements SearchDataItemsRequestOrBuilder
Request message for [DatasetService.SearchDataItems][google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems].Protobuf type
google.cloud.aiplatform.v1beta1.SearchDataItemsRequest| Modifier and Type | Method and Description |
|---|---|
SearchDataItemsRequest.Builder |
addAllAnnotationFilters(Iterable<String> values)
An expression that specifies what Annotations will be returned per
DataItem.
|
SearchDataItemsRequest.Builder |
addAnnotationFilters(String value)
An expression that specifies what Annotations will be returned per
DataItem.
|
SearchDataItemsRequest.Builder |
addAnnotationFiltersBytes(com.google.protobuf.ByteString value)
An expression that specifies what Annotations will be returned per
DataItem.
|
SearchDataItemsRequest.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
SearchDataItemsRequest |
build() |
SearchDataItemsRequest |
buildPartial() |
SearchDataItemsRequest.Builder |
clear() |
SearchDataItemsRequest.Builder |
clearAnnotationFilters()
An expression that specifies what Annotations will be returned per
DataItem.
|
SearchDataItemsRequest.Builder |
clearAnnotationsFilter()
Deprecated.
google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.annotations_filter is
deprecated. See google/cloud/aiplatform/v1beta1/dataset_service.proto;l=713
|
SearchDataItemsRequest.Builder |
clearAnnotationsLimit()
If set, only up to this many of Annotations will be returned per
DataItemView.
|
SearchDataItemsRequest.Builder |
clearDataItemFilter()
An expression for filtering the DataItem that will be returned
|
SearchDataItemsRequest.Builder |
clearDataLabelingJob()
The resource name of a DataLabelingJob.
|
SearchDataItemsRequest.Builder |
clearDataset()
Required.
|
SearchDataItemsRequest.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
SearchDataItemsRequest.Builder |
clearFieldMask()
Mask specifying which fields of
[DataItemView][google.cloud.aiplatform.v1beta1.DataItemView] to read.
|
SearchDataItemsRequest.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
SearchDataItemsRequest.Builder |
clearOrder() |
SearchDataItemsRequest.Builder |
clearOrderBy()
Deprecated.
google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.order_by is deprecated.
See google/cloud/aiplatform/v1beta1/dataset_service.proto;l=737
|
SearchDataItemsRequest.Builder |
clearOrderByAnnotation()
Expression that allows ranking results based on annotation's property.
|
SearchDataItemsRequest.Builder |
clearOrderByDataItem()
A comma-separated list of data item fields to order by, sorted in
ascending order.
|
SearchDataItemsRequest.Builder |
clearPageSize()
Requested page size.
|
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.v1beta1.SearchDataItemsResponse.next_page_token]
of the previous
[DatasetService.SearchDataItems][google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems]
call.
|
SearchDataItemsRequest.Builder |
clearSavedQuery()
Deprecated.
google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.saved_query is deprecated.
See google/cloud/aiplatform/v1beta1/dataset_service.proto;l=682
|
SearchDataItemsRequest.Builder |
clone() |
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.
|
com.google.protobuf.ProtocolStringList |
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=713
|
com.google.protobuf.ByteString |
getAnnotationsFilterBytes()
Deprecated.
google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.annotations_filter is
deprecated. See google/cloud/aiplatform/v1beta1/dataset_service.proto;l=713
|
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.
|
SearchDataItemsRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
com.google.protobuf.FieldMask |
getFieldMask()
Mask specifying which fields of
[DataItemView][google.cloud.aiplatform.v1beta1.DataItemView] to read.
|
com.google.protobuf.FieldMask.Builder |
getFieldMaskBuilder()
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=737
|
SearchDataItemsRequest.OrderByAnnotation |
getOrderByAnnotation()
Expression that allows ranking results based on annotation's property.
|
SearchDataItemsRequest.OrderByAnnotation.Builder |
getOrderByAnnotationBuilder()
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=737
|
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=682
|
com.google.protobuf.ByteString |
getSavedQueryBytes()
Deprecated.
google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.saved_query is deprecated.
See google/cloud/aiplatform/v1beta1/dataset_service.proto;l=682
|
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.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
SearchDataItemsRequest.Builder |
mergeFieldMask(com.google.protobuf.FieldMask value)
Mask specifying which fields of
[DataItemView][google.cloud.aiplatform.v1beta1.DataItemView] to read.
|
SearchDataItemsRequest.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
SearchDataItemsRequest.Builder |
mergeFrom(com.google.protobuf.Message other) |
SearchDataItemsRequest.Builder |
mergeFrom(SearchDataItemsRequest other) |
SearchDataItemsRequest.Builder |
mergeOrderByAnnotation(SearchDataItemsRequest.OrderByAnnotation value)
Expression that allows ranking results based on annotation's property.
|
SearchDataItemsRequest.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
SearchDataItemsRequest.Builder |
setAnnotationFilters(int index,
String value)
An expression that specifies what Annotations will be returned per
DataItem.
|
SearchDataItemsRequest.Builder |
setAnnotationsFilter(String value)
Deprecated.
google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.annotations_filter is
deprecated. See google/cloud/aiplatform/v1beta1/dataset_service.proto;l=713
|
SearchDataItemsRequest.Builder |
setAnnotationsFilterBytes(com.google.protobuf.ByteString value)
Deprecated.
google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.annotations_filter is
deprecated. See google/cloud/aiplatform/v1beta1/dataset_service.proto;l=713
|
SearchDataItemsRequest.Builder |
setAnnotationsLimit(int value)
If set, only up to this many of Annotations will be returned per
DataItemView.
|
SearchDataItemsRequest.Builder |
setDataItemFilter(String value)
An expression for filtering the DataItem that will be returned
|
SearchDataItemsRequest.Builder |
setDataItemFilterBytes(com.google.protobuf.ByteString value)
An expression for filtering the DataItem that will be returned
|
SearchDataItemsRequest.Builder |
setDataLabelingJob(String value)
The resource name of a DataLabelingJob.
|
SearchDataItemsRequest.Builder |
setDataLabelingJobBytes(com.google.protobuf.ByteString value)
The resource name of a DataLabelingJob.
|
SearchDataItemsRequest.Builder |
setDataset(String value)
Required.
|
SearchDataItemsRequest.Builder |
setDatasetBytes(com.google.protobuf.ByteString value)
Required.
|
SearchDataItemsRequest.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
SearchDataItemsRequest.Builder |
setFieldMask(com.google.protobuf.FieldMask.Builder builderForValue)
Mask specifying which fields of
[DataItemView][google.cloud.aiplatform.v1beta1.DataItemView] to read.
|
SearchDataItemsRequest.Builder |
setFieldMask(com.google.protobuf.FieldMask value)
Mask specifying which fields of
[DataItemView][google.cloud.aiplatform.v1beta1.DataItemView] to read.
|
SearchDataItemsRequest.Builder |
setOrderBy(String value)
Deprecated.
google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.order_by is deprecated.
See google/cloud/aiplatform/v1beta1/dataset_service.proto;l=737
|
SearchDataItemsRequest.Builder |
setOrderByAnnotation(SearchDataItemsRequest.OrderByAnnotation.Builder builderForValue)
Expression that allows ranking results based on annotation's property.
|
SearchDataItemsRequest.Builder |
setOrderByAnnotation(SearchDataItemsRequest.OrderByAnnotation value)
Expression that allows ranking results based on annotation's property.
|
SearchDataItemsRequest.Builder |
setOrderByBytes(com.google.protobuf.ByteString value)
Deprecated.
google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.order_by is deprecated.
See google/cloud/aiplatform/v1beta1/dataset_service.proto;l=737
|
SearchDataItemsRequest.Builder |
setOrderByDataItem(String value)
A comma-separated list of data item fields to order by, sorted in
ascending order.
|
SearchDataItemsRequest.Builder |
setOrderByDataItemBytes(com.google.protobuf.ByteString value)
A comma-separated list of data item fields to order by, sorted in
ascending order.
|
SearchDataItemsRequest.Builder |
setPageSize(int value)
Requested page size.
|
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.v1beta1.SearchDataItemsResponse.next_page_token]
of the previous
[DatasetService.SearchDataItems][google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems]
call.
|
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.v1beta1.SearchDataItemsResponse.next_page_token]
of the previous
[DatasetService.SearchDataItems][google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems]
call.
|
SearchDataItemsRequest.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
SearchDataItemsRequest.Builder |
setSavedQuery(String value)
Deprecated.
google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.saved_query is deprecated.
See google/cloud/aiplatform/v1beta1/dataset_service.proto;l=682
|
SearchDataItemsRequest.Builder |
setSavedQueryBytes(com.google.protobuf.ByteString value)
Deprecated.
google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.saved_query is deprecated.
See google/cloud/aiplatform/v1beta1/dataset_service.proto;l=682
|
SearchDataItemsRequest.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<SearchDataItemsRequest.Builder>public SearchDataItemsRequest.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<SearchDataItemsRequest.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<SearchDataItemsRequest.Builder>public SearchDataItemsRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic SearchDataItemsRequest build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic SearchDataItemsRequest buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic SearchDataItemsRequest.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<SearchDataItemsRequest.Builder>public SearchDataItemsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchDataItemsRequest.Builder>public SearchDataItemsRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchDataItemsRequest.Builder>public SearchDataItemsRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SearchDataItemsRequest.Builder>public SearchDataItemsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchDataItemsRequest.Builder>public SearchDataItemsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchDataItemsRequest.Builder>public SearchDataItemsRequest.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchDataItemsRequest.Builder>public SearchDataItemsRequest.Builder mergeFrom(SearchDataItemsRequest other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<SearchDataItemsRequest.Builder>public SearchDataItemsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchDataItemsRequest.Builder>IOExceptionpublic SearchDataItemsRequest.OrderCase getOrderCase()
getOrderCase in interface SearchDataItemsRequestOrBuilderpublic SearchDataItemsRequest.Builder clearOrder()
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;hasOrderByDataItem in interface SearchDataItemsRequestOrBuilderpublic 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;getOrderByDataItem in interface SearchDataItemsRequestOrBuilderpublic 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;getOrderByDataItemBytes in interface SearchDataItemsRequestOrBuilderpublic 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;value - The orderByDataItem to set.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;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;value - The bytes for orderByDataItem to set.public boolean hasOrderByAnnotation()
Expression that allows ranking results based on annotation's property.
.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;
hasOrderByAnnotation in interface SearchDataItemsRequestOrBuilderpublic SearchDataItemsRequest.OrderByAnnotation getOrderByAnnotation()
Expression that allows ranking results based on annotation's property.
.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;
getOrderByAnnotation in interface SearchDataItemsRequestOrBuilderpublic SearchDataItemsRequest.Builder setOrderByAnnotation(SearchDataItemsRequest.OrderByAnnotation value)
Expression that allows ranking results based on annotation's property.
.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;
public SearchDataItemsRequest.Builder setOrderByAnnotation(SearchDataItemsRequest.OrderByAnnotation.Builder builderForValue)
Expression that allows ranking results based on annotation's property.
.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;
public SearchDataItemsRequest.Builder mergeOrderByAnnotation(SearchDataItemsRequest.OrderByAnnotation value)
Expression that allows ranking results based on annotation's property.
.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;
public SearchDataItemsRequest.Builder clearOrderByAnnotation()
Expression that allows ranking results based on annotation's property.
.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;
public SearchDataItemsRequest.OrderByAnnotation.Builder getOrderByAnnotationBuilder()
Expression that allows ranking results based on annotation's property.
.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;
public SearchDataItemsRequest.OrderByAnnotationOrBuilder getOrderByAnnotationOrBuilder()
Expression that allows ranking results based on annotation's property.
.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;
getOrderByAnnotationOrBuilder in interface SearchDataItemsRequestOrBuilderpublic 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) = { ... }
getDataset in interface SearchDataItemsRequestOrBuilderpublic 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) = { ... }
getDatasetBytes in interface SearchDataItemsRequestOrBuilderpublic 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) = { ... }
value - The dataset to set.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) = { ... }
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) = { ... }
value - The bytes for dataset to set.@Deprecated public String getSavedQuery()
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) = { ... }
getSavedQuery in interface SearchDataItemsRequestOrBuilder@Deprecated public com.google.protobuf.ByteString getSavedQueryBytes()
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) = { ... }
getSavedQueryBytes in interface SearchDataItemsRequestOrBuilder@Deprecated public SearchDataItemsRequest.Builder setSavedQuery(String value)
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) = { ... }
value - The savedQuery to set.@Deprecated public SearchDataItemsRequest.Builder clearSavedQuery()
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) = { ... }
@Deprecated public SearchDataItemsRequest.Builder setSavedQueryBytes(com.google.protobuf.ByteString value)
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) = { ... }
value - The bytes for savedQuery to set.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;getDataLabelingJob in interface SearchDataItemsRequestOrBuilderpublic 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;getDataLabelingJobBytes in interface SearchDataItemsRequestOrBuilderpublic 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;value - The dataLabelingJob to set.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;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;value - The bytes for dataLabelingJob to set.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;getDataItemFilter in interface SearchDataItemsRequestOrBuilderpublic 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;getDataItemFilterBytes in interface SearchDataItemsRequestOrBuilderpublic 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;value - The dataItemFilter to set.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;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;value - The bytes for dataItemFilter to set.@Deprecated public String getAnnotationsFilter()
An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=.
string annotations_filter = 5 [deprecated = true];getAnnotationsFilter in interface SearchDataItemsRequestOrBuilder@Deprecated public com.google.protobuf.ByteString getAnnotationsFilterBytes()
An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=.
string annotations_filter = 5 [deprecated = true];getAnnotationsFilterBytes in interface SearchDataItemsRequestOrBuilder@Deprecated public SearchDataItemsRequest.Builder setAnnotationsFilter(String value)
An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=.
string annotations_filter = 5 [deprecated = true];value - The annotationsFilter to set.@Deprecated public SearchDataItemsRequest.Builder clearAnnotationsFilter()
An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=.
string annotations_filter = 5 [deprecated = true];@Deprecated public SearchDataItemsRequest.Builder setAnnotationsFilterBytes(com.google.protobuf.ByteString value)
An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=.
string annotations_filter = 5 [deprecated = true];value - The bytes for annotationsFilter to set.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;getAnnotationFiltersList in interface SearchDataItemsRequestOrBuilderpublic 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;getAnnotationFiltersCount in interface SearchDataItemsRequestOrBuilderpublic 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;getAnnotationFilters in interface SearchDataItemsRequestOrBuilderindex - The index of the element to return.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;getAnnotationFiltersBytes in interface SearchDataItemsRequestOrBuilderindex - The index of the value to return.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;index - The index to set the value at.value - The annotationFilters to set.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;value - The annotationFilters to add.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;values - The annotationFilters to add.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;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;value - The bytes of the annotationFilters to add.public boolean hasFieldMask()
Mask specifying which fields of [DataItemView][google.cloud.aiplatform.v1beta1.DataItemView] to read.
.google.protobuf.FieldMask field_mask = 6;hasFieldMask in interface SearchDataItemsRequestOrBuilderpublic com.google.protobuf.FieldMask getFieldMask()
Mask specifying which fields of [DataItemView][google.cloud.aiplatform.v1beta1.DataItemView] to read.
.google.protobuf.FieldMask field_mask = 6;getFieldMask in interface SearchDataItemsRequestOrBuilderpublic SearchDataItemsRequest.Builder setFieldMask(com.google.protobuf.FieldMask value)
Mask specifying which fields of [DataItemView][google.cloud.aiplatform.v1beta1.DataItemView] to read.
.google.protobuf.FieldMask field_mask = 6;public SearchDataItemsRequest.Builder setFieldMask(com.google.protobuf.FieldMask.Builder builderForValue)
Mask specifying which fields of [DataItemView][google.cloud.aiplatform.v1beta1.DataItemView] to read.
.google.protobuf.FieldMask field_mask = 6;public SearchDataItemsRequest.Builder mergeFieldMask(com.google.protobuf.FieldMask value)
Mask specifying which fields of [DataItemView][google.cloud.aiplatform.v1beta1.DataItemView] to read.
.google.protobuf.FieldMask field_mask = 6;public SearchDataItemsRequest.Builder clearFieldMask()
Mask specifying which fields of [DataItemView][google.cloud.aiplatform.v1beta1.DataItemView] to read.
.google.protobuf.FieldMask field_mask = 6;public com.google.protobuf.FieldMask.Builder getFieldMaskBuilder()
Mask specifying which fields of [DataItemView][google.cloud.aiplatform.v1beta1.DataItemView] to read.
.google.protobuf.FieldMask field_mask = 6;public com.google.protobuf.FieldMaskOrBuilder getFieldMaskOrBuilder()
Mask specifying which fields of [DataItemView][google.cloud.aiplatform.v1beta1.DataItemView] to read.
.google.protobuf.FieldMask field_mask = 6;getFieldMaskOrBuilder in interface SearchDataItemsRequestOrBuilderpublic 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;getAnnotationsLimit in interface SearchDataItemsRequestOrBuilderpublic 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;value - The annotationsLimit to set.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;public int getPageSize()
Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.
int32 page_size = 8;getPageSize in interface SearchDataItemsRequestOrBuilderpublic 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;value - The pageSize to set.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;@Deprecated public String getOrderBy()
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];getOrderBy in interface SearchDataItemsRequestOrBuilder@Deprecated public com.google.protobuf.ByteString getOrderByBytes()
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];getOrderByBytes in interface SearchDataItemsRequestOrBuilder@Deprecated public SearchDataItemsRequest.Builder setOrderBy(String value)
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];value - The orderBy to set.@Deprecated public SearchDataItemsRequest.Builder clearOrderBy()
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];@Deprecated public SearchDataItemsRequest.Builder setOrderByBytes(com.google.protobuf.ByteString value)
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];value - The bytes for orderBy to set.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.v1beta1.SearchDataItemsResponse.next_page_token] of the previous [DatasetService.SearchDataItems][google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems] call.
string page_token = 10;getPageToken in interface SearchDataItemsRequestOrBuilderpublic 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;getPageTokenBytes in interface SearchDataItemsRequestOrBuilderpublic 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.v1beta1.SearchDataItemsResponse.next_page_token] of the previous [DatasetService.SearchDataItems][google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems] call.
string page_token = 10;value - The pageToken to set.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.v1beta1.SearchDataItemsResponse.next_page_token] of the previous [DatasetService.SearchDataItems][google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems] call.
string page_token = 10;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.v1beta1.SearchDataItemsResponse.next_page_token] of the previous [DatasetService.SearchDataItems][google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems] call.
string page_token = 10;value - The bytes for pageToken to set.public final SearchDataItemsRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchDataItemsRequest.Builder>public final SearchDataItemsRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchDataItemsRequest.Builder>Copyright © 2025 Google LLC. All rights reserved.