Class SearchDataItemsRequest.Builder (3.21.0)

Version 3.21.0

• 3.52.0 (latest)
• 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 static final class SearchDataItemsRequest.Builder extends GeneratedMessageV3.Builder<SearchDataItemsRequest.Builder> implements SearchDataItemsRequestOrBuilder

Request message for DatasetService.SearchDataItems.

Protobuf type google.cloud.aiplatform.v1beta1.SearchDataItemsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchDataItemsRequest.Builder

Implements

SearchDataItemsRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllAnnotationFilters(Iterable<String> values)

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;

Parameter
Name	Description
values	Iterable<String> The annotationFilters to add.

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

addAnnotationFilters(String value)

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;

Parameter
Name	Description
value	String The annotationFilters to add.

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

addAnnotationFiltersBytes(ByteString value)

public SearchDataItemsRequest.Builder addAnnotationFiltersBytes(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;

Parameter
Name	Description
value	ByteString The bytes of the annotationFilters to add.

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchDataItemsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
SearchDataItemsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public SearchDataItemsRequest build()

Returns
Type	Description
SearchDataItemsRequest

buildPartial()

public SearchDataItemsRequest buildPartial()

Returns
Type	Description
SearchDataItemsRequest

clear()

public SearchDataItemsRequest.Builder clear()

Returns
Type	Description
SearchDataItemsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAnnotationFilters()

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;

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

clearAnnotationsFilter() (deprecated)

public SearchDataItemsRequest.Builder clearAnnotationsFilter()

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

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
SearchDataItemsRequest.Builder	This builder for chaining.

clearAnnotationsLimit()

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;

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

clearDataItemFilter()

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;

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

clearDataLabelingJob()

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;

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

clearDataset()

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

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SearchDataItemsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
SearchDataItemsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFieldMask()

public SearchDataItemsRequest.Builder clearFieldMask()

Mask specifying which fields of DataItemView to read.

.google.protobuf.FieldMask field_mask = 6;

Returns
Type	Description
SearchDataItemsRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchDataItemsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
SearchDataItemsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearOrder()

public SearchDataItemsRequest.Builder clearOrder()

Returns
Type	Description
SearchDataItemsRequest.Builder

clearOrderBy() (deprecated)

public SearchDataItemsRequest.Builder clearOrderBy()

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

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
SearchDataItemsRequest.Builder	This builder for chaining.

clearOrderByAnnotation()

public SearchDataItemsRequest.Builder clearOrderByAnnotation()

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

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

Returns
Type	Description
SearchDataItemsRequest.Builder

clearOrderByDataItem()

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;

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

clearPageSize()

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;

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

clearPageToken()

public SearchDataItemsRequest.Builder clearPageToken()

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
SearchDataItemsRequest.Builder	This builder for chaining.

clearSavedQuery() (deprecated)

public SearchDataItemsRequest.Builder clearSavedQuery()

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

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
SearchDataItemsRequest.Builder	This builder for chaining.

clone()

public SearchDataItemsRequest.Builder clone()

Returns
Type	Description
SearchDataItemsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAnnotationFilters(int index)

public String getAnnotationFilters(int index)

An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned.

• annotation_spec_id - for = or !=. Must specify saved_query_id= - saved query id that annotations should belong to.

repeated string annotation_filters = 11;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The annotationFilters at the given index.

getAnnotationFiltersBytes(int index)

public 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;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the annotationFilters at the given index.

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;

Returns
Type	Description
int	The count of annotationFilters.

getAnnotationFiltersList()

public 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;

Returns
Type	Description
ProtocolStringList	A list containing the annotationFilters.

getAnnotationsFilter() (deprecated)

public String getAnnotationsFilter()

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

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 ByteString getAnnotationsFilterBytes()

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

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 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 String getDataItemFilter()

An expression for filtering the DataItem that will be returned.

• data_item_id - for = or !=.
• labeled - for = or !=.

• has_annotation(ANNOTATION_SPEC_ID) - true only for DataItem that have at least one annotation with annotation_spec_id = ANNOTATION_SPEC_ID in the context of SavedQuery or DataLabelingJob.

  For example:

  • data_item=1
  • has_annotation(5)

string data_item_filter = 4;

Returns
Type	Description
String	The dataItemFilter.

getDataItemFilterBytes()

public ByteString getDataItemFilterBytes()

An expression for filtering the DataItem that will be returned.

• data_item_id - for = or !=.
• labeled - for = or !=.

• has_annotation(ANNOTATION_SPEC_ID) - true only for DataItem that have at least one annotation with annotation_spec_id = ANNOTATION_SPEC_ID in the context of SavedQuery or DataLabelingJob.

  For example:

  • data_item=1
  • has_annotation(5)

string data_item_filter = 4;

Returns
Type	Description
ByteString	The bytes for dataItemFilter.

getDataLabelingJob()

public String getDataLabelingJob()

The resource name of a DataLabelingJob. Format: projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job} If this field is set, all of the search will be done in the context of this DataLabelingJob.

string data_labeling_job = 3;

Returns
Type	Description
String	The dataLabelingJob.

getDataLabelingJobBytes()

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

getDefaultInstanceForType()

public SearchDataItemsRequest getDefaultInstanceForType()

Returns
Type	Description
SearchDataItemsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFieldMask()

public FieldMask getFieldMask()

Mask specifying which fields of DataItemView to read.

.google.protobuf.FieldMask field_mask = 6;

Returns
Type	Description
FieldMask	The fieldMask.

getFieldMaskBuilder()

public FieldMask.Builder getFieldMaskBuilder()

Mask specifying which fields of DataItemView to read.

.google.protobuf.FieldMask field_mask = 6;

Returns
Type	Description
Builder

getFieldMaskOrBuilder()

public FieldMaskOrBuilder getFieldMaskOrBuilder()

Mask specifying which fields of DataItemView to read.

.google.protobuf.FieldMask field_mask = 6;

Returns
Type	Description
FieldMaskOrBuilder

getOrderBy() (deprecated)

public String getOrderBy()

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

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 SearchDataItemsRequest.OrderByAnnotation getOrderByAnnotation()

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

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

Returns
Type	Description
SearchDataItemsRequest.OrderByAnnotation	The orderByAnnotation.

getOrderByAnnotationBuilder()

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;

Returns
Type	Description
SearchDataItemsRequest.OrderByAnnotation.Builder

getOrderByAnnotationOrBuilder()

public SearchDataItemsRequest.OrderByAnnotationOrBuilder getOrderByAnnotationOrBuilder()

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

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

Returns
Type	Description
SearchDataItemsRequest.OrderByAnnotationOrBuilder

getOrderByBytes() (deprecated)

public ByteString getOrderByBytes()

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

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 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 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 SearchDataItemsRequest.OrderCase getOrderCase()

Returns
Type	Description
SearchDataItemsRequest.OrderCase

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;

Returns
Type	Description
int	The pageSize.

getPageToken()

public 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 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 String getSavedQuery()

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

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 ByteString getSavedQueryBytes()

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

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 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 boolean hasOrderByAnnotation()

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

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

Returns
Type	Description
boolean	Whether the orderByAnnotation field is set.

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;

Returns
Type	Description
boolean	Whether the orderByDataItem field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFieldMask(FieldMask value)

public SearchDataItemsRequest.Builder mergeFieldMask(FieldMask value)

Mask specifying which fields of DataItemView to read.

.google.protobuf.FieldMask field_mask = 6;

Parameter
Name	Description
value	FieldMask

Returns
Type	Description
SearchDataItemsRequest.Builder

mergeFrom(SearchDataItemsRequest other)

public SearchDataItemsRequest.Builder mergeFrom(SearchDataItemsRequest other)

Parameter
Name	Description
other	SearchDataItemsRequest

Returns
Type	Description
SearchDataItemsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchDataItemsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchDataItemsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public SearchDataItemsRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
SearchDataItemsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeOrderByAnnotation(SearchDataItemsRequest.OrderByAnnotation value)

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;

Parameter
Name	Description
value	SearchDataItemsRequest.OrderByAnnotation

Returns
Type	Description
SearchDataItemsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchDataItemsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SearchDataItemsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setAnnotationFilters(int index, String value)

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;

Parameters
Name	Description
index	int The index to set the value at.
value	String The annotationFilters to set.

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

setAnnotationsFilter(String value) (deprecated)

public SearchDataItemsRequest.Builder setAnnotationsFilter(String value)

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

An expression for filtering the Annotations that will be returned per DataItem.

• annotation_spec_id - for = or !=.

string annotations_filter = 5 [deprecated = true];

Parameter
Name	Description
value	String The annotationsFilter to set.

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

setAnnotationsFilterBytes(ByteString value) (deprecated)

