com.amazonaws.services.gamelift.model

Class CreateGameSessionQueueRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.gamelift.model.CreateGameSessionQueueRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateGameSessionQueueRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateGameSessionQueueRequest()

Method Summary

Modifier and Type	Method and Description
CreateGameSessionQueueRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCustomEventData() Information to be 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	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.
List<Tag>	getTags() A list of labels to assign to the new game session queue resource.
Integer	getTimeoutInSeconds() The maximum time, in seconds, that a new game session placement request remains in the queue.
int	hashCode()
void	setCustomEventData(String customEventData) Information to be 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	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	setTags(Collection<Tag> tags) A list of labels to assign to the new game session queue resource.
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.
CreateGameSessionQueueRequest	withCustomEventData(String customEventData) Information to be added to all events that are related to this game session queue.
CreateGameSessionQueueRequest	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.
CreateGameSessionQueueRequest	withDestinations(GameSessionQueueDestination... destinations) A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
CreateGameSessionQueueRequest	withFilterConfiguration(FilterConfiguration filterConfiguration) A list of locations where a queue is allowed to place new game sessions.
CreateGameSessionQueueRequest	withName(String name) A descriptive label that is associated with game session queue.
CreateGameSessionQueueRequest	withNotificationTarget(String notificationTarget) An SNS topic ARN that is set up to receive game session placement notifications.
CreateGameSessionQueueRequest	withPlayerLatencyPolicies(Collection<PlayerLatencyPolicy> playerLatencyPolicies) A set of policies that act as a sliding cap on player latency.
CreateGameSessionQueueRequest	withPlayerLatencyPolicies(PlayerLatencyPolicy... playerLatencyPolicies) A set of policies that act as a sliding cap on player latency.
CreateGameSessionQueueRequest	withPriorityConfiguration(PriorityConfiguration priorityConfiguration) Custom settings to use when prioritizing destinations and locations for game session placements.
CreateGameSessionQueueRequest	withTags(Collection<Tag> tags) A list of labels to assign to the new game session queue resource.
CreateGameSessionQueueRequest	withTags(Tag... tags) A list of labels to assign to the new game session queue resource.
CreateGameSessionQueueRequest	withTimeoutInSeconds(Integer timeoutInSeconds) The maximum time, in seconds, that a new game session placement request remains in the queue.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateGameSessionQueueRequest

public CreateGameSessionQueueRequest()

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 CreateGameSessionQueueRequest 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.

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 CreateGameSessionQueueRequest 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 CreateGameSessionQueueRequest 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 CreateGameSessionQueueRequest 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 CreateGameSessionQueueRequest 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 CreateGameSessionQueueRequest 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 CreateGameSessionQueueRequest 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 CreateGameSessionQueueRequest 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 to be added to all events that are related to this game session queue.

Parameters:

customEventData - Information to be added to all events that are related to this game session queue.

getCustomEventData

public String getCustomEventData()

Information to be added to all events that are related to this game session queue.

Returns:

Information to be added to all events that are related to this game session queue.

withCustomEventData

public CreateGameSessionQueueRequest withCustomEventData(String customEventData)

Information to be added to all events that are related to this game session queue.

Parameters:

customEventData - Information to be 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 CreateGameSessionQueueRequest 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.

getTags

public List<Tag> getTags()

A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

Returns:

A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

setTags

public void setTags(Collection<Tag> tags)

A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

Parameters:

tags - A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

withTags

public CreateGameSessionQueueRequest withTags(Tag... tags)

A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateGameSessionQueueRequest withTags(Collection<Tag> tags)

A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

Parameters:

tags - A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

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 CreateGameSessionQueueRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()