software.amazon.awssdk.services.gamelift.model

Class DescribeGameServerInstancesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeGameServerInstancesRequest.Builder,DescribeGameServerInstancesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeGameServerInstancesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeGameServerInstancesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	gameServerGroupName() A unique identifier for the game server group.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInstanceIds() Returns true if the InstanceIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<String>	instanceIds() The EC2 instance IDs that you want to retrieve status on.
Integer	limit() The maximum number of results to return.
String	nextToken() A token that indicates the start of the next sequential segment of results.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeGameServerInstancesRequest.Builder>	serializableBuilderClass()
DescribeGameServerInstancesRequest.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

gameServerGroupName

public String gameServerGroupName()

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Returns:

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

hasInstanceIds

public boolean hasInstanceIds()

Returns true if the InstanceIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

instanceIds

public List<String> instanceIds()

The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve all instances in the game server group, leave this parameter empty.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasInstanceIds() to see if a value was sent in this field.

Returns:

The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve all instances in the game server group, leave this parameter empty.

limit

public Integer limit()

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

Returns:

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

nextToken

public String nextToken()

A token that indicates the start of the next sequential segment of results. Use the token returned with the 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 segment of results. Use the token returned with the previous call to this operation. To start at the beginning of the result set, do not specify a value.

toBuilder

public DescribeGameServerInstancesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeGameServerInstancesRequest.Builder,DescribeGameServerInstancesRequest>

Specified by:

toBuilder in class GameLiftRequest

builder

public static DescribeGameServerInstancesRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo