SearchDataItemsRequest class final

Request message for DatasetService.SearchDataItems.

Inheritance
  • Object
  • ProtoMessage
  • SearchDataItemsRequest

Constructors

SearchDataItemsRequest({String? orderByDataItem, SearchDataItemsRequest_OrderByAnnotation? orderByAnnotation, required String dataset, String savedQuery = '', String dataLabelingJob = '', String dataItemFilter = '', String annotationsFilter = '', List<String> annotationFilters = const [], FieldMask? fieldMask, int annotationsLimit = 0, int pageSize = 0, String orderBy = '', String pageToken = ''})
SearchDataItemsRequest.fromJson(Object? j)
factory

Properties

annotationFilters → List<String>
An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned.
final
annotationsFilter → String
An expression for filtering the Annotations that will be returned per DataItem.
final
annotationsLimit → 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.
final
dataItemFilter → String
An expression for filtering the DataItem that will be returned.
final
dataLabelingJob → 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.
final
dataset → String
Required. The resource name of the Dataset from which to search DataItems. Format: projects/{project}/locations/{location}/datasets/{dataset}
final
fieldMask → FieldMask?
Mask specifying which fields of DataItemView to read.
final
hashCode → int
The hash code for this object.
no setterinherited
orderBy → String
A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
final
orderByAnnotation → SearchDataItemsRequest_OrderByAnnotation?
Expression that allows ranking results based on annotation's property.
final
orderByDataItem → String?
A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
final
pageSize → int
Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.
final
pageToken → 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.
final
qualifiedName → String
The fully qualified name of this message, i.e., google.protobuf.Duration or google.rpc.ErrorInfo.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
savedQuery → 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.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Object
override
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

fullyQualifiedName → const String