Struct ListPipesInput

#[non_exhaustive]
pub struct ListPipesInput {
    pub name_prefix: Option<String>,
    pub desired_state: Option<RequestedPipeState>,
    pub current_state: Option<PipeState>,
    pub source_prefix: Option<String>,
    pub target_prefix: Option<String>,
    pub next_token: Option<String>,
    pub limit: Option<i32>,
}

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.

name_prefix: Option<String>

A value that will return a subset of the pipes associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.

desired_state: Option<RequestedPipeState>

The state the pipe should be in.

current_state: Option<PipeState>

The state the pipe is in.

source_prefix: Option<String>

The prefix matching the pipe source.

target_prefix: Option<String>

The prefix matching the pipe target.

next_token: Option<String>

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

limit: Option<i32>

The maximum number of pipes to include in the response.

Implementations

impl ListPipesInput

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

A value that will return a subset of the pipes associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.

pub fn desired_state(&self) -> Option<&RequestedPipeState>

The state the pipe should be in.

pub fn current_state(&self) -> Option<&PipeState>

The state the pipe is in.

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

The prefix matching the pipe source.

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

The prefix matching the pipe target.

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

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

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

The maximum number of pipes to include in the response.

impl ListPipesInput

pub fn builder() -> ListPipesInputBuilder

Creates a new builder-style object to manufacture ListPipesInput.

Trait Implementations

impl Clone for ListPipesInput

fn clone(&self) -> ListPipesInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListPipesInput

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

Formats the value using the given formatter.

impl PartialEq for ListPipesInput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ListPipesInput