Struct ProjectLocationDatasetSearchDataItemCall 

pub struct ProjectLocationDatasetSearchDataItemCall<'a, C>
where
    C: 'a,
{ /* private fields */ }

Searches DataItems in a Dataset.

A builder for the locations.datasets.searchDataItems method supported by a project resource. It is not used directly, but through a ProjectMethods instance.

Example

Instantiate a resource method builder

// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.projects().locations_datasets_search_data_items("dataset")
             .saved_query("rebum.")
             .page_token("amet")
             .page_size(-60)
             .order_by_data_item("sadipscing")
             .order_by_annotation_saved_query("dolore")
             .order_by_annotation_order_by("amet")
             .order_by("invidunt")
             .field_mask(FieldMask::new::<&str>(&[]))
             .data_labeling_job("invidunt")
             .data_item_filter("dolores")
             .annotations_limit(-29)
             .annotations_filter("sanctus")
             .add_annotation_filters("sed")
             .doit().await;

Implementations

impl<'a, C> ProjectLocationDatasetSearchDataItemCall<'a, C>

where C: Connector,

pub async fn doit( self, ) -> Result<(Response, GoogleCloudAiplatformV1SearchDataItemsResponse)>

Perform the operation you have build so far.

pub fn dataset( self, new_value: &str, ) -> ProjectLocationDatasetSearchDataItemCall<'a, C>

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

Sets the dataset path property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

pub fn saved_query( self, new_value: &str, ) -> ProjectLocationDatasetSearchDataItemCall<'a, C>

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.

Sets the saved query query property to the given value.

pub fn page_token( self, new_value: &str, ) -> ProjectLocationDatasetSearchDataItemCall<'a, C>

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.

Sets the page token query property to the given value.

pub fn page_size( self, new_value: i32, ) -> ProjectLocationDatasetSearchDataItemCall<'a, C>

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

Sets the page size query property to the given value.

pub fn order_by_data_item( self, new_value: &str, ) -> ProjectLocationDatasetSearchDataItemCall<'a, C>

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

Sets the order by data item query property to the given value.

pub fn order_by_annotation_saved_query( self, new_value: &str, ) -> ProjectLocationDatasetSearchDataItemCall<'a, C>

Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.

Sets the order by annotation.saved query query property to the given value.

pub fn order_by_annotation_order_by( self, new_value: &str, ) -> ProjectLocationDatasetSearchDataItemCall<'a, C>

A comma-separated list of annotation fields to order by, sorted in ascending order. Use “desc” after a field name for descending. Must also specify saved_query.

Sets the order by annotation.order by query property to the given value.

pub fn order_by( self, new_value: &str, ) -> ProjectLocationDatasetSearchDataItemCall<'a, C>

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

Sets the order by query property to the given value.

pub fn field_mask( self, new_value: FieldMask, ) -> ProjectLocationDatasetSearchDataItemCall<'a, C>

Mask specifying which fields of DataItemView to read.

Sets the field mask query property to the given value.

pub fn data_labeling_job( self, new_value: &str, ) -> ProjectLocationDatasetSearchDataItemCall<'a, C>

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.

Sets the data labeling job query property to the given value.

pub fn data_item_filter( self, new_value: &str, ) -> ProjectLocationDatasetSearchDataItemCall<'a, C>

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)

Sets the data item filter query property to the given value.

pub fn annotations_limit( self, new_value: i32, ) -> ProjectLocationDatasetSearchDataItemCall<'a, C>

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.

Sets the annotations limit query property to the given value.

pub fn annotations_filter( self, new_value: &str, ) -> ProjectLocationDatasetSearchDataItemCall<'a, C>

An expression for filtering the Annotations that will be returned per DataItem. * annotation_spec_id - for = or !=.

Sets the annotations filter query property to the given value.

pub fn add_annotation_filters( self, new_value: &str, ) -> ProjectLocationDatasetSearchDataItemCall<'a, C>

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.

Append the given value to the annotation filters query property. Each appended value will retain its original ordering and be ‘/’-separated in the URL’s parameters.

pub fn delegate( self, new_value: &'a mut dyn Delegate, ) -> ProjectLocationDatasetSearchDataItemCall<'a, C>

The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.

                  It should be used to handle progress information, and to implement a certain level of resilience.

Sets the delegate property to the given value.

pub fn param<T>( self, name: T, value: T, ) -> ProjectLocationDatasetSearchDataItemCall<'a, C>

where T: AsRef<str>,

Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.

Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

• $.xgafv (query-string) - V1 error format.
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• quotaUser (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
• upload_protocol (query-string) - Upload protocol for media (e.g. “raw”, “multipart”).
• uploadType (query-string) - Legacy upload protocol for media (e.g. “media”, “multipart”).
• key (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• oauth_token (query-string) - OAuth 2.0 token for the current user.
• access_token (query-string) - OAuth access token.
• callback (query-string) - JSONP
• alt (query-string) - Data format for response.

pub fn add_scope<St>( self, scope: St, ) -> ProjectLocationDatasetSearchDataItemCall<'a, C>

where St: AsRef<str>,

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead of the default Scope variant Scope::CloudPlatform.

The scope will be added to a set of scopes. This is important as one can maintain access tokens for more than one scope.

Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.

pub fn add_scopes<I, St>( self, scopes: I, ) -> ProjectLocationDatasetSearchDataItemCall<'a, C>

where I: IntoIterator<Item = St>, St: AsRef<str>,

Identifies the authorization scope(s) for the method you are building.

See Self::add_scope() for details.

pub fn clear_scopes(self) -> ProjectLocationDatasetSearchDataItemCall<'a, C>

Removes all scopes, and no default scope will be used either. In this case, you have to specify your API-key using the key parameter (see Self::param() for details).

Trait Implementations

impl<'a, C> CallBuilder for ProjectLocationDatasetSearchDataItemCall<'a, C>