software.amazon.awssdk.services.gamelift.model

Interface DescribeInstancesRequest.Builder

All Superinterfaces:

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

Enclosing class:

DescribeInstancesRequest

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

Method Summary

Modifier and Type	Method and Description
DescribeInstancesRequest.Builder	fleetId(String fleetId) A unique identifier for the fleet to retrieve instance information for.
DescribeInstancesRequest.Builder	instanceId(String instanceId) A unique identifier for an instance to retrieve.
DescribeInstancesRequest.Builder	limit(Integer limit) The maximum number of results to return.
DescribeInstancesRequest.Builder	location(String location) The name of a location to retrieve instance information for, in the form of an AWS Region code such as us-west-2.
DescribeInstancesRequest.Builder	nextToken(String nextToken) A token that indicates the start of the next sequential page of results.
DescribeInstancesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeInstancesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

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

fleetId

DescribeInstancesRequest.Builder fleetId(String fleetId)

A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN value.

Parameters:

fleetId - A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN value.

Returns:

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

instanceId

DescribeInstancesRequest.Builder instanceId(String instanceId)

A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

Parameters:

instanceId - A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

Returns:

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

limit

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

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

location

DescribeInstancesRequest.Builder location(String location)

The name of a location to retrieve instance information for, in the form of an AWS Region code such as us-west-2.

Parameters:

location - The name of a location to retrieve instance information for, in the form of an AWS Region code such as us-west-2.

Returns:

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

overrideConfiguration

DescribeInstancesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder