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

Represents the input for a request action.

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)
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.
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	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	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	withDestinations(Collection<GameSessionQueueDestination> destinations) A list of fleets that can be used to fulfill game session placement requests in the queue.
CreateGameSessionQueueRequest	withDestinations(GameSessionQueueDestination... destinations) A list of fleets that can be used to fulfill game session placement requests in the queue.
CreateGameSessionQueueRequest	withName(String name) A descriptive label that is associated with game session queue.
CreateGameSessionQueueRequest	withPlayerLatencyPolicies(Collection<PlayerLatencyPolicy> playerLatencyPolicies) A collection of latency policies to apply when processing game sessions placement requests with player latency information.
CreateGameSessionQueueRequest	withPlayerLatencyPolicies(PlayerLatencyPolicy... playerLatencyPolicies) A collection of latency policies to apply when processing game sessions placement requests with player latency information.
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.

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

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. A player latency policy must set a value for MaximumIndividualPlayerLatencyMilliseconds. If none is set, this API request fails.

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. A player latency policy must set a value for MaximumIndividualPlayerLatencyMilliseconds. If none is set, this API request fails.

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. A player latency policy must set a value for MaximumIndividualPlayerLatencyMilliseconds. If none is set, this API request fails.

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. A player latency policy must set a value for MaximumIndividualPlayerLatencyMilliseconds. If none is set, this API request fails.

withPlayerLatencyPolicies

public CreateGameSessionQueueRequest 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. A player latency policy must set a value for MaximumIndividualPlayerLatencyMilliseconds. If none is set, this API request fails.

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. A player latency policy must set a value for MaximumIndividualPlayerLatencyMilliseconds. If none is set, this API request fails.

Returns:

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

withPlayerLatencyPolicies

public CreateGameSessionQueueRequest 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. A player latency policy must set a value for MaximumIndividualPlayerLatencyMilliseconds. If none is set, this API request fails.

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. A player latency policy must set a value for MaximumIndividualPlayerLatencyMilliseconds. If none is set, this API request fails.

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

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 AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Returns:

A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

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 AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Parameters:

tags - A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

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 AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

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 AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

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 AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Parameters:

tags - A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

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