Package software.amazon.awssdk.services.gamelift.model

Class DescribeInstancesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.gamelift.model.GameLiftRequest

software.amazon.awssdk.services.gamelift.model.DescribeInstancesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeInstancesRequest.Builder,DescribeInstancesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeInstancesRequest
extends GameLiftRequest
implements ToCopyableBuilder<DescribeInstancesRequest.Builder,DescribeInstancesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeInstancesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeInstancesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fleetId()	A unique identifier for the fleet to retrieve instance information for.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	instanceId()	A unique identifier for an instance to retrieve.
Integer	limit()	The maximum number of results to return.
String	location()	The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as us-west-2.
String	nextToken()	A token that indicates the start of the next sequential page of results.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeInstancesRequest.Builder>	serializableBuilderClass()
DescribeInstancesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

fleetId

public final String fleetId()

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

Returns:

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

instanceId

public final String instanceId()

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

Returns:

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

limit

public final Integer limit()

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

Returns:

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

nextToken

public final 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.

Returns:

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.

location

public final String location()

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

Returns:

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

toBuilder

public DescribeInstancesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeInstancesRequest.Builder,DescribeInstancesRequest>

Specified by:

toBuilder in class GameLiftRequest

builder

public static DescribeInstancesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeInstancesRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo