Google Cloud Ai Platform V1 Client - Class SearchDataItemsRequest (0.10.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class SearchDataItemsRequest.

Request message for DatasetService.SearchDataItems.

Generated from protobuf message google.cloud.aiplatform.v1.SearchDataItemsRequest

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ order_by_data_item`	`string` A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
`↳ order_by_annotation`	`Google\Cloud\AIPlatform\V1\SearchDataItemsRequest\OrderByAnnotation` Expression that allows ranking results based on annotation's property.
`↳ dataset`	`string` Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
`↳ saved_query`	`string` 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.
`↳ data_labeling_job`	`string` 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.
`↳ data_item_filter`	`string` 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)`
`↳ annotations_filter`	`string` An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=.
`↳ annotation_filters`	`array` 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.
`↳ field_mask`	`Google\Protobuf\FieldMask` Mask specifying which fields of DataItemView to read.
`↳ annotations_limit`	`int` 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.
`↳ page_size`	`int` Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.
`↳ order_by`	`string` A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
`↳ page_token`	`string` 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.

getOrderByDataItem

A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

Generated from protobuf field string order_by_data_item = 12;

Returns
Type	Description
`string`

hasOrderByDataItem

setOrderByDataItem

A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

Generated from protobuf field string order_by_data_item = 12;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOrderByAnnotation

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

Generated from protobuf field .google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\SearchDataItemsRequest\OrderByAnnotation\|null`

hasOrderByAnnotation

setOrderByAnnotation

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

Generated from protobuf field .google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation order_by_annotation = 13;

Parameter
Name	Description
`var`	`Google\Cloud\AIPlatform\V1\SearchDataItemsRequest\OrderByAnnotation`

Returns
Type	Description
`$this`

getDataset

Required. The resource name of the Dataset from which to search DataItems.

Format: projects/{project}/locations/{location}/datasets/{dataset}

Generated from protobuf field string dataset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
Type	Description
`string`

setDataset

Required. The resource name of the Dataset from which to search DataItems.

Format: projects/{project}/locations/{location}/datasets/{dataset}

Generated from protobuf field string dataset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSavedQuery

The resource name of a SavedQuery(annotation set in UI).

Format: projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query} All of the search will be done in the context of this SavedQuery.

Generated from protobuf field string saved_query = 2 [deprecated = true, (.google.api.resource_reference) = {

Returns
Type	Description
`string`

setSavedQuery

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.

Generated from protobuf field string saved_query = 2 [deprecated = true, (.google.api.resource_reference) = {

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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.

Generated from protobuf field string data_labeling_job = 3;

Returns
Type	Description
`string`

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.

Generated from protobuf field string data_labeling_job = 3;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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)

Generated from protobuf field string data_item_filter = 4;

Returns
Type	Description
`string`

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)

Generated from protobuf field string data_item_filter = 4;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAnnotationsFilter

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

annotation_spec_id - for = or !=.

Generated from protobuf field string annotations_filter = 5 [deprecated = true];

Returns
Type	Description
`string`

setAnnotationsFilter

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

annotation_spec_id - for = or !=.

Generated from protobuf field string annotations_filter = 5 [deprecated = true];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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.

Generated from protobuf field repeated string annotation_filters = 11;

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

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.

Generated from protobuf field repeated string annotation_filters = 11;

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getFieldMask

Mask specifying which fields of DataItemView to read.

Generated from protobuf field .google.protobuf.FieldMask field_mask = 6;

Returns
Type	Description
`Google\Protobuf\FieldMask\|null`

hasFieldMask

clearFieldMask

setFieldMask

Mask specifying which fields of DataItemView to read.

Generated from protobuf field .google.protobuf.FieldMask field_mask = 6;

Parameter
Name	Description
`var`	`Google\Protobuf\FieldMask`

Returns
Type	Description
`$this`

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.

Generated from protobuf field int32 annotations_limit = 7;

Returns
Type	Description
`int`

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.

Generated from protobuf field int32 annotations_limit = 7;

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageSize

Requested page size. Server may return fewer results than requested.

Default and maximum page size is 100.

Generated from protobuf field int32 page_size = 8;

Returns
Type	Description
`int`

setPageSize

Requested page size. Server may return fewer results than requested.

Default and maximum page size is 100.

Generated from protobuf field int32 page_size = 8;

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getOrderBy

A comma-separated list of fields to order by, sorted in ascending order.

Use "desc" after a field name for descending.

Generated from protobuf field string order_by = 9 [deprecated = true];

Returns
Type	Description
`string`

setOrderBy

A comma-separated list of fields to order by, sorted in ascending order.

Use "desc" after a field name for descending.

Generated from protobuf field string order_by = 9 [deprecated = true];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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.

Generated from protobuf field string page_token = 10;

Returns
Type	Description
`string`

setPageToken

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.

Generated from protobuf field string page_token = 10;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOrder

Returns
Type	Description
`string`