public SearchDataItemsRequest.Builder setAnnotationsFilterBytes(ByteString value)

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

An expression for filtering the Annotations that will be returned per DataItem.

• annotation_spec_id - for = or !=.

string annotations_filter = 5 [deprecated = true];

Parameter
Name	Description
value	ByteString The bytes for annotationsFilter to set.

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

setAnnotationsLimit(int value)

public 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;

Parameter
Name	Description
value	int The annotationsLimit to set.

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

setDataItemFilter(String value)

public 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;

Parameter
Name	Description
value	String The dataItemFilter to set.

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

setDataItemFilterBytes(ByteString value)

public SearchDataItemsRequest.Builder setDataItemFilterBytes(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;

Parameter
Name	Description
value	ByteString The bytes for dataItemFilter to set.

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

setDataLabelingJob(String value)

public 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;

Parameter
Name	Description
value	String The dataLabelingJob to set.

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

setDataLabelingJobBytes(ByteString value)

public SearchDataItemsRequest.Builder setDataLabelingJobBytes(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;

Parameter
Name	Description
value	ByteString The bytes for dataLabelingJob to set.

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

setDataset(String value)

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

Parameter
Name	Description
value	String The dataset to set.

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

setDatasetBytes(ByteString value)

public SearchDataItemsRequest.Builder setDatasetBytes(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) = { ... }

Parameter
Name	Description
value	ByteString The bytes for dataset to set.

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SearchDataItemsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
SearchDataItemsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFieldMask(FieldMask value)

public SearchDataItemsRequest.Builder setFieldMask(FieldMask value)

Mask specifying which fields of DataItemView to read.

.google.protobuf.FieldMask field_mask = 6;

Parameter
Name	Description
value	FieldMask

Returns
Type	Description
SearchDataItemsRequest.Builder

setFieldMask(FieldMask.Builder builderForValue)

public SearchDataItemsRequest.Builder setFieldMask(FieldMask.Builder builderForValue)

Mask specifying which fields of DataItemView to read.

.google.protobuf.FieldMask field_mask = 6;

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
SearchDataItemsRequest.Builder

setOrderBy(String value) (deprecated)

public SearchDataItemsRequest.Builder setOrderBy(String value)

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

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];

Parameter
Name	Description
value	String The orderBy to set.

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

setOrderByAnnotation(SearchDataItemsRequest.OrderByAnnotation value)

public 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;

Parameter
Name	Description
value	SearchDataItemsRequest.OrderByAnnotation

Returns
Type	Description
SearchDataItemsRequest.Builder

setOrderByAnnotation(SearchDataItemsRequest.OrderByAnnotation.Builder builderForValue)

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;

Parameter
Name	Description
builderForValue	SearchDataItemsRequest.OrderByAnnotation.Builder

Returns
Type	Description
SearchDataItemsRequest.Builder

setOrderByBytes(ByteString value) (deprecated)

public SearchDataItemsRequest.Builder setOrderByBytes(ByteString value)

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

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];

Parameter
Name	Description
value	ByteString The bytes for orderBy to set.

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

setOrderByDataItem(String value)

public 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;

Parameter
Name	Description
value	String The orderByDataItem to set.

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

setOrderByDataItemBytes(ByteString value)

public SearchDataItemsRequest.Builder setOrderByDataItemBytes(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;

Parameter
Name	Description
value	ByteString The bytes for orderByDataItem to set.

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

setPageSize(int value)

public 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;

Parameter
Name	Description
value	int The pageSize to set.

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

setPageToken(String value)

public SearchDataItemsRequest.Builder setPageToken(String value)

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;

Parameter
Name	Description
value	String The pageToken to set.

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

setPageTokenBytes(ByteString value)

public SearchDataItemsRequest.Builder setPageTokenBytes(ByteString value)

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;

Parameter
Name	Description
value	ByteString The bytes for pageToken to set.

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchDataItemsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
SearchDataItemsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSavedQuery(String value) (deprecated)

public SearchDataItemsRequest.Builder setSavedQuery(String value)

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

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

Parameter
Name	Description
value	String The savedQuery to set.

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

setSavedQueryBytes(ByteString value) (deprecated)

public SearchDataItemsRequest.Builder setSavedQueryBytes(ByteString value)

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

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

Parameter
Name	Description
value	ByteString The bytes for savedQuery to set.

Returns
Type	Description
SearchDataItemsRequest.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchDataItemsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SearchDataItemsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)