aws-sdk-gamelift 1.119.0

AWS SDK for Amazon GameLift
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct ListComputeInput {
    /// <p>A unique identifier for the fleet to retrieve compute resources for.</p>
    pub fleet_id: ::std::option::Option<::std::string::String>,
    /// <p>The name of a location to retrieve compute resources for. For an Amazon GameLift Servers Anywhere fleet, use a custom location. For a managed fleet, provide a Amazon Web Services Region or Local Zone code (for example: <code>us-west-2</code> or <code>us-west-2-lax-1</code>).</p>
    pub location: ::std::option::Option<::std::string::String>,
    /// <p>For computes in a managed container fleet, the name of the deployed container group definition.</p>
    pub container_group_definition_name: ::std::option::Option<::std::string::String>,
    /// <p>The status of computes in a managed container fleet, based on the success of the latest update deployment.</p>
    /// <ul>
    /// <li>
    /// <p><code>ACTIVE</code> -- The compute is deployed with the correct container definitions. It is ready to process game servers and host game sessions.</p></li>
    /// <li>
    /// <p><code>IMPAIRED</code> -- An update deployment to the compute failed, and the compute is deployed with incorrect container definitions.</p></li>
    /// </ul>
    pub compute_status: ::std::option::Option<crate::types::ListComputeInputStatus>,
    /// <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 limit: ::std::option::Option<i32>,
    /// <p>A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.</p>
    pub next_token: ::std::option::Option<::std::string::String>,
}
impl ListComputeInput {
    /// <p>A unique identifier for the fleet to retrieve compute resources for.</p>
    pub fn fleet_id(&self) -> ::std::option::Option<&str> {
        self.fleet_id.as_deref()
    }
    /// <p>The name of a location to retrieve compute resources for. For an Amazon GameLift Servers Anywhere fleet, use a custom location. For a managed fleet, provide a Amazon Web Services Region or Local Zone code (for example: <code>us-west-2</code> or <code>us-west-2-lax-1</code>).</p>
    pub fn location(&self) -> ::std::option::Option<&str> {
        self.location.as_deref()
    }
    /// <p>For computes in a managed container fleet, the name of the deployed container group definition.</p>
    pub fn container_group_definition_name(&self) -> ::std::option::Option<&str> {
        self.container_group_definition_name.as_deref()
    }
    /// <p>The status of computes in a managed container fleet, based on the success of the latest update deployment.</p>
    /// <ul>
    /// <li>
    /// <p><code>ACTIVE</code> -- The compute is deployed with the correct container definitions. It is ready to process game servers and host game sessions.</p></li>
    /// <li>
    /// <p><code>IMPAIRED</code> -- An update deployment to the compute failed, and the compute is deployed with incorrect container definitions.</p></li>
    /// </ul>
    pub fn compute_status(&self) -> ::std::option::Option<&crate::types::ListComputeInputStatus> {
        self.compute_status.as_ref()
    }
    /// <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 limit(&self) -> ::std::option::Option<i32> {
        self.limit
    }
    /// <p>A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.</p>
    pub fn next_token(&self) -> ::std::option::Option<&str> {
        self.next_token.as_deref()
    }
}
impl ListComputeInput {
    /// Creates a new builder-style object to manufacture [`ListComputeInput`](crate::operation::list_compute::ListComputeInput).
    pub fn builder() -> crate::operation::list_compute::builders::ListComputeInputBuilder {
        crate::operation::list_compute::builders::ListComputeInputBuilder::default()
    }
}

