Class DescribePlayerSessionsRequest

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.DescribePlayerSessionsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribePlayerSessionsRequest.Builder,DescribePlayerSessionsRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribePlayerSessionsRequest extends GameLiftRequest implements ToCopyableBuilder<DescribePlayerSessionsRequest.Builder,DescribePlayerSessionsRequest>

  • Method Details

    • gameSessionId

      public final String gameSessionId()

      A unique identifier for the game session to retrieve player sessions for.

      Returns:
      A unique identifier for the game session to retrieve player sessions for.

    • playerId

      public final String playerId()

      A unique identifier for a player to retrieve player sessions for.

      Returns:
      A unique identifier for a player to retrieve player sessions for.

    • playerSessionId

      public final String playerSessionId()

      A unique identifier for a player session to retrieve.

      Returns:
      A unique identifier for a player session to retrieve.

    • playerSessionStatusFilter

      public final String playerSessionStatusFilter()

      Player session status to filter results on. Note that when a PlayerSessionId or PlayerId is provided in a DescribePlayerSessions request, then the PlayerSessionStatusFilter has no effect on the response.

      Possible player session statuses include the following:

      • RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.

      • ACTIVE -- The player has been validated by the server process and is currently connected.

      • COMPLETED -- The player connection has been dropped.

      • TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

      Returns:
      Player session status to filter results on. Note that when a PlayerSessionId or PlayerId is provided in a DescribePlayerSessions request, then the PlayerSessionStatusFilter has no effect on the response.

      Possible player session statuses include the following:

      • RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.

      • ACTIVE -- The player has been validated by the server process and is currently connected.

      • COMPLETED -- The player connection has been dropped.

      • TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

    • 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. If a player session ID is specified, this parameter is ignored.

      Returns:
      The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.

    • 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. If a player session ID is specified, this parameter is ignored.

      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. If a player session ID is specified, this parameter is ignored.

    • toBuilder

      public DescribePlayerSessionsRequest.Builder 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 interface ToCopyableBuilder<DescribePlayerSessionsRequest.Builder,DescribePlayerSessionsRequest>
      Specified by:
      toBuilder in class GameLiftRequest
      Returns:
      a builder for type T

    • builder

      public static DescribePlayerSessionsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribePlayerSessionsRequest.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.