Class SearchDataItemsRequest (3.45.0)

public final class SearchDataItemsRequest extends GeneratedMessageV3 implements SearchDataItemsRequestOrBuilder

Request message for DatasetService.SearchDataItems.

Protobuf type google.cloud.aiplatform.v1beta1.SearchDataItemsRequest

Static Fields

ANNOTATIONS_FILTER_FIELD_NUMBER

public static final int ANNOTATIONS_FILTER_FIELD_NUMBER
Field Value
Type Description
int

ANNOTATIONS_LIMIT_FIELD_NUMBER

public static final int ANNOTATIONS_LIMIT_FIELD_NUMBER
Field Value
Type Description
int

ANNOTATION_FILTERS_FIELD_NUMBER

public static final int ANNOTATION_FILTERS_FIELD_NUMBER
Field Value
Type Description
int

DATASET_FIELD_NUMBER

public static final int DATASET_FIELD_NUMBER
Field Value
Type Description
int

DATA_ITEM_FILTER_FIELD_NUMBER

public static final int DATA_ITEM_FILTER_FIELD_NUMBER
Field Value
Type Description
int

DATA_LABELING_JOB_FIELD_NUMBER

public static final int DATA_LABELING_JOB_FIELD_NUMBER
Field Value
Type Description
int

FIELD_MASK_FIELD_NUMBER

public static final int FIELD_MASK_FIELD_NUMBER
Field Value
Type Description
int

ORDER_BY_ANNOTATION_FIELD_NUMBER

public static final int ORDER_BY_ANNOTATION_FIELD_NUMBER
Field Value
Type Description
int

ORDER_BY_DATA_ITEM_FIELD_NUMBER

public static final int ORDER_BY_DATA_ITEM_FIELD_NUMBER
Field Value
Type Description
int

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

SAVED_QUERY_FIELD_NUMBER

public static final int SAVED_QUERY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchDataItemsRequest getDefaultInstance()
Returns
Type Description
SearchDataItemsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SearchDataItemsRequest.Builder newBuilder()
Returns
Type Description
SearchDataItemsRequest.Builder

newBuilder(SearchDataItemsRequest prototype)

public static SearchDataItemsRequest.Builder newBuilder(SearchDataItemsRequest prototype)
Parameter
Name Description
prototype SearchDataItemsRequest
Returns
Type Description
SearchDataItemsRequest.Builder

parseDelimitedFrom(InputStream input)

public static SearchDataItemsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchDataItemsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchDataItemsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchDataItemsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchDataItemsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchDataItemsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchDataItemsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchDataItemsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchDataItemsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchDataItemsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchDataItemsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchDataItemsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchDataItemsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchDataItemsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchDataItemsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchDataItemsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchDataItemsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchDataItemsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchDataItemsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchDataItemsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchDataItemsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchDataItemsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchDataItemsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchDataItemsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchDataItemsRequest> parser()
Returns
Type Description
Parser<SearchDataItemsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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=685

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=685

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

getFieldMask()

public FieldMask getFieldMask()

Mask specifying which fields of DataItemView to read.

.google.protobuf.FieldMask field_mask = 6;

Returns
Type Description
FieldMask

The fieldMask.

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=709

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.

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=709

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.

getParserForType()

public Parser<SearchDataItemsRequest> getParserForType()
Returns
Type Description
Parser<SearchDataItemsRequest>
Overrides

getSavedQuery() (deprecated)

public String getSavedQuery()

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

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=654

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SearchDataItemsRequest.Builder newBuilderForType()
Returns
Type Description
SearchDataItemsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchDataItemsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchDataItemsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SearchDataItemsRequest.Builder toBuilder()
Returns
Type Description
SearchDataItemsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException