Struct aws_sdk_sagemaker::operation::search::builders::SearchFluentBuilder

pub struct SearchFluentBuilder { /* private fields */ }

Fluent builder constructing a request to Search.

Finds SageMaker resources that match a search query. Matching resources are returned as a list of SearchRecord objects in the response. You can sort the search results by any resource property in a ascending or descending order.

You can query against the following value types: numeric, text, Boolean, and timestamp.

The Search API may provide access to otherwise restricted data. See Amazon SageMaker API Permissions: Actions, Permissions, and Resources Reference for more information.

Implementations

impl SearchFluentBuilder

pub fn as_input(&self) -> &SearchInputBuilder

Access the Search as a reference.

pub async fn send( self ) -> Result<SearchOutput, SdkError<SearchError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub async fn customize( self ) -> Result<CustomizableOperation<SearchOutput, SearchError, Self>, SdkError<SearchError>>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn into_paginator(self) -> SearchPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn resource(self, input: ResourceType) -> Self

The name of the SageMaker resource to search for.

pub fn set_resource(self, input: Option<ResourceType>) -> Self

The name of the SageMaker resource to search for.

pub fn get_resource(&self) -> &Option<ResourceType>

The name of the SageMaker resource to search for.

pub fn search_expression(self, input: SearchExpression) -> Self

A Boolean conditional statement. Resources must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.

pub fn set_search_expression(self, input: Option<SearchExpression>) -> Self

A Boolean conditional statement. Resources must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.

pub fn get_search_expression(&self) -> &Option<SearchExpression>

A Boolean conditional statement. Resources must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.

pub fn sort_by(self, input: impl Into<String>) -> Self

The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

pub fn set_sort_by(self, input: Option<String>) -> Self

The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

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

The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

pub fn sort_order(self, input: SearchSortOrder) -> Self

How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

pub fn set_sort_order(self, input: Option<SearchSortOrder>) -> Self

How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

pub fn get_sort_order(&self) -> &Option<SearchSortOrder>

How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

pub fn next_token(self, input: impl Into<String>) -> Self

If more than MaxResults resources match the specified SearchExpression, the response includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results.

pub fn set_next_token(self, input: Option<String>) -> Self

If more than MaxResults resources match the specified SearchExpression, the response includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results.

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

If more than MaxResults resources match the specified SearchExpression, the response includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results.

pub fn max_results(self, input: i32) -> Self

The maximum number of results to return.

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of results to return.

pub fn get_max_results(&self) -> &Option<i32>

The maximum number of results to return.

pub fn cross_account_filter_option( self, input: CrossAccountFilterOption ) -> Self

A cross account filter option. When the value is "CrossAccount" the search results will only include resources made discoverable to you from other accounts. When the value is "SameAccount" or null the search results will only include resources from your account. Default is null. For more information on searching for resources made discoverable to your account, see Search discoverable resources in the SageMaker Developer Guide. The maximum number of ResourceCatalogs viewable is 1000.

pub fn set_cross_account_filter_option( self, input: Option<CrossAccountFilterOption> ) -> Self

A cross account filter option. When the value is "CrossAccount" the search results will only include resources made discoverable to you from other accounts. When the value is "SameAccount" or null the search results will only include resources from your account. Default is null. For more information on searching for resources made discoverable to your account, see Search discoverable resources in the SageMaker Developer Guide. The maximum number of ResourceCatalogs viewable is 1000.

pub fn get_cross_account_filter_option( &self ) -> &Option<CrossAccountFilterOption>

A cross account filter option. When the value is "CrossAccount" the search results will only include resources made discoverable to you from other accounts. When the value is "SameAccount" or null the search results will only include resources from your account. Default is null. For more information on searching for resources made discoverable to your account, see Search discoverable resources in the SageMaker Developer Guide. The maximum number of ResourceCatalogs viewable is 1000.

Trait Implementations

impl Clone for SearchFluentBuilder

fn clone(&self) -> SearchFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchFluentBuilder

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

Formats the value using the given formatter.