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 Details

    • gameServerGroupName

      ListGameServersRequest.Builder gameServerGroupName(String gameServerGroupName)

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

      Parameters:
      gameServerGroupName - An identifier for the game server group to retrieve a list of game servers from. Use either the 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

      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:

    • 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)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListGameServersRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.