Cloud AI Platform v1 API - Class SearchDataItemsRequest (2.26.0)

public sealed class SearchDataItemsRequest : IMessage<SearchDataItemsRequest>, IEquatable<SearchDataItemsRequest>, IDeepCloneable<SearchDataItemsRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Cloud AI Platform v1 API class SearchDataItemsRequest.

Request message for [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems].

Inheritance

object > SearchDataItemsRequest

Implements

IMessage SearchDataItemsRequest, IEquatable SearchDataItemsRequest, IDeepCloneable SearchDataItemsRequest, IBufferMessage, IMessage, IPageRequest

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

SearchDataItemsRequest()

public SearchDataItemsRequest()

SearchDataItemsRequest(SearchDataItemsRequest)

public SearchDataItemsRequest(SearchDataItemsRequest other)

Parameter
Name	Description
`other`	`SearchDataItemsRequest`

Properties

AnnotationFilters

public RepeatedField<string> AnnotationFilters { get; }

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.

Property Value
Type	Description
`RepeatedFieldstring`

AnnotationsFilter

[Obsolete]
public string AnnotationsFilter { get; set; }

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

annotation_spec_id - for = or !=.

Property Value
Type	Description
`string`

AnnotationsLimit

public int AnnotationsLimit { get; set; }

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.

Property Value
Type	Description
`int`

DataItemFilter

public string DataItemFilter { get; set; }

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)

Property Value
Type	Description
`string`

DataLabelingJob

public string DataLabelingJob { get; set; }

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.

Property Value
Type	Description
`string`

Dataset

public string Dataset { get; set; }

Required. The resource name of the Dataset from which to search DataItems. Format: projects/{project}/locations/{location}/datasets/{dataset}

Property Value
Type	Description
`string`

DatasetAsDatasetName

public DatasetName DatasetAsDatasetName { get; set; }

DatasetName-typed view over the Dataset resource name property.

Property Value
Type	Description
`DatasetName`

FieldMask

public FieldMask FieldMask { get; set; }

Mask specifying which fields of [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.

Property Value
Type	Description
`FieldMask`

HasOrderByDataItem

public bool HasOrderByDataItem { get; }

Gets whether the "order_by_data_item" field is set

Property Value
Type	Description
`bool`

OrderBy

[Obsolete]
public string OrderBy { get; set; }

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

Property Value
Type	Description
`string`

OrderByAnnotation

public SearchDataItemsRequest.Types.OrderByAnnotation OrderByAnnotation { get; set; }

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

Property Value
Type	Description
`SearchDataItemsRequestTypesOrderByAnnotation`

OrderByDataItem

public string OrderByDataItem { get; set; }

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

Property Value
Type	Description
`string`

OrderCase

public SearchDataItemsRequest.OrderOneofCase OrderCase { get; }

Property Value
Type	Description
`SearchDataItemsRequestOrderOneofCase`

PageSize

public int PageSize { get; set; }

Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.

Property Value
Type	Description
`int`

PageToken

public string PageToken { get; set; }

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.

Property Value
Type	Description
`string`

SavedQuery

[Obsolete]
public string SavedQuery { get; set; }

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.

Property Value
Type	Description
`string`

SavedQueryAsSavedQueryName

[Obsolete]
public SavedQueryName SavedQueryAsSavedQueryName { get; set; }

SavedQueryName-typed view over the SavedQuery resource name property.

Property Value
Type	Description
`SavedQueryName`