Struct aws_sdk_iotthingsgraph::operation::search_entities::SearchEntitiesInput

#[non_exhaustive]
pub struct SearchEntitiesInput {
    pub entity_types: Option<Vec<EntityType>>,
    pub filters: Option<Vec<EntityFilter>>,
    pub next_token: Option<String>,
    pub max_results: Option<i32>,
    pub namespace_version: Option<i64>,
}

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.

entity_types: Option<Vec<EntityType>>

The entity types for which to search.

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

next_token: Option<String>

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

max_results: Option<i32>

The maximum number of results to return in the response.

namespace_version: Option<i64>

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

Implementations

impl SearchEntitiesInput

pub fn entity_types(&self) -> &[EntityType]

The entity types for which to search.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .entity_types.is_none().

pub fn filters(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .filters.is_none().

pub fn next_token(&self) -> Option<&str>

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

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

The maximum number of results to return in the response.

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

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

impl SearchEntitiesInput

pub fn builder() -> SearchEntitiesInputBuilder

Creates a new builder-style object to manufacture SearchEntitiesInput.

Trait Implementations

impl Clone for SearchEntitiesInput

fn clone(&self) -> SearchEntitiesInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchEntitiesInput

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

Formats the value using the given formatter.

impl PartialEq for SearchEntitiesInput

fn eq(&self, other: &SearchEntitiesInput) -> 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 SearchEntitiesInput