Struct aws_sdk_iotthingsgraph::operation::search_entities::builders::SearchEntitiesInputBuilder

#[non_exhaustive]
pub struct SearchEntitiesInputBuilder { /* private fields */ }

A builder for SearchEntitiesInput.

Implementations

impl SearchEntitiesInputBuilder

pub fn entity_types(self, input: EntityType) -> Self

Appends an item to entity_types.

To override the contents of this collection use set_entity_types.

The entity types for which to search.

pub fn set_entity_types(self, input: Option<Vec<EntityType>>) -> Self

The entity types for which to search.

pub fn get_entity_types(&self) -> &Option<Vec<EntityType>>

The entity types for which to search.

pub fn filters(self, input: EntityFilter) -> Self

Appends an item to filters.

To override the contents of this collection use set_filters.

Optional filter to apply to the search. Valid filters are NAME NAMESPACE, SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

pub fn set_filters(self, input: Option<Vec<EntityFilter>>) -> Self

Optional filter to apply to the search. Valid filters are NAME NAMESPACE, SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

pub fn get_filters(&self) -> &Option<Vec<EntityFilter>>

Optional filter to apply to the search. Valid filters are NAME NAMESPACE, SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

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

The string that specifies the next page of results. Use this when you're paginating results.

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

The string that specifies the next page of results. Use this when you're paginating results.

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

The string that specifies the next page of results. Use this when you're paginating results.

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

The maximum number of results to return in the response.

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

The maximum number of results to return in the response.

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

The maximum number of results to return in the response.

pub fn namespace_version(self, input: i64) -> Self

The version of the user's namespace. Defaults to the latest version of the user's namespace.

pub fn set_namespace_version(self, input: Option<i64>) -> Self

The version of the user's namespace. Defaults to the latest version of the user's namespace.

pub fn get_namespace_version(&self) -> &Option<i64>

The version of the user's namespace. Defaults to the latest version of the user's namespace.

pub fn build(self) -> Result<SearchEntitiesInput, BuildError>

Consumes the builder and constructs a SearchEntitiesInput.

impl SearchEntitiesInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<SearchEntitiesOutput, SdkError<SearchEntitiesError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for SearchEntitiesInputBuilder

fn clone(&self) -> SearchEntitiesInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchEntitiesInputBuilder

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

Formats the value using the given formatter.

impl Default for SearchEntitiesInputBuilder

fn default() -> SearchEntitiesInputBuilder

Returns the “default value” for a type.

impl PartialEq for SearchEntitiesInputBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for SearchEntitiesInputBuilder