GameSessionQueue (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.gamelift.model.GameSessionQueue

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GameSessionQueue
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Configuration of a queue that is used to process game session placement requests. The queue configuration identifies several game features:
- The destinations where a new game session can potentially be hosted. Amazon GameLift tries these destinations in an order based on either the queue's default order or player latency information, if provided in a placement request. With latency information, Amazon GameLift can place game sessions where the majority of players are reporting the lowest possible latency.
- The length of time that placement requests can wait in the queue before timing out.
- A set of optional latency policies that protect individual players from high latencies, preventing game sessions from being placed where any individual player is reporting latency higher than a policy's maximum.
See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GameSessionQueue()

Constructors
Constructor and Description
`GameSessionQueue()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GameSessionQueue`	`clone()`
`boolean`	`equals(Object obj)`
`List<GameSessionQueueDestination>`	`getDestinations()` A list of fleets that can be used to fulfill game session placement requests in the queue.
`String`	`getGameSessionQueueArn()` Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it.
`String`	`getName()` A descriptive label that is associated with game session queue.
`List<PlayerLatencyPolicy>`	`getPlayerLatencyPolicies()` A collection of latency policies to apply when processing game sessions placement requests with player latency information.
`Integer`	`getTimeoutInSeconds()` The maximum time, in seconds, that a new game session placement request remains in the queue.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDestinations(Collection<GameSessionQueueDestination> destinations)` A list of fleets that can be used to fulfill game session placement requests in the queue.
`void`	`setGameSessionQueueArn(String gameSessionQueueArn)` Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it.
`void`	`setName(String name)` A descriptive label that is associated with game session queue.
`void`	`setPlayerLatencyPolicies(Collection<PlayerLatencyPolicy> playerLatencyPolicies)` A collection of latency policies to apply when processing game sessions placement requests with player latency information.
`void`	`setTimeoutInSeconds(Integer timeoutInSeconds)` The maximum time, in seconds, that a new game session placement request remains in the queue.
`String`	`toString()` Returns a string representation of this object.
`GameSessionQueue`	`withDestinations(Collection<GameSessionQueueDestination> destinations)` A list of fleets that can be used to fulfill game session placement requests in the queue.
`GameSessionQueue`	`withDestinations(GameSessionQueueDestination... destinations)` A list of fleets that can be used to fulfill game session placement requests in the queue.
`GameSessionQueue`	`withGameSessionQueueArn(String gameSessionQueueArn)` Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it.
`GameSessionQueue`	`withName(String name)` A descriptive label that is associated with game session queue.
`GameSessionQueue`	`withPlayerLatencyPolicies(Collection<PlayerLatencyPolicy> playerLatencyPolicies)` A collection of latency policies to apply when processing game sessions placement requests with player latency information.
`GameSessionQueue`	`withPlayerLatencyPolicies(PlayerLatencyPolicy... playerLatencyPolicies)` A collection of latency policies to apply when processing game sessions placement requests with player latency information.
`GameSessionQueue`	`withTimeoutInSeconds(Integer timeoutInSeconds)` The maximum time, in seconds, that a new game session placement request remains in the queue.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GameSessionQueue
```
public GameSessionQueue()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
    
    Parameters:
    
    name - A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
  - getName
```
public String getName()
```
    A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
    
    Returns:
    
    A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
  - withName
```
public GameSessionQueue withName(String name)
```
    A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
    
    Parameters:
    
    name - A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGameSessionQueueArn
```
public void setGameSessionQueueArn(String gameSessionQueueArn)
```
    Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift game session queue ARN, the resource ID matches the Name value.
    
    Parameters:
    
    gameSessionQueueArn - Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift game session queue ARN, the resource ID matches the Name value.
  - getGameSessionQueueArn
```
public String getGameSessionQueueArn()
```
    Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift game session queue ARN, the resource ID matches the Name value.
    
    Returns:
    
    Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift game session queue ARN, the resource ID matches the Name value.
  - withGameSessionQueueArn
```
public GameSessionQueue withGameSessionQueueArn(String gameSessionQueueArn)
```
    Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift game session queue ARN, the resource ID matches the Name value.
    
    Parameters:
    
    gameSessionQueueArn - Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift game session queue ARN, the resource ID matches the Name value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeoutInSeconds
```
public void setTimeoutInSeconds(Integer timeoutInSeconds)
```
    The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.
    
    Parameters:
    
    timeoutInSeconds - The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.
  - getTimeoutInSeconds
```
public Integer getTimeoutInSeconds()
```
    The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.
    
    Returns:
    
    The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.
  - withTimeoutInSeconds
```
public GameSessionQueue withTimeoutInSeconds(Integer timeoutInSeconds)
```
    The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.
    
    Parameters:
    
    timeoutInSeconds - The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getPlayerLatencyPolicies
```
public List<PlayerLatencyPolicy> getPlayerLatencyPolicies()
```
    A collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, the policy is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement.
    
    Returns:
    
    A collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, the policy is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement.
  - setPlayerLatencyPolicies
```
public void setPlayerLatencyPolicies(Collection<PlayerLatencyPolicy> playerLatencyPolicies)
```
    A collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, the policy is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement.
    
    Parameters:
    
    playerLatencyPolicies - A collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, the policy is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement.
  - withPlayerLatencyPolicies
```
public GameSessionQueue withPlayerLatencyPolicies(PlayerLatencyPolicy... playerLatencyPolicies)
```
    A collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, the policy is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement.
    
    NOTE: This method appends the values to the existing list (if any). Use setPlayerLatencyPolicies(java.util.Collection) or withPlayerLatencyPolicies(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    playerLatencyPolicies - A collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, the policy is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withPlayerLatencyPolicies
```
public GameSessionQueue withPlayerLatencyPolicies(Collection<PlayerLatencyPolicy> playerLatencyPolicies)
```
    A collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, the policy is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement.
    
    Parameters:
    
    playerLatencyPolicies - A collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, the policy is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDestinations
```
public List<GameSessionQueueDestination> getDestinations()
```
    A list of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.
    
    Returns:
    
    A list of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.
  - setDestinations
```
public void setDestinations(Collection<GameSessionQueueDestination> destinations)
```
    A list of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.
    
    Parameters:
    
    destinations - A list of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.
  - withDestinations
```
public GameSessionQueue withDestinations(GameSessionQueueDestination... destinations)
```
    A list of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.
    
    NOTE: This method appends the values to the existing list (if any). Use setDestinations(java.util.Collection) or withDestinations(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    destinations - A list of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDestinations
```
public GameSessionQueue withDestinations(Collection<GameSessionQueueDestination> destinations)
```
    A list of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.
    
    Parameters:
    
    destinations - A list of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GameSessionQueue clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class GameSessionQueue

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GameSessionQueue

Method Detail

setName

getName

withName

setGameSessionQueueArn

getGameSessionQueueArn

withGameSessionQueueArn

setTimeoutInSeconds

getTimeoutInSeconds

withTimeoutInSeconds

getPlayerLatencyPolicies

setPlayerLatencyPolicies

withPlayerLatencyPolicies

withPlayerLatencyPolicies

getDestinations

setDestinations

withDestinations

withDestinations

toString

equals

hashCode

clone

marshall