Struct SearchDataItemsRequest 

#[non_exhaustive]
pub struct SearchDataItemsRequest {
    pub dataset: String,
    pub saved_query: String,
    pub data_labeling_job: String,
    pub data_item_filter: String,
    pub annotations_filter: String,
    pub annotation_filters: Vec<String>,
    pub field_mask: Option<FieldMask>,
    pub annotations_limit: i32,
    pub page_size: i32,
    pub order_by: String,
    pub page_token: String,
    pub order: Option<Order>,
    /* private fields */
}

Available on crate feature dataset-service only.

Request message for DatasetService.SearchDataItems.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

dataset: String

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

saved_query: String

👎Deprecated

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

👎Deprecated

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

• annotation_spec_id - for = or !=.

annotation_filters: Vec<String>

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: Option<FieldMask>

Mask specifying which fields of DataItemView to read.

annotations_limit: i32

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: i32

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

order_by: String

👎Deprecated

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.

order: Option<Order>

Implementations

impl SearchDataItemsRequest

pub fn new() -> Self

pub fn set_dataset<T: Into<String>>(self, v: T) -> Self

Sets the value of dataset.

Example

let x = SearchDataItemsRequest::new().set_dataset("example");

pub fn set_saved_query<T: Into<String>>(self, v: T) -> Self

👎Deprecated

Sets the value of saved_query.

Example

let x = SearchDataItemsRequest::new().set_saved_query("example");

pub fn set_data_labeling_job<T: Into<String>>(self, v: T) -> Self

Sets the value of data_labeling_job.

Example

let x = SearchDataItemsRequest::new().set_data_labeling_job("example");

pub fn set_data_item_filter<T: Into<String>>(self, v: T) -> Self

Sets the value of data_item_filter.

Example

let x = SearchDataItemsRequest::new().set_data_item_filter("example");

pub fn set_annotations_filter<T: Into<String>>(self, v: T) -> Self

👎Deprecated

Sets the value of annotations_filter.

Example

let x = SearchDataItemsRequest::new().set_annotations_filter("example");

pub fn set_annotation_filters<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of annotation_filters.

Example

let x = SearchDataItemsRequest::new().set_annotation_filters(["a", "b", "c"]);

pub fn set_field_mask<T>(self, v: T) -> Self

where T: Into<FieldMask>,

Sets the value of field_mask.

Example

use wkt::FieldMask;
let x = SearchDataItemsRequest::new().set_field_mask(FieldMask::default()/* use setters */);

pub fn set_or_clear_field_mask<T>(self, v: Option<T>) -> Self

where T: Into<FieldMask>,

Sets or clears the value of field_mask.

Example

use wkt::FieldMask;
let x = SearchDataItemsRequest::new().set_or_clear_field_mask(Some(FieldMask::default()/* use setters */));
let x = SearchDataItemsRequest::new().set_or_clear_field_mask(None::<FieldMask>);

pub fn set_annotations_limit<T: Into<i32>>(self, v: T) -> Self

Sets the value of annotations_limit.

Example

let x = SearchDataItemsRequest::new().set_annotations_limit(42);

pub fn set_page_size<T: Into<i32>>(self, v: T) -> Self

Sets the value of page_size.

Example

let x = SearchDataItemsRequest::new().set_page_size(42);

pub fn set_order_by<T: Into<String>>(self, v: T) -> Self

👎Deprecated

Sets the value of order_by.

Example

let x = SearchDataItemsRequest::new().set_order_by("example");

pub fn set_page_token<T: Into<String>>(self, v: T) -> Self

Sets the value of page_token.

Example

let x = SearchDataItemsRequest::new().set_page_token("example");

pub fn set_order<T: Into<Option<Order>>>(self, v: T) -> Self

Sets the value of order.

Note that all the setters affecting order are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::search_data_items_request::Order;
let x = SearchDataItemsRequest::new().set_order(Some(Order::OrderByDataItem("example".to_string())));

pub fn order_by_data_item(&self) -> Option<&String>

The value of order if it holds a OrderByDataItem, None if the field is not set or holds a different branch.

pub fn set_order_by_data_item<T: Into<String>>(self, v: T) -> Self

Sets the value of order to hold a OrderByDataItem.

Note that all the setters affecting order are mutually exclusive.

Example

let x = SearchDataItemsRequest::new().set_order_by_data_item("example");
assert!(x.order_by_data_item().is_some());
assert!(x.order_by_annotation().is_none());

pub fn order_by_annotation(&self) -> Option<&Box<OrderByAnnotation>>

The value of order if it holds a OrderByAnnotation, None if the field is not set or holds a different branch.

pub fn set_order_by_annotation<T: Into<Box<OrderByAnnotation>>>( self, v: T, ) -> Self

Sets the value of order to hold a OrderByAnnotation.

Note that all the setters affecting order are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::search_data_items_request::OrderByAnnotation;
let x = SearchDataItemsRequest::new().set_order_by_annotation(OrderByAnnotation::default()/* use setters */);
assert!(x.order_by_annotation().is_some());
assert!(x.order_by_data_item().is_none());

Trait Implementations

impl Clone for SearchDataItemsRequest

fn clone(&self) -> SearchDataItemsRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SearchDataItemsRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SearchDataItemsRequest

fn default() -> SearchDataItemsRequest

Returns the “default value” for a type.

impl Message for SearchDataItemsRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for SearchDataItemsRequest

fn eq(&self, other: &SearchDataItemsRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SearchDataItemsRequest