Package com.google.cloud.aiplatform.v1
Class SearchDataItemsRequest.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SearchDataItemsRequest.Builder>
com.google.cloud.aiplatform.v1.SearchDataItemsRequest.Builder
- All Implemented Interfaces:
SearchDataItemsRequestOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- SearchDataItemsRequest
public static final class SearchDataItemsRequest.Builder
extends com.google.protobuf.GeneratedMessage.Builder<SearchDataItemsRequest.Builder>
implements SearchDataItemsRequestOrBuilder
Request message for [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems].Protobuf type
google.cloud.aiplatform.v1.SearchDataItemsRequest-
Method Summary
Modifier and TypeMethodDescriptionaddAllAnnotationFilters(Iterable<String> values) An expression that specifies what Annotations will be returned per DataItem.addAnnotationFilters(String value) An expression that specifies what Annotations will be returned per DataItem.addAnnotationFiltersBytes(com.google.protobuf.ByteString value) An expression that specifies what Annotations will be returned per DataItem.build()clear()An expression that specifies what Annotations will be returned per DataItem.Deprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.annotations_filter is deprecated.If set, only up to this many of Annotations will be returned per DataItemView.An expression for filtering the DataItem that will be returnedThe resource name of a DataLabelingJob.Required.Mask specifying which fields of [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.Deprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.order_by is deprecated.Expression that allows ranking results based on annotation's property.A comma-separated list of data item fields to order by, sorted in ascending order.Requested page size.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.Deprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.saved_query is deprecated.getAnnotationFilters(int index) An expression that specifies what Annotations will be returned per DataItem.com.google.protobuf.ByteStringgetAnnotationFiltersBytes(int index) An expression that specifies what Annotations will be returned per DataItem.intAn expression that specifies what Annotations will be returned per DataItem.com.google.protobuf.ProtocolStringListAn expression that specifies what Annotations will be returned per DataItem.Deprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.annotations_filter is deprecated.com.google.protobuf.ByteStringDeprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.annotations_filter is deprecated.intIf set, only up to this many of Annotations will be returned per DataItemView.An expression for filtering the DataItem that will be returnedcom.google.protobuf.ByteStringAn expression for filtering the DataItem that will be returnedThe resource name of a DataLabelingJob.com.google.protobuf.ByteStringThe resource name of a DataLabelingJob.Required.com.google.protobuf.ByteStringRequired.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.Descriptorcom.google.protobuf.FieldMaskMask specifying which fields of [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.com.google.protobuf.FieldMask.BuilderMask specifying which fields of [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.com.google.protobuf.FieldMaskOrBuilderMask specifying which fields of [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.Deprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.order_by is deprecated.Expression that allows ranking results based on annotation's property.Expression that allows ranking results based on annotation's property.Expression that allows ranking results based on annotation's property.com.google.protobuf.ByteStringDeprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.order_by is deprecated.A comma-separated list of data item fields to order by, sorted in ascending order.com.google.protobuf.ByteStringA comma-separated list of data item fields to order by, sorted in ascending order.intRequested page size.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.com.google.protobuf.ByteStringA 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.Deprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.saved_query is deprecated.com.google.protobuf.ByteStringDeprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.saved_query is deprecated.booleanMask specifying which fields of [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.booleanExpression that allows ranking results based on annotation's property.booleanA comma-separated list of data item fields to order by, sorted in ascending order.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanmergeFieldMask(com.google.protobuf.FieldMask value) Mask specifying which fields of [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.mergeFrom(SearchDataItemsRequest other) mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) Expression that allows ranking results based on annotation's property.setAnnotationFilters(int index, String value) An expression that specifies what Annotations will be returned per DataItem.setAnnotationsFilter(String value) Deprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.annotations_filter is deprecated.setAnnotationsFilterBytes(com.google.protobuf.ByteString value) Deprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.annotations_filter is deprecated.setAnnotationsLimit(int value) If set, only up to this many of Annotations will be returned per DataItemView.setDataItemFilter(String value) An expression for filtering the DataItem that will be returnedsetDataItemFilterBytes(com.google.protobuf.ByteString value) An expression for filtering the DataItem that will be returnedsetDataLabelingJob(String value) The resource name of a DataLabelingJob.setDataLabelingJobBytes(com.google.protobuf.ByteString value) The resource name of a DataLabelingJob.setDataset(String value) Required.setDatasetBytes(com.google.protobuf.ByteString value) Required.setFieldMask(com.google.protobuf.FieldMask value) Mask specifying which fields of [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.setFieldMask(com.google.protobuf.FieldMask.Builder builderForValue) Mask specifying which fields of [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.setOrderBy(String value) Deprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.order_by is deprecated.Expression that allows ranking results based on annotation's property.setOrderByAnnotation(SearchDataItemsRequest.OrderByAnnotation.Builder builderForValue) Expression that allows ranking results based on annotation's property.setOrderByBytes(com.google.protobuf.ByteString value) Deprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.order_by is deprecated.setOrderByDataItem(String value) A comma-separated list of data item fields to order by, sorted in ascending order.setOrderByDataItemBytes(com.google.protobuf.ByteString value) A comma-separated list of data item fields to order by, sorted in ascending order.setPageSize(int value) Requested page size.setPageToken(String value) A token identifying a page of results for the server to return Typically obtained via [SearchDataItemsResponse.next_page_token][google.cloud.aiplatform.v1.SearchDataItemsResponse.next_page_token] of the previous [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems] call.setPageTokenBytes(com.google.protobuf.ByteString value) A token identifying a page of results for the server to return Typically obtained via [SearchDataItemsResponse.next_page_token][google.cloud.aiplatform.v1.SearchDataItemsResponse.next_page_token] of the previous [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems] call.setSavedQuery(String value) Deprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.saved_query is deprecated.setSavedQueryBytes(com.google.protobuf.ByteString value) Deprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.saved_query is deprecated.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage.Builder<SearchDataItemsRequest.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessage.Builder<SearchDataItemsRequest.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage.Builder<SearchDataItemsRequest.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<SearchDataItemsRequest.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage.Builder<SearchDataItemsRequest.Builder>
-
mergeFrom
public SearchDataItemsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<SearchDataItemsRequest.Builder>- Throws:
IOException
-
getOrderCase
- Specified by:
getOrderCasein interfaceSearchDataItemsRequestOrBuilder
-
clearOrder
-
hasOrderByDataItem
public boolean hasOrderByDataItem()A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
string order_by_data_item = 12;- Specified by:
hasOrderByDataItemin interfaceSearchDataItemsRequestOrBuilder- Returns:
- Whether the orderByDataItem field is set.
-
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:
getOrderByDataItemin interfaceSearchDataItemsRequestOrBuilder- 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:
getOrderByDataItemBytesin interfaceSearchDataItemsRequestOrBuilder- Returns:
- The bytes for orderByDataItem.
-
setOrderByDataItem
A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
string order_by_data_item = 12;- Parameters:
value- The orderByDataItem to set.- Returns:
- This builder for chaining.
-
clearOrderByDataItem
A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
string order_by_data_item = 12;- Returns:
- This builder for chaining.
-
setOrderByDataItemBytes
A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
string order_by_data_item = 12;- Parameters:
value- The bytes for orderByDataItem to set.- Returns:
- This builder for chaining.
-
hasOrderByAnnotation
public boolean hasOrderByAnnotation()Expression that allows ranking results based on annotation's property.
.google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;- Specified by:
hasOrderByAnnotationin interfaceSearchDataItemsRequestOrBuilder- Returns:
- Whether the orderByAnnotation field is set.
-
getOrderByAnnotation
Expression that allows ranking results based on annotation's property.
.google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;- Specified by:
getOrderByAnnotationin interfaceSearchDataItemsRequestOrBuilder- Returns:
- The orderByAnnotation.
-
setOrderByAnnotation
public SearchDataItemsRequest.Builder setOrderByAnnotation(SearchDataItemsRequest.OrderByAnnotation value) Expression that allows ranking results based on annotation's property.
.google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13; -
setOrderByAnnotation
public SearchDataItemsRequest.Builder setOrderByAnnotation(SearchDataItemsRequest.OrderByAnnotation.Builder builderForValue) Expression that allows ranking results based on annotation's property.
.google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13; -
mergeOrderByAnnotation
public SearchDataItemsRequest.Builder mergeOrderByAnnotation(SearchDataItemsRequest.OrderByAnnotation value) Expression that allows ranking results based on annotation's property.
.google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13; -
clearOrderByAnnotation
Expression that allows ranking results based on annotation's property.
.google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13; -
getOrderByAnnotationBuilder
Expression that allows ranking results based on annotation's property.
.google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13; -
getOrderByAnnotationOrBuilder
Expression that allows ranking results based on annotation's property.
.google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;- Specified by:
getOrderByAnnotationOrBuilderin interfaceSearchDataItemsRequestOrBuilder
-
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:
getDatasetin interfaceSearchDataItemsRequestOrBuilder- 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:
getDatasetBytesin interfaceSearchDataItemsRequestOrBuilder- Returns:
- The bytes for dataset.
-
setDataset
Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project}/locations/{location}/datasets/{dataset}`string dataset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }- Parameters:
value- The dataset to set.- Returns:
- This builder for chaining.
-
clearDataset
Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project}/locations/{location}/datasets/{dataset}`string dataset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }- Returns:
- This builder for chaining.
-
setDatasetBytes
Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project}/locations/{location}/datasets/{dataset}`string dataset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }- Parameters:
value- The bytes for dataset to set.- Returns:
- This builder for chaining.
-
getSavedQuery
Deprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.saved_query is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=682The 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:
getSavedQueryin interfaceSearchDataItemsRequestOrBuilder- Returns:
- The savedQuery.
-
getSavedQueryBytes
Deprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.saved_query is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=682The 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:
getSavedQueryBytesin interfaceSearchDataItemsRequestOrBuilder- Returns:
- The bytes for savedQuery.
-
setSavedQuery
Deprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.saved_query is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=682The resource name of a SavedQuery(annotation set in UI). Format: `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}` All of the search will be done in the context of this SavedQuery.string saved_query = 2 [deprecated = true, (.google.api.resource_reference) = { ... }- Parameters:
value- The savedQuery to set.- Returns:
- This builder for chaining.
-
clearSavedQuery
Deprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.saved_query is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=682The resource name of a SavedQuery(annotation set in UI). Format: `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}` All of the search will be done in the context of this SavedQuery.string saved_query = 2 [deprecated = true, (.google.api.resource_reference) = { ... }- Returns:
- This builder for chaining.
-
setSavedQueryBytes
@Deprecated public SearchDataItemsRequest.Builder setSavedQueryBytes(com.google.protobuf.ByteString value) Deprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.saved_query is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=682The resource name of a SavedQuery(annotation set in UI). Format: `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}` All of the search will be done in the context of this SavedQuery.string saved_query = 2 [deprecated = true, (.google.api.resource_reference) = { ... }- Parameters:
value- The bytes for savedQuery to set.- Returns:
- This builder for chaining.
-
getDataLabelingJob
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:
getDataLabelingJobin interfaceSearchDataItemsRequestOrBuilder- 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:
getDataLabelingJobBytesin interfaceSearchDataItemsRequestOrBuilder- Returns:
- The bytes for dataLabelingJob.
-
setDataLabelingJob
The resource name of a DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` If this field is set, all of the search will be done in the context of this DataLabelingJob.string data_labeling_job = 3;- Parameters:
value- The dataLabelingJob to set.- Returns:
- This builder for chaining.
-
clearDataLabelingJob
The resource name of a DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` If this field is set, all of the search will be done in the context of this DataLabelingJob.string data_labeling_job = 3;- Returns:
- This builder for chaining.
-
setDataLabelingJobBytes
The resource name of a DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` If this field is set, all of the search will be done in the context of this DataLabelingJob.string data_labeling_job = 3;- Parameters:
value- The bytes for dataLabelingJob to set.- Returns:
- This builder for chaining.
-
getDataItemFilter
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:
getDataItemFilterin interfaceSearchDataItemsRequestOrBuilder- 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:
getDataItemFilterBytesin interfaceSearchDataItemsRequestOrBuilder- Returns:
- The bytes for dataItemFilter.
-
setDataItemFilter
An expression for filtering the DataItem that will be returned. * `data_item_id` - for = or !=. * `labeled` - for = or !=. * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that have at least one annotation with annotation_spec_id = `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. For example: * `data_item=1` * `has_annotation(5)`
string data_item_filter = 4;- Parameters:
value- The dataItemFilter to set.- Returns:
- This builder for chaining.
-
clearDataItemFilter
An expression for filtering the DataItem that will be returned. * `data_item_id` - for = or !=. * `labeled` - for = or !=. * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that have at least one annotation with annotation_spec_id = `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. For example: * `data_item=1` * `has_annotation(5)`
string data_item_filter = 4;- Returns:
- This builder for chaining.
-
setDataItemFilterBytes
An expression for filtering the DataItem that will be returned. * `data_item_id` - for = or !=. * `labeled` - for = or !=. * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that have at least one annotation with annotation_spec_id = `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. For example: * `data_item=1` * `has_annotation(5)`
string data_item_filter = 4;- Parameters:
value- The bytes for dataItemFilter to set.- Returns:
- This builder for chaining.
-
getAnnotationsFilter
Deprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.annotations_filter is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=713An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=.
string annotations_filter = 5 [deprecated = true];- Specified by:
getAnnotationsFilterin interfaceSearchDataItemsRequestOrBuilder- Returns:
- The annotationsFilter.
-
getAnnotationsFilterBytes
Deprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.annotations_filter is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=713An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=.
string annotations_filter = 5 [deprecated = true];- Specified by:
getAnnotationsFilterBytesin interfaceSearchDataItemsRequestOrBuilder- Returns:
- The bytes for annotationsFilter.
-
setAnnotationsFilter
Deprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.annotations_filter is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=713An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=.
string annotations_filter = 5 [deprecated = true];- Parameters:
value- The annotationsFilter to set.- Returns:
- This builder for chaining.
-
clearAnnotationsFilter
Deprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.annotations_filter is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=713An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=.
string annotations_filter = 5 [deprecated = true];- Returns:
- This builder for chaining.
-
setAnnotationsFilterBytes
@Deprecated public SearchDataItemsRequest.Builder setAnnotationsFilterBytes(com.google.protobuf.ByteString value) Deprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.annotations_filter is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=713An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=.
string annotations_filter = 5 [deprecated = true];- Parameters:
value- The bytes for annotationsFilter to set.- Returns:
- This builder for chaining.
-
getAnnotationFiltersList
public com.google.protobuf.ProtocolStringList getAnnotationFiltersList()An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * `annotation_spec_id` - for = or !=. Must specify `saved_query_id=` - saved query id that annotations should belong to.
repeated string annotation_filters = 11;- Specified by:
getAnnotationFiltersListin interfaceSearchDataItemsRequestOrBuilder- 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:
getAnnotationFiltersCountin interfaceSearchDataItemsRequestOrBuilder- Returns:
- The count of annotationFilters.
-
getAnnotationFilters
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:
getAnnotationFiltersin interfaceSearchDataItemsRequestOrBuilder- 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:
getAnnotationFiltersBytesin interfaceSearchDataItemsRequestOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the annotationFilters at the given index.
-
setAnnotationFilters
An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * `annotation_spec_id` - for = or !=. Must specify `saved_query_id=` - saved query id that annotations should belong to.
repeated string annotation_filters = 11;- Parameters:
index- The index to set the value at.value- The annotationFilters to set.- Returns:
- This builder for chaining.
-
addAnnotationFilters
An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * `annotation_spec_id` - for = or !=. Must specify `saved_query_id=` - saved query id that annotations should belong to.
repeated string annotation_filters = 11;- Parameters:
value- The annotationFilters to add.- Returns:
- This builder for chaining.
-
addAllAnnotationFilters
An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * `annotation_spec_id` - for = or !=. Must specify `saved_query_id=` - saved query id that annotations should belong to.
repeated string annotation_filters = 11;- Parameters:
values- The annotationFilters to add.- Returns:
- This builder for chaining.
-
clearAnnotationFilters
An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * `annotation_spec_id` - for = or !=. Must specify `saved_query_id=` - saved query id that annotations should belong to.
repeated string annotation_filters = 11;- Returns:
- This builder for chaining.
-
addAnnotationFiltersBytes
public SearchDataItemsRequest.Builder addAnnotationFiltersBytes(com.google.protobuf.ByteString value) An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * `annotation_spec_id` - for = or !=. Must specify `saved_query_id=` - saved query id that annotations should belong to.
repeated string annotation_filters = 11;- Parameters:
value- The bytes of the annotationFilters to add.- Returns:
- This builder for chaining.
-
hasFieldMask
public boolean hasFieldMask()Mask specifying which fields of [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.
.google.protobuf.FieldMask field_mask = 6;- Specified by:
hasFieldMaskin interfaceSearchDataItemsRequestOrBuilder- 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:
getFieldMaskin interfaceSearchDataItemsRequestOrBuilder- Returns:
- The fieldMask.
-
setFieldMask
Mask specifying which fields of [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.
.google.protobuf.FieldMask field_mask = 6; -
setFieldMask
public SearchDataItemsRequest.Builder setFieldMask(com.google.protobuf.FieldMask.Builder builderForValue) Mask specifying which fields of [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.
.google.protobuf.FieldMask field_mask = 6; -
mergeFieldMask
Mask specifying which fields of [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.
.google.protobuf.FieldMask field_mask = 6; -
clearFieldMask
Mask specifying which fields of [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.
.google.protobuf.FieldMask field_mask = 6; -
getFieldMaskBuilder
public com.google.protobuf.FieldMask.Builder getFieldMaskBuilder()Mask specifying which fields of [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.
.google.protobuf.FieldMask field_mask = 6; -
getFieldMaskOrBuilder
public com.google.protobuf.FieldMaskOrBuilder getFieldMaskOrBuilder()Mask specifying which fields of [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.
.google.protobuf.FieldMask field_mask = 6;- Specified by:
getFieldMaskOrBuilderin interfaceSearchDataItemsRequestOrBuilder
-
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:
getAnnotationsLimitin interfaceSearchDataItemsRequestOrBuilder- Returns:
- The annotationsLimit.
-
setAnnotationsLimit
If set, only up to this many of Annotations will be returned per DataItemView. The maximum value is 1000. If not set, the maximum value will be used.
int32 annotations_limit = 7;- Parameters:
value- The annotationsLimit to set.- Returns:
- This builder for chaining.
-
clearAnnotationsLimit
If set, only up to this many of Annotations will be returned per DataItemView. The maximum value is 1000. If not set, the maximum value will be used.
int32 annotations_limit = 7;- Returns:
- This builder for chaining.
-
getPageSize
public int getPageSize()Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.
int32 page_size = 8;- Specified by:
getPageSizein interfaceSearchDataItemsRequestOrBuilder- Returns:
- The pageSize.
-
setPageSize
Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.
int32 page_size = 8;- Parameters:
value- The pageSize to set.- Returns:
- This builder for chaining.
-
clearPageSize
Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.
int32 page_size = 8;- Returns:
- This builder for chaining.
-
getOrderBy
Deprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.order_by is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=737A 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:
getOrderByin interfaceSearchDataItemsRequestOrBuilder- Returns:
- The orderBy.
-
getOrderByBytes
Deprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.order_by is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=737A 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:
getOrderByBytesin interfaceSearchDataItemsRequestOrBuilder- Returns:
- The bytes for orderBy.
-
setOrderBy
Deprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.order_by is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=737A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
string order_by = 9 [deprecated = true];- Parameters:
value- The orderBy to set.- Returns:
- This builder for chaining.
-
clearOrderBy
Deprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.order_by is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=737A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
string order_by = 9 [deprecated = true];- Returns:
- This builder for chaining.
-
setOrderByBytes
@Deprecated public SearchDataItemsRequest.Builder setOrderByBytes(com.google.protobuf.ByteString value) Deprecated.google.cloud.aiplatform.v1.SearchDataItemsRequest.order_by is deprecated. See google/cloud/aiplatform/v1/dataset_service.proto;l=737A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
string order_by = 9 [deprecated = true];- Parameters:
value- The bytes for orderBy to set.- Returns:
- This builder for chaining.
-
getPageToken
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:
getPageTokenin interfaceSearchDataItemsRequestOrBuilder- 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:
getPageTokenBytesin interfaceSearchDataItemsRequestOrBuilder- Returns:
- The bytes for pageToken.
-
setPageToken
A token identifying a page of results for the server to return Typically obtained via [SearchDataItemsResponse.next_page_token][google.cloud.aiplatform.v1.SearchDataItemsResponse.next_page_token] of the previous [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems] call.
string page_token = 10;- Parameters:
value- The pageToken to set.- Returns:
- This builder for chaining.
-
clearPageToken
A token identifying a page of results for the server to return Typically obtained via [SearchDataItemsResponse.next_page_token][google.cloud.aiplatform.v1.SearchDataItemsResponse.next_page_token] of the previous [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems] call.
string page_token = 10;- Returns:
- This builder for chaining.
-
setPageTokenBytes
A token identifying a page of results for the server to return Typically obtained via [SearchDataItemsResponse.next_page_token][google.cloud.aiplatform.v1.SearchDataItemsResponse.next_page_token] of the previous [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems] call.
string page_token = 10;- Parameters:
value- The bytes for pageToken to set.- Returns:
- This builder for chaining.
-