public final class SearchDataItemsRequest extends GeneratedMessageV3 implements SearchDataItemsRequestOrBuilder
Request message for
DatasetService.SearchDataItems.
Protobuf type google.cloud.aiplatform.v1.SearchDataItemsRequest
Static Fields
public static final int ANNOTATIONS_FILTER_FIELD_NUMBER
Field Value
public static final int ANNOTATIONS_LIMIT_FIELD_NUMBER
Field Value
public static final int ANNOTATION_FILTERS_FIELD_NUMBER
Field Value
public static final int DATASET_FIELD_NUMBER
Field Value
public static final int DATA_ITEM_FILTER_FIELD_NUMBER
Field Value
public static final int DATA_LABELING_JOB_FIELD_NUMBER
Field Value
public static final int FIELD_MASK_FIELD_NUMBER
Field Value
public static final int ORDER_BY_ANNOTATION_FIELD_NUMBER
Field Value
public static final int ORDER_BY_DATA_ITEM_FIELD_NUMBER
Field Value
public static final int ORDER_BY_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
public static final int SAVED_QUERY_FIELD_NUMBER
Field Value
Static Methods
public static SearchDataItemsRequest getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static SearchDataItemsRequest.Builder newBuilder()
Returns
public static SearchDataItemsRequest.Builder newBuilder(SearchDataItemsRequest prototype)
Parameter
Returns
public static SearchDataItemsRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static SearchDataItemsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SearchDataItemsRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
public static SearchDataItemsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SearchDataItemsRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static SearchDataItemsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SearchDataItemsRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static SearchDataItemsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SearchDataItemsRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static SearchDataItemsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SearchDataItemsRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static SearchDataItemsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<SearchDataItemsRequest> parser()
Returns
Methods
public boolean equals(Object obj)
Parameter
Returns
Overrides
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;
| Name | Description |
| index | int
The index of the element to return.
|
Returns
| Type | Description |
| String | The annotationFilters at the given 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;
| Name | Description |
| index | int
The index of the value to return.
|
Returns
| Type | Description |
| ByteString | The bytes of the annotationFilters at the given index.
|
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;
| Type | Description |
| int | The count of annotationFilters.
|
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;
public String getAnnotationsFilter()
Deprecated. google.cloud.aiplatform.v1.SearchDataItemsRequest.annotations_filter is deprecated.
See google/cloud/aiplatform/v1/dataset_service.proto;l=467
An expression for filtering the Annotations that will be returned per
DataItem.
annotation_spec_id - for = or !=.
string annotations_filter = 5 [deprecated = true];
| Type | Description |
| String | The annotationsFilter.
|
public ByteString getAnnotationsFilterBytes()
Deprecated. google.cloud.aiplatform.v1.SearchDataItemsRequest.annotations_filter is deprecated.
See google/cloud/aiplatform/v1/dataset_service.proto;l=467
An expression for filtering the Annotations that will be returned per
DataItem.
annotation_spec_id - for = or !=.
string annotations_filter = 5 [deprecated = true];
| Type | Description |
| ByteString | The bytes for annotationsFilter.
|
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;
| Type | Description |
| int | The annotationsLimit.
|
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=1has_annotation(5)
string data_item_filter = 4;
| Type | Description |
| String | The dataItemFilter.
|
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=1has_annotation(5)
string data_item_filter = 4;
| Type | Description |
| ByteString | The bytes for dataItemFilter.
|
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;
| Type | Description |
| String | The dataLabelingJob.
|
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;
| Type | Description |
| ByteString | The bytes for dataLabelingJob.
|
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) = { ... }
| Type | Description |
| String | The dataset.
|
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) = { ... }
public SearchDataItemsRequest getDefaultInstanceForType()
Returns
public FieldMask getFieldMask()
Mask specifying which fields of
DataItemView to read.
.google.protobuf.FieldMask field_mask = 6;
public FieldMaskOrBuilder getFieldMaskOrBuilder()
Mask specifying which fields of
DataItemView to read.
.google.protobuf.FieldMask field_mask = 6;
public String getOrderBy()
Deprecated. google.cloud.aiplatform.v1.SearchDataItemsRequest.order_by is deprecated. See
google/cloud/aiplatform/v1/dataset_service.proto;l=491
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];
| Type | Description |
| String | The orderBy.
|
public SearchDataItemsRequest.OrderByAnnotation getOrderByAnnotation()
Expression that allows ranking results based on annotation's property.
.google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;
public SearchDataItemsRequest.OrderByAnnotationOrBuilder getOrderByAnnotationOrBuilder()
Expression that allows ranking results based on annotation's property.
.google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;
public ByteString getOrderByBytes()
Deprecated. google.cloud.aiplatform.v1.SearchDataItemsRequest.order_by is deprecated. See
google/cloud/aiplatform/v1/dataset_service.proto;l=491
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];
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;
| Type | Description |
| String | The orderByDataItem.
|
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;
| Type | Description |
| ByteString | The bytes for orderByDataItem.
|
public SearchDataItemsRequest.OrderCase getOrderCase()
Returns
getPageSize()
Requested page size. Server may return fewer results than requested.
Default and maximum page size is 100.
int32 page_size = 8;
| 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;
| 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;
public Parser<SearchDataItemsRequest> getParserForType()
Returns
Overrides
public String getSavedQuery()
Deprecated. google.cloud.aiplatform.v1.SearchDataItemsRequest.saved_query is deprecated. See
google/cloud/aiplatform/v1/dataset_service.proto;l=436
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) = { ... }
| Type | Description |
| String | The savedQuery.
|
public ByteString getSavedQueryBytes()
Deprecated. google.cloud.aiplatform.v1.SearchDataItemsRequest.saved_query is deprecated. See
google/cloud/aiplatform/v1/dataset_service.proto;l=436
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) = { ... }
| Type | Description |
| ByteString | The bytes for savedQuery.
|
public int getSerializedSize()
Returns
Overrides
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
public boolean hasFieldMask()
Mask specifying which fields of
DataItemView to read.
.google.protobuf.FieldMask field_mask = 6;
| Type | Description |
| boolean | Whether the fieldMask field is set.
|
public boolean hasOrderByAnnotation()
Expression that allows ranking results based on annotation's property.
.google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;
| Type | Description |
| boolean | Whether the orderByAnnotation field is set.
|
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;
| Type | Description |
| boolean | Whether the orderByDataItem field is set.
|
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public SearchDataItemsRequest.Builder newBuilderForType()
Returns
protected SearchDataItemsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public SearchDataItemsRequest.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
