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 for a game session placement mechanism that processes requests for new game sessions. A queue can be used on its own or as part of a matchmaking solution.

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)`
`String`	`getCustomEventData()` Information that is added to all events that are related to this game session queue.
`List<GameSessionQueueDestination>`	`getDestinations()` A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
`FilterConfiguration`	`getFilterConfiguration()` A list of locations where a queue is allowed to place new game sessions.
`String`	`getGameSessionQueueArn()` The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
`String`	`getName()` A descriptive label that is associated with game session queue.
`String`	`getNotificationTarget()` An SNS topic ARN that is set up to receive game session placement notifications.
`List<PlayerLatencyPolicy>`	`getPlayerLatencyPolicies()` A set of policies that act as a sliding cap on player latency.
`PriorityConfiguration`	`getPriorityConfiguration()` Custom settings to use when prioritizing destinations and locations for game session placements.
`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`	`setCustomEventData(String customEventData)` Information that is added to all events that are related to this game session queue.
`void`	`setDestinations(Collection<GameSessionQueueDestination> destinations)` A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
`void`	`setFilterConfiguration(FilterConfiguration filterConfiguration)` A list of locations where a queue is allowed to place new game sessions.
`void`	`setGameSessionQueueArn(String gameSessionQueueArn)` The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
`void`	`setName(String name)` A descriptive label that is associated with game session queue.
`void`	`setNotificationTarget(String notificationTarget)` An SNS topic ARN that is set up to receive game session placement notifications.
`void`	`setPlayerLatencyPolicies(Collection<PlayerLatencyPolicy> playerLatencyPolicies)` A set of policies that act as a sliding cap on player latency.
`void`	`setPriorityConfiguration(PriorityConfiguration priorityConfiguration)` Custom settings to use when prioritizing destinations and locations for game session placements.
`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`	`withCustomEventData(String customEventData)` Information that is added to all events that are related to this game session queue.
`GameSessionQueue`	`withDestinations(Collection<GameSessionQueueDestination> destinations)` A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
`GameSessionQueue`	`withDestinations(GameSessionQueueDestination... destinations)` A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
`GameSessionQueue`	`withFilterConfiguration(FilterConfiguration filterConfiguration)` A list of locations where a queue is allowed to place new game sessions.
`GameSessionQueue`	`withGameSessionQueueArn(String gameSessionQueueArn)` The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
`GameSessionQueue`	`withName(String name)` A descriptive label that is associated with game session queue.
`GameSessionQueue`	`withNotificationTarget(String notificationTarget)` An SNS topic ARN that is set up to receive game session placement notifications.
`GameSessionQueue`	`withPlayerLatencyPolicies(Collection<PlayerLatencyPolicy> playerLatencyPolicies)` A set of policies that act as a sliding cap on player latency.
`GameSessionQueue`	`withPlayerLatencyPolicies(PlayerLatencyPolicy... playerLatencyPolicies)` A set of policies that act as a sliding cap on player latency.
`GameSessionQueue`	`withPriorityConfiguration(PriorityConfiguration priorityConfiguration)` Custom settings to use when prioritizing destinations and locations for game session placements.
`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)
```
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. In a Amazon GameLift game session queue ARN, the resource ID matches the Name value.
    
    Parameters:
    
    gameSessionQueueArn - The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. In a Amazon GameLift game session queue ARN, the resource ID matches the Name value.
  - getGameSessionQueueArn
```
public String getGameSessionQueueArn()
```
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. In a Amazon GameLift game session queue ARN, the resource ID matches the Name value.
    
    Returns:
    
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. In a Amazon GameLift game session queue ARN, the resource ID matches the Name value.
  - withGameSessionQueueArn
```
public GameSessionQueue withGameSessionQueueArn(String gameSessionQueueArn)
```
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. In a Amazon GameLift game session queue ARN, the resource ID matches the Name value.
    
    Parameters:
    
    gameSessionQueueArn - The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. In a Amazon 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. By default, this property is set to 600.
    
    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. By default, this property is set to 600.
  - 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. By default, this property is set to 600.
    
    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. By default, this property is set to 600.
  - 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. By default, this property is set to 600.
    
    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. By default, this property is set to 600.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getPlayerLatencyPolicies
```
public List<PlayerLatencyPolicy> getPlayerLatencyPolicies()
```
    A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.
    
    Returns:
    
    A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.
  - setPlayerLatencyPolicies
```
public void setPlayerLatencyPolicies(Collection<PlayerLatencyPolicy> playerLatencyPolicies)
```
    A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.
    
    Parameters:
    
    playerLatencyPolicies - A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.
  - withPlayerLatencyPolicies
```
public GameSessionQueue withPlayerLatencyPolicies(PlayerLatencyPolicy... playerLatencyPolicies)
```
    A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.
    
    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 set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withPlayerLatencyPolicies
```
public GameSessionQueue withPlayerLatencyPolicies(Collection<PlayerLatencyPolicy> playerLatencyPolicies)
```
    A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.
    
    Parameters:
    
    playerLatencyPolicies - A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDestinations
```
public List<GameSessionQueueDestination> getDestinations()
```
    A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.
    
    Returns:
    
    A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.
  - setDestinations
```
public void setDestinations(Collection<GameSessionQueueDestination> destinations)
```
    A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.
    
    Parameters:
    
    destinations - A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.
  - withDestinations
```
public GameSessionQueue withDestinations(GameSessionQueueDestination... destinations)
```
    A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.
    
    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 and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.
    
    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 and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.
    
    Parameters:
    
    destinations - A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFilterConfiguration
```
public void setFilterConfiguration(FilterConfiguration filterConfiguration)
```
    A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location.
    
    Parameters:
    
    filterConfiguration - A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location.
  - getFilterConfiguration
```
public FilterConfiguration getFilterConfiguration()
```
    A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location.
    
    Returns:
    
    A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location.
  - withFilterConfiguration
```
public GameSessionQueue withFilterConfiguration(FilterConfiguration filterConfiguration)
```
    A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location.
    
    Parameters:
    
    filterConfiguration - A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPriorityConfiguration
```
public void setPriorityConfiguration(PriorityConfiguration priorityConfiguration)
```
    Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.
    
    Parameters:
    
    priorityConfiguration - Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.
  - getPriorityConfiguration
```
public PriorityConfiguration getPriorityConfiguration()
```
    Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.
    
    Returns:
    
    Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.
  - withPriorityConfiguration
```
public GameSessionQueue withPriorityConfiguration(PriorityConfiguration priorityConfiguration)
```
    Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.
    
    Parameters:
    
    priorityConfiguration - Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCustomEventData
```
public void setCustomEventData(String customEventData)
```
    Information that is added to all events that are related to this game session queue.
    
    Parameters:
    
    customEventData - Information that is added to all events that are related to this game session queue.
  - getCustomEventData
```
public String getCustomEventData()
```
    Information that is added to all events that are related to this game session queue.
    
    Returns:
    
    Information that is added to all events that are related to this game session queue.
  - withCustomEventData
```
public GameSessionQueue withCustomEventData(String customEventData)
```
    Information that is added to all events that are related to this game session queue.
    
    Parameters:
    
    customEventData - Information that is added to all events that are related to this game session queue.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNotificationTarget
```
public void setNotificationTarget(String notificationTarget)
```
    An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.
    
    Parameters:
    
    notificationTarget - An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.
  - getNotificationTarget
```
public String getNotificationTarget()
```
    An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.
    
    Returns:
    
    An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.
  - withNotificationTarget
```
public GameSessionQueue withNotificationTarget(String notificationTarget)
```
    An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.
    
    Parameters:
    
    notificationTarget - An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.
    
    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.

AWS SDK for Java 1.x API Reference - 1.12.780

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

setFilterConfiguration

getFilterConfiguration

withFilterConfiguration

setPriorityConfiguration

getPriorityConfiguration

withPriorityConfiguration

setCustomEventData

getCustomEventData

withCustomEventData

setNotificationTarget

getNotificationTarget

withNotificationTarget

toString

equals

hashCode

clone

marshall