com.amazonaws.services.gamelift.model

Class UpdateGameSessionQueueRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.gamelift.model.UpdateGameSessionQueueRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Represents the input for a request operation.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateGameSessionQueueRequest()

Method Summary

Modifier and Type	Method and Description
UpdateGameSessionQueueRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
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	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	setDestinations(Collection<GameSessionQueueDestination> destinations) A list of fleets that can be used to fulfill game session placement requests in the queue.
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.
UpdateGameSessionQueueRequest	withDestinations(Collection<GameSessionQueueDestination> destinations) A list of fleets that can be used to fulfill game session placement requests in the queue.
UpdateGameSessionQueueRequest	withDestinations(GameSessionQueueDestination... destinations) A list of fleets that can be used to fulfill game session placement requests in the queue.
UpdateGameSessionQueueRequest	withName(String name) A descriptive label that is associated with game session queue.
UpdateGameSessionQueueRequest	withPlayerLatencyPolicies(Collection<PlayerLatencyPolicy> playerLatencyPolicies) A collection of latency policies to apply when processing game sessions placement requests with player latency information.
UpdateGameSessionQueueRequest	withPlayerLatencyPolicies(PlayerLatencyPolicy... playerLatencyPolicies) A collection of latency policies to apply when processing game sessions placement requests with player latency information.
UpdateGameSessionQueueRequest	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

UpdateGameSessionQueueRequest

public UpdateGameSessionQueueRequest()

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. You can use either the queue ID or ARN value.

Parameters:

name - A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value.

getName

public String getName()

A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value.

Returns:

A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value.

withName

public UpdateGameSessionQueueRequest withName(String name)

A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value.

Parameters:

name - A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN 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 UpdateGameSessionQueueRequest 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. When updating policies, provide a complete collection of policies.

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. When updating policies, provide a complete collection of policies.

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. When updating policies, provide a complete collection of policies.

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. When updating policies, provide a complete collection of policies.

withPlayerLatencyPolicies

public UpdateGameSessionQueueRequest 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. When updating policies, provide a complete collection of policies.

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. When updating policies, provide a complete collection of policies.

Returns:

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

withPlayerLatencyPolicies

public UpdateGameSessionQueueRequest 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. When updating policies, provide a complete collection of policies.

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. When updating policies, provide a complete collection of policies.

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. When updating this list, provide a complete list of destinations.

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. When updating this list, provide a complete list of destinations.

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. When updating this list, provide a complete list of destinations.

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. When updating this list, provide a complete list of destinations.

withDestinations

public UpdateGameSessionQueueRequest 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. When updating this list, provide a complete list of destinations.

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. When updating this list, provide a complete list of destinations.

Returns:

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

withDestinations

public UpdateGameSessionQueueRequest 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. When updating this list, provide a complete list of destinations.

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. When updating this list, provide a complete list of destinations.

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 UpdateGameSessionQueueRequest 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()