Class DescribeGameSessionDetailsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeGameSessionDetailsRequest.Builder,
DescribeGameSessionDetailsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
aliasId()
A unique identifier for the alias associated with the fleet to retrieve all game sessions for.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
fleetId()
A unique identifier for the fleet to retrieve all game sessions active on the fleet.final String
A unique identifier for the game session to retrieve.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final Integer
limit()
The maximum number of results to return.final String
location()
A fleet location to get game session details for.final String
A token that indicates the start of the next sequential page of results.static Class
<? extends DescribeGameSessionDetailsRequest.Builder> final String
Game session status to filter results on.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
fleetId
A unique identifier for the fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.
- Returns:
- A unique identifier for the fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.
-
gameSessionId
A unique identifier for the game session to retrieve.
- Returns:
- A unique identifier for the game session to retrieve.
-
aliasId
A unique identifier for the alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.
- Returns:
- A unique identifier for the alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.
-
location
A fleet location to get game session details for. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as
us-west-2
.- Returns:
- A fleet location to get game session details for. You can specify a fleet's home Region or a remote
location. Use the Amazon Web Services Region code format, such as
us-west-2
.
-
statusFilter
Game session status to filter results on. Possible game session statuses include
ACTIVE
,TERMINATED
,ACTIVATING
andTERMINATING
(the last two are transitory).- Returns:
- Game session status to filter results on. Possible game session statuses include
ACTIVE
,TERMINATED
,ACTIVATING
andTERMINATING
(the last two are transitory).
-
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
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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeGameSessionDetailsRequest.Builder,
DescribeGameSessionDetailsRequest> - Specified by:
toBuilder
in classGameLiftRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-