software.amazon.awssdk.services.gamelift.model

Interface ListGameServersRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListGameServersRequest.Builder,ListGameServersRequest>, GameLiftRequest.Builder, SdkBuilder<ListGameServersRequest.Builder,ListGameServersRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListGameServersRequest

public static interface ListGameServersRequest.Builder
extends GameLiftRequest.Builder, SdkPojo, CopyableBuilder<ListGameServersRequest.Builder,ListGameServersRequest>

Method Summary

Modifier and Type	Method and Description
ListGameServersRequest.Builder	gameServerGroupName(String gameServerGroupName) An identifier for the game server group to retrieve a list of game servers from.
ListGameServersRequest.Builder	limit(Integer limit) The maximum number of results to return.
ListGameServersRequest.Builder	nextToken(String nextToken) A token that indicates the start of the next sequential page of results.
ListGameServersRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ListGameServersRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ListGameServersRequest.Builder	sortOrder(SortOrder sortOrder) Indicates how to sort the returned data based on game server registration timestamp.
ListGameServersRequest.Builder	sortOrder(String sortOrder) Indicates how to sort the returned data based on game server registration timestamp.

Methods inherited from interface software.amazon.awssdk.services.gamelift.model.GameLiftRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

gameServerGroupName

ListGameServersRequest.Builder gameServerGroupName(String gameServerGroupName)

An identifier for the game server group to retrieve a list of game servers from. Use either the GameServerGroup name or ARN value.

Parameters:

gameServerGroupName - An identifier for the game server group to retrieve a list of game servers from. Use either the GameServerGroup name or ARN value.

Returns:

Returns a reference to this object so that method calls can be chained together.

sortOrder

ListGameServersRequest.Builder sortOrder(String sortOrder)

Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.

Parameters:

sortOrder - Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SortOrder, SortOrder

sortOrder

ListGameServersRequest.Builder sortOrder(SortOrder sortOrder)

Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.

Parameters:

sortOrder - Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SortOrder, SortOrder

limit

ListGameServersRequest.Builder limit(Integer limit)

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Parameters:

limit - The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Returns:

Returns a reference to this object so that method calls can be chained together.

nextToken

ListGameServersRequest.Builder nextToken(String nextToken)

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.

Parameters:

nextToken - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

ListGameServersRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ListGameServersRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder