aws-sdk-deadline 1.100.0

AWS SDK for AWSDeadlineCloud
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// Shared pagination fields for List operation inputs (nextToken + maxResults).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct ListQueuesInput {
    /// <p>The farm ID of the queue.</p>
    pub farm_id: ::std::option::Option<::std::string::String>,
    /// <p>The token for the next set of results, or <code>null</code> to start from the beginning.</p>
    pub next_token: ::std::option::Option<::std::string::String>,
    /// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>
    pub max_results: ::std::option::Option<i32>,
    /// <p>The principal IDs to include in the list of queues.</p>
    pub principal_id: ::std::option::Option<::std::string::String>,
    /// <p>The status of the queues listed.</p>
    /// <ul>
    /// <li>
    /// <p><code>ACTIVE</code>–The queues are active.</p></li>
    /// <li>
    /// <p><code>SCHEDULING</code>–The queues are scheduling.</p></li>
    /// <li>
    /// <p><code>SCHEDULING_BLOCKED</code>–The queue scheduling is blocked for these queues.</p></li>
    /// </ul>
    pub status: ::std::option::Option<crate::types::QueueStatus>,
}
impl ListQueuesInput {
    /// <p>The farm ID of the queue.</p>
    pub fn farm_id(&self) -> ::std::option::Option<&str> {
        self.farm_id.as_deref()
    }
    /// <p>The token for the next set of results, or <code>null</code> to start from the beginning.</p>
    pub fn next_token(&self) -> ::std::option::Option<&str> {
        self.next_token.as_deref()
    }
    /// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>
    pub fn max_results(&self) -> ::std::option::Option<i32> {
        self.max_results
    }
    /// <p>The principal IDs to include in the list of queues.</p>
    pub fn principal_id(&self) -> ::std::option::Option<&str> {
        self.principal_id.as_deref()
    }
    /// <p>The status of the queues listed.</p>
    /// <ul>
    /// <li>
    /// <p><code>ACTIVE</code>–The queues are active.</p></li>
    /// <li>
    /// <p><code>SCHEDULING</code>–The queues are scheduling.</p></li>
    /// <li>
    /// <p><code>SCHEDULING_BLOCKED</code>–The queue scheduling is blocked for these queues.</p></li>
    /// </ul>
    pub fn status(&self) -> ::std::option::Option<&crate::types::QueueStatus> {
        self.status.as_ref()
    }
}
impl ListQueuesInput {
    /// Creates a new builder-style object to manufacture [`ListQueuesInput`](crate::operation::list_queues::ListQueuesInput).
    pub fn builder() -> crate::operation::list_queues::builders::ListQueuesInputBuilder {
        crate::operation::list_queues::builders::ListQueuesInputBuilder::default()
    }
}

/// A builder for [`ListQueuesInput`](crate::operation::list_queues::ListQueuesInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct ListQueuesInputBuilder {
    pub(crate) farm_id: ::std::option::Option<::std::string::String>,
    pub(crate) next_token: ::std::option::Option<::std::string::String>,
    pub(crate) max_results: ::std::option::Option<i32>,
    pub(crate) principal_id: ::std::option::Option<::std::string::String>,
    pub(crate) status: ::std::option::Option<crate::types::QueueStatus>,
}
impl ListQueuesInputBuilder {
    /// <p>The farm ID of the queue.</p>
    /// This field is required.
    pub fn farm_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.farm_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The farm ID of the queue.</p>
    pub fn set_farm_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.farm_id = input;
        self
    }
    /// <p>The farm ID of the queue.</p>
    pub fn get_farm_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.farm_id
    }
    /// <p>The token for the next set of results, or <code>null</code> to start from the beginning.</p>
    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.next_token = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The token for the next set of results, or <code>null</code> to start from the beginning.</p>
    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.next_token = input;
        self
    }
    /// <p>The token for the next set of results, or <code>null</code> to start from the beginning.</p>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.next_token
    }
    /// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>
    pub fn max_results(mut self, input: i32) -> Self {
        self.max_results = ::std::option::Option::Some(input);
        self
    }
    /// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>
    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
        self.max_results = input;
        self
    }
    /// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>
    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
        &self.max_results
    }
    /// <p>The principal IDs to include in the list of queues.</p>
    pub fn principal_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.principal_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The principal IDs to include in the list of queues.</p>
    pub fn set_principal_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.principal_id = input;
        self
    }
    /// <p>The principal IDs to include in the list of queues.</p>
    pub fn get_principal_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.principal_id
    }
    /// <p>The status of the queues listed.</p>
    /// <ul>
    /// <li>
    /// <p><code>ACTIVE</code>–The queues are active.</p></li>
    /// <li>
    /// <p><code>SCHEDULING</code>–The queues are scheduling.</p></li>
    /// <li>
    /// <p><code>SCHEDULING_BLOCKED</code>–The queue scheduling is blocked for these queues.</p></li>
    /// </ul>
    pub fn status(mut self, input: crate::types::QueueStatus) -> Self {
        self.status = ::std::option::Option::Some(input);
        self
    }
    /// <p>The status of the queues listed.</p>
    /// <ul>
    /// <li>
    /// <p><code>ACTIVE</code>–The queues are active.</p></li>
    /// <li>
    /// <p><code>SCHEDULING</code>–The queues are scheduling.</p></li>
    /// <li>
    /// <p><code>SCHEDULING_BLOCKED</code>–The queue scheduling is blocked for these queues.</p></li>
    /// </ul>
    pub fn set_status(mut self, input: ::std::option::Option<crate::types::QueueStatus>) -> Self {
        self.status = input;
        self
    }
    /// <p>The status of the queues listed.</p>
    /// <ul>
    /// <li>
    /// <p><code>ACTIVE</code>–The queues are active.</p></li>
    /// <li>
    /// <p><code>SCHEDULING</code>–The queues are scheduling.</p></li>
    /// <li>
    /// <p><code>SCHEDULING_BLOCKED</code>–The queue scheduling is blocked for these queues.</p></li>
    /// </ul>
    pub fn get_status(&self) -> &::std::option::Option<crate::types::QueueStatus> {
        &self.status
    }
    /// Consumes the builder and constructs a [`ListQueuesInput`](crate::operation::list_queues::ListQueuesInput).
    pub fn build(self) -> ::std::result::Result<crate::operation::list_queues::ListQueuesInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::list_queues::ListQueuesInput {
            farm_id: self.farm_id,
            next_token: self.next_token,
            max_results: self.max_results,
            principal_id: self.principal_id,
            status: self.status,
        })
    }
}