Struct aws_sdk_iotthingsgraph::client::fluent_builders::SearchEntities

pub struct SearchEntities { /* private fields */ }

Fluent builder constructing a request to SearchEntities.

Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking.

Implementations

impl SearchEntities

pub async fn send(
    self
) -> Result<SearchEntitiesOutput, SdkError<SearchEntitiesError>>

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 fn into_paginator(self) -> SearchEntitiesPaginator

Create a paginator for this request

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

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

Appends an item to entityTypes.

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 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 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 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 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.

Trait Implementations

impl Clone for SearchEntities

fn clone(&self) -> SearchEntities

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchEntities

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

Formats the value using the given formatter.