/// A builder for [`ListComputeInput`](crate::operation::list_compute::ListComputeInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct ListComputeInputBuilder {
    pub(crate) fleet_id: ::std::option::Option<::std::string::String>,
    pub(crate) location: ::std::option::Option<::std::string::String>,
    pub(crate) container_group_definition_name: ::std::option::Option<::std::string::String>,
    pub(crate) compute_status: ::std::option::Option<crate::types::ListComputeInputStatus>,
    pub(crate) limit: ::std::option::Option<i32>,
    pub(crate) next_token: ::std::option::Option<::std::string::String>,
}
impl ListComputeInputBuilder {
    /// <p>A unique identifier for the fleet to retrieve compute resources for.</p>
    /// This field is required.
    pub fn fleet_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.fleet_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A unique identifier for the fleet to retrieve compute resources for.</p>
    pub fn set_fleet_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.fleet_id = input;
        self
    }
    /// <p>A unique identifier for the fleet to retrieve compute resources for.</p>
    pub fn get_fleet_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.fleet_id
    }
    /// <p>The name of a location to retrieve compute resources for. For an Amazon GameLift Servers Anywhere fleet, use a custom location. For a managed fleet, provide a Amazon Web Services Region or Local Zone code (for example: <code>us-west-2</code> or <code>us-west-2-lax-1</code>).</p>
    pub fn location(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.location = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of a location to retrieve compute resources for. For an Amazon GameLift Servers Anywhere fleet, use a custom location. For a managed fleet, provide a Amazon Web Services Region or Local Zone code (for example: <code>us-west-2</code> or <code>us-west-2-lax-1</code>).</p>
    pub fn set_location(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.location = input;
        self
    }
    /// <p>The name of a location to retrieve compute resources for. For an Amazon GameLift Servers Anywhere fleet, use a custom location. For a managed fleet, provide a Amazon Web Services Region or Local Zone code (for example: <code>us-west-2</code> or <code>us-west-2-lax-1</code>).</p>
    pub fn get_location(&self) -> &::std::option::Option<::std::string::String> {
        &self.location
    }
    /// <p>For computes in a managed container fleet, the name of the deployed container group definition.</p>
    pub fn container_group_definition_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.container_group_definition_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>For computes in a managed container fleet, the name of the deployed container group definition.</p>
    pub fn set_container_group_definition_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.container_group_definition_name = input;
        self
    }
    /// <p>For computes in a managed container fleet, the name of the deployed container group definition.</p>
    pub fn get_container_group_definition_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.container_group_definition_name
    }
    /// <p>The status of computes in a managed container fleet, based on the success of the latest update deployment.</p>
    /// <ul>
    /// <li>
    /// <p><code>ACTIVE</code> -- The compute is deployed with the correct container definitions. It is ready to process game servers and host game sessions.</p></li>
    /// <li>
    /// <p><code>IMPAIRED</code> -- An update deployment to the compute failed, and the compute is deployed with incorrect container definitions.</p></li>
    /// </ul>
    pub fn compute_status(mut self, input: crate::types::ListComputeInputStatus) -> Self {
        self.compute_status = ::std::option::Option::Some(input);
        self
    }
    /// <p>The status of computes in a managed container fleet, based on the success of the latest update deployment.</p>
    /// <ul>
    /// <li>
    /// <p><code>ACTIVE</code> -- The compute is deployed with the correct container definitions. It is ready to process game servers and host game sessions.</p></li>
    /// <li>
    /// <p><code>IMPAIRED</code> -- An update deployment to the compute failed, and the compute is deployed with incorrect container definitions.</p></li>
    /// </ul>
    pub fn set_compute_status(mut self, input: ::std::option::Option<crate::types::ListComputeInputStatus>) -> Self {
        self.compute_status = input;
        self
    }
    /// <p>The status of computes in a managed container fleet, based on the success of the latest update deployment.</p>
    /// <ul>
    /// <li>
    /// <p><code>ACTIVE</code> -- The compute is deployed with the correct container definitions. It is ready to process game servers and host game sessions.</p></li>
    /// <li>
    /// <p><code>IMPAIRED</code> -- An update deployment to the compute failed, and the compute is deployed with incorrect container definitions.</p></li>
    /// </ul>
    pub fn get_compute_status(&self) -> &::std::option::Option<crate::types::ListComputeInputStatus> {
        &self.compute_status
    }
    /// <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 limit(mut self, input: i32) -> Self {
        self.limit = ::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_limit(mut self, input: ::std::option::Option<i32>) -> Self {
        self.limit = 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_limit(&self) -> &::std::option::Option<i32> {
        &self.limit
    }
    /// <p>A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.</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>A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.</p>
    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.next_token = input;
        self
    }
    /// <p>A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.</p>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.next_token
    }
    /// Consumes the builder and constructs a [`ListComputeInput`](crate::operation::list_compute::ListComputeInput).
    pub fn build(self) -> ::std::result::Result<crate::operation::list_compute::ListComputeInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::list_compute::ListComputeInput {
            fleet_id: self.fleet_id,
            location: self.location,
            container_group_definition_name: self.container_group_definition_name,
            compute_status: self.compute_status,
            limit: self.limit,
            next_token: self.next_token,
        })
    }
}