pub struct ListComputeFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to ListCompute.
This API works with the following fleet types: EC2, Anywhere, Container
Retrieves information on the compute resources in an Amazon GameLift Servers fleet. Use the pagination parameters to retrieve results in a set of sequential pages.
Request options
-
Retrieve a list of all computes in a fleet. Specify a fleet ID.
-
Retrieve a list of all computes in a specific fleet location. Specify a fleet ID and location.
Results
If successful, this operation returns information on a set of computes. Depending on the type of fleet, the result includes the following information:
-
For a managed EC2 fleet (compute type
EC2), this operation returns information about the EC2 instance. Compute names are EC2 instance IDs. -
For an Anywhere fleet (compute type
ANYWHERE), this operation returns compute names and details from when the compute was registered withRegisterCompute. This includesGameLiftServiceSdkEndpointorGameLiftAgentEndpoint.
Implementations§
Source§impl ListComputeFluentBuilder
impl ListComputeFluentBuilder
Sourcepub fn as_input(&self) -> &ListComputeInputBuilder
pub fn as_input(&self) -> &ListComputeInputBuilder
Access the ListCompute as a reference.
Sourcepub async fn send(
self,
) -> Result<ListComputeOutput, SdkError<ListComputeError, HttpResponse>>
pub async fn send( self, ) -> Result<ListComputeOutput, SdkError<ListComputeError, HttpResponse>>
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.
Sourcepub fn customize(
self,
) -> CustomizableOperation<ListComputeOutput, ListComputeError, Self>
pub fn customize( self, ) -> CustomizableOperation<ListComputeOutput, ListComputeError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn into_paginator(self) -> ListComputePaginator
pub fn into_paginator(self) -> ListComputePaginator
Create a paginator for this request
Paginators are used by calling send().await which returns a PaginationStream.
Sourcepub fn fleet_id(self, input: impl Into<String>) -> Self
pub fn fleet_id(self, input: impl Into<String>) -> Self
A unique identifier for the fleet to retrieve compute resources for.
Sourcepub fn set_fleet_id(self, input: Option<String>) -> Self
pub fn set_fleet_id(self, input: Option<String>) -> Self
A unique identifier for the fleet to retrieve compute resources for.
Sourcepub fn get_fleet_id(&self) -> &Option<String>
pub fn get_fleet_id(&self) -> &Option<String>
A unique identifier for the fleet to retrieve compute resources for.
Sourcepub fn location(self, input: impl Into<String>) -> Self
pub fn location(self, input: impl Into<String>) -> Self
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: us-west-2 or us-west-2-lax-1).
Sourcepub fn set_location(self, input: Option<String>) -> Self
pub fn set_location(self, input: Option<String>) -> Self
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: us-west-2 or us-west-2-lax-1).
Sourcepub fn get_location(&self) -> &Option<String>
pub fn get_location(&self) -> &Option<String>
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: us-west-2 or us-west-2-lax-1).
Sourcepub fn container_group_definition_name(self, input: impl Into<String>) -> Self
pub fn container_group_definition_name(self, input: impl Into<String>) -> Self
For computes in a managed container fleet, the name of the deployed container group definition.
Sourcepub fn set_container_group_definition_name(self, input: Option<String>) -> Self
pub fn set_container_group_definition_name(self, input: Option<String>) -> Self
For computes in a managed container fleet, the name of the deployed container group definition.
Sourcepub fn get_container_group_definition_name(&self) -> &Option<String>
pub fn get_container_group_definition_name(&self) -> &Option<String>
For computes in a managed container fleet, the name of the deployed container group definition.
Sourcepub fn compute_status(self, input: ListComputeInputStatus) -> Self
pub fn compute_status(self, input: ListComputeInputStatus) -> Self
The status of computes in a managed container fleet, based on the success of the latest update deployment.
-
ACTIVE-- The compute is deployed with the correct container definitions. It is ready to process game servers and host game sessions. -
IMPAIRED-- An update deployment to the compute failed, and the compute is deployed with incorrect container definitions.
Sourcepub fn set_compute_status(self, input: Option<ListComputeInputStatus>) -> Self
pub fn set_compute_status(self, input: Option<ListComputeInputStatus>) -> Self
The status of computes in a managed container fleet, based on the success of the latest update deployment.
-
ACTIVE-- The compute is deployed with the correct container definitions. It is ready to process game servers and host game sessions. -
IMPAIRED-- An update deployment to the compute failed, and the compute is deployed with incorrect container definitions.
Sourcepub fn get_compute_status(&self) -> &Option<ListComputeInputStatus>
pub fn get_compute_status(&self) -> &Option<ListComputeInputStatus>
The status of computes in a managed container fleet, based on the success of the latest update deployment.
-
ACTIVE-- The compute is deployed with the correct container definitions. It is ready to process game servers and host game sessions. -
IMPAIRED-- An update deployment to the compute failed, and the compute is deployed with incorrect container definitions.
Sourcepub fn limit(self, input: i32) -> Self
pub fn limit(self, input: i32) -> Self
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
Sourcepub fn set_limit(self, input: Option<i32>) -> Self
pub fn set_limit(self, input: Option<i32>) -> Self
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
Sourcepub fn get_limit(&self) -> &Option<i32>
pub fn get_limit(&self) -> &Option<i32>
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
Sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
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.
Sourcepub fn get_next_token(&self) -> &Option<String>
pub fn get_next_token(&self) -> &Option<String>
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.
Trait Implementations§
Source§impl Clone for ListComputeFluentBuilder
impl Clone for ListComputeFluentBuilder
Source§fn clone(&self) -> ListComputeFluentBuilder
fn clone(&self) -> ListComputeFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for ListComputeFluentBuilder
impl !RefUnwindSafe for ListComputeFluentBuilder
impl Send for ListComputeFluentBuilder
impl Sync for ListComputeFluentBuilder
impl Unpin for ListComputeFluentBuilder
impl !UnwindSafe for ListComputeFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);