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 used to process game session placement requests. The queue configuration identifies the fleets that new game session can be placed on, given available resources, and the length of time a request can remain in the queue waiting for placement.

Queue-related operations include:
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()` List of fleets that can be used to fulfill game session placement requests in the queue.
`String`	`getName()` Descriptive label that is associated with queue.
`Integer`	`getTimeoutInSeconds()` 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)` List of fleets that can be used to fulfill game session placement requests in the queue.
`void`	`setName(String name)` Descriptive label that is associated with queue.
`void`	`setTimeoutInSeconds(Integer timeoutInSeconds)` Maximum time, in seconds, that a new game session placement request remains in the queue.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`GameSessionQueue`	`withDestinations(Collection<GameSessionQueueDestination> destinations)` List of fleets that can be used to fulfill game session placement requests in the queue.
`GameSessionQueue`	`withDestinations(GameSessionQueueDestination... destinations)` List of fleets that can be used to fulfill game session placement requests in the queue.
`GameSessionQueue`	`withName(String name)` Descriptive label that is associated with queue.
`GameSessionQueue`	`withTimeoutInSeconds(Integer timeoutInSeconds)` 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)
```
    Descriptive label that is associated with queue. Queue names must be unique within each region.
    
    Parameters:
    
    name - Descriptive label that is associated with queue. Queue names must be unique within each region.
  - getName
```
public String getName()
```
    Descriptive label that is associated with queue. Queue names must be unique within each region.
    
    Returns:
    
    Descriptive label that is associated with queue. Queue names must be unique within each region.
  - withName
```
public GameSessionQueue withName(String name)
```
    Descriptive label that is associated with queue. Queue names must be unique within each region.
    
    Parameters:
    
    name - Descriptive label that is associated with queue. Queue names must be unique within each region.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeoutInSeconds
```
public void setTimeoutInSeconds(Integer timeoutInSeconds)
```
    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 - 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()
```
    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:
    
    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)
```
    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 - 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.
  - getDestinations
```
public List<GameSessionQueueDestination> getDestinations()
```
    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:
    
    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)
```
    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 - 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)
```
    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 - 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)
```
    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 - 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; useful for testing and debugging.
    
    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

setTimeoutInSeconds

getTimeoutInSeconds

withTimeoutInSeconds

getDestinations

setDestinations

withDestinations

withDestinations

toString

equals

hashCode

clone

marshall