com.amazonaws.services.gamelift.model.UpdateGameSessionQueueRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-gamelift Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.gamelift.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class UpdateGameSessionQueueRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* 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.
*
*/
private String name;
/**
*
* 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.
*
*/
private Integer timeoutInSeconds;
/**
*
* 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. When
* updating policies, provide a complete collection of policies.
*
*/
private java.util.List playerLatencyPolicies;
/**
*
* 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. When updating this list, provide a complete list of destinations.
*
*/
private java.util.List destinations;
/**
*
* 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. To remove an existing filter configuration, pass in an empty set.
*
*/
private FilterConfiguration filterConfiguration;
/**
*
* 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. To remove an existing priority
* configuration, pass in an empty set.
*
*/
private PriorityConfiguration priorityConfiguration;
/**
*
* Information to be added to all events that are related to this game session queue.
*
*/
private String customEventData;
/**
*
* An SNS topic ARN that is set up to receive game session placement notifications. See Setting up
* notifications for game session placement.
*
*/
private String notificationTarget;
/**
*
* 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.
*
*
* @param 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.
*/
public void setName(String name) {
this.name = 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.
*
*
* @return 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.
*/
public String getName() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateGameSessionQueueRequest withName(String name) {
setName(name);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setTimeoutInSeconds(Integer timeoutInSeconds) {
this.timeoutInSeconds = 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.
*
*
* @return 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.
*/
public Integer getTimeoutInSeconds() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateGameSessionQueueRequest withTimeoutInSeconds(Integer timeoutInSeconds) {
setTimeoutInSeconds(timeoutInSeconds);
return this;
}
/**
*
* 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. When
* updating policies, provide a complete collection of policies.
*
*
* @return 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. When updating policies, provide a complete collection of policies.
*/
public java.util.List getPlayerLatencyPolicies() {
return 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. When
* updating policies, provide a complete collection of policies.
*
*
* @param 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. When updating policies, provide a complete collection of policies.
*/
public void setPlayerLatencyPolicies(java.util.Collection playerLatencyPolicies) {
if (playerLatencyPolicies == null) {
this.playerLatencyPolicies = null;
return;
}
this.playerLatencyPolicies = new java.util.ArrayList(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. When
* updating policies, provide a complete collection of policies.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setPlayerLatencyPolicies(java.util.Collection)} or
* {@link #withPlayerLatencyPolicies(java.util.Collection)} if you want to override the existing values.
*
*
* @param 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. When updating policies, provide a complete collection of policies.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateGameSessionQueueRequest withPlayerLatencyPolicies(PlayerLatencyPolicy... playerLatencyPolicies) {
if (this.playerLatencyPolicies == null) {
setPlayerLatencyPolicies(new java.util.ArrayList(playerLatencyPolicies.length));
}
for (PlayerLatencyPolicy ele : playerLatencyPolicies) {
this.playerLatencyPolicies.add(ele);
}
return this;
}
/**
*
* 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. When
* updating policies, provide a complete collection of policies.
*
*
* @param 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. When updating policies, provide a complete collection of policies.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateGameSessionQueueRequest withPlayerLatencyPolicies(java.util.Collection playerLatencyPolicies) {
setPlayerLatencyPolicies(playerLatencyPolicies);
return this;
}
/**
*
* 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. When updating this list, provide a complete list of destinations.
*
*
* @return 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. When updating this list, provide a complete list of destinations.
*/
public java.util.List getDestinations() {
return 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. When updating this list, provide a complete list of destinations.
*
*
* @param 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. When updating this list, provide a complete list of destinations.
*/
public void setDestinations(java.util.Collection destinations) {
if (destinations == null) {
this.destinations = null;
return;
}
this.destinations = new java.util.ArrayList(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. When updating this list, provide a complete list of destinations.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setDestinations(java.util.Collection)} or {@link #withDestinations(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param 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. When updating this list, provide a complete list of destinations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateGameSessionQueueRequest withDestinations(GameSessionQueueDestination... destinations) {
if (this.destinations == null) {
setDestinations(new java.util.ArrayList(destinations.length));
}
for (GameSessionQueueDestination ele : destinations) {
this.destinations.add(ele);
}
return this;
}
/**
*
* 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. When updating this list, provide a complete list of destinations.
*
*
* @param 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. When updating this list, provide a complete list of destinations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateGameSessionQueueRequest withDestinations(java.util.Collection destinations) {
setDestinations(destinations);
return this;
}
/**
*
* 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. To remove an existing filter configuration, pass in an empty set.
*
*
* @param 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. To remove an existing filter configuration, pass in an
* empty set.
*/
public void setFilterConfiguration(FilterConfiguration filterConfiguration) {
this.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. To remove an existing filter configuration, pass in an empty set.
*
*
* @return 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. To remove an existing filter configuration, pass in an
* empty set.
*/
public FilterConfiguration getFilterConfiguration() {
return this.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. To remove an existing filter configuration, pass in an empty set.
*
*
* @param 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. To remove an existing filter configuration, pass in an
* empty set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateGameSessionQueueRequest withFilterConfiguration(FilterConfiguration filterConfiguration) {
setFilterConfiguration(filterConfiguration);
return this;
}
/**
*
* 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. To remove an existing priority
* configuration, pass in an empty set.
*
*
* @param 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. To remove an existing
* priority configuration, pass in an empty set.
*/
public void setPriorityConfiguration(PriorityConfiguration priorityConfiguration) {
this.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. To remove an existing priority
* configuration, pass in an empty set.
*
*
* @return 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. To remove an existing
* priority configuration, pass in an empty set.
*/
public PriorityConfiguration getPriorityConfiguration() {
return this.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. To remove an existing priority
* configuration, pass in an empty set.
*
*
* @param 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. To remove an existing
* priority configuration, pass in an empty set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateGameSessionQueueRequest withPriorityConfiguration(PriorityConfiguration priorityConfiguration) {
setPriorityConfiguration(priorityConfiguration);
return this;
}
/**
*
* Information to be added to all events that are related to this game session queue.
*
*
* @param customEventData
* Information to be added to all events that are related to this game session queue.
*/
public void setCustomEventData(String customEventData) {
this.customEventData = customEventData;
}
/**
*
* Information to be added to all events that are related to this game session queue.
*
*
* @return Information to be added to all events that are related to this game session queue.
*/
public String getCustomEventData() {
return this.customEventData;
}
/**
*
* Information to be added to all events that are related to this game session queue.
*
*
* @param customEventData
* Information to be added to all events that are related to this game session queue.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateGameSessionQueueRequest withCustomEventData(String customEventData) {
setCustomEventData(customEventData);
return this;
}
/**
*
* An SNS topic ARN that is set up to receive game session placement notifications. See Setting up
* notifications for game session placement.
*
*
* @param notificationTarget
* An SNS topic ARN that is set up to receive game session placement notifications. See Setting up
* notifications for game session placement.
*/
public void setNotificationTarget(String notificationTarget) {
this.notificationTarget = notificationTarget;
}
/**
*
* An SNS topic ARN that is set up to receive game session placement notifications. See Setting up
* notifications for game session placement.
*
*
* @return An SNS topic ARN that is set up to receive game session placement notifications. See Setting up
* notifications for game session placement.
*/
public String getNotificationTarget() {
return this.notificationTarget;
}
/**
*
* An SNS topic ARN that is set up to receive game session placement notifications. See Setting up
* notifications for game session placement.
*
*
* @param notificationTarget
* An SNS topic ARN that is set up to receive game session placement notifications. See Setting up
* notifications for game session placement.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateGameSessionQueueRequest withNotificationTarget(String notificationTarget) {
setNotificationTarget(notificationTarget);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getTimeoutInSeconds() != null)
sb.append("TimeoutInSeconds: ").append(getTimeoutInSeconds()).append(",");
if (getPlayerLatencyPolicies() != null)
sb.append("PlayerLatencyPolicies: ").append(getPlayerLatencyPolicies()).append(",");
if (getDestinations() != null)
sb.append("Destinations: ").append(getDestinations()).append(",");
if (getFilterConfiguration() != null)
sb.append("FilterConfiguration: ").append(getFilterConfiguration()).append(",");
if (getPriorityConfiguration() != null)
sb.append("PriorityConfiguration: ").append(getPriorityConfiguration()).append(",");
if (getCustomEventData() != null)
sb.append("CustomEventData: ").append(getCustomEventData()).append(",");
if (getNotificationTarget() != null)
sb.append("NotificationTarget: ").append(getNotificationTarget());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof UpdateGameSessionQueueRequest == false)
return false;
UpdateGameSessionQueueRequest other = (UpdateGameSessionQueueRequest) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getTimeoutInSeconds() == null ^ this.getTimeoutInSeconds() == null)
return false;
if (other.getTimeoutInSeconds() != null && other.getTimeoutInSeconds().equals(this.getTimeoutInSeconds()) == false)
return false;
if (other.getPlayerLatencyPolicies() == null ^ this.getPlayerLatencyPolicies() == null)
return false;
if (other.getPlayerLatencyPolicies() != null && other.getPlayerLatencyPolicies().equals(this.getPlayerLatencyPolicies()) == false)
return false;
if (other.getDestinations() == null ^ this.getDestinations() == null)
return false;
if (other.getDestinations() != null && other.getDestinations().equals(this.getDestinations()) == false)
return false;
if (other.getFilterConfiguration() == null ^ this.getFilterConfiguration() == null)
return false;
if (other.getFilterConfiguration() != null && other.getFilterConfiguration().equals(this.getFilterConfiguration()) == false)
return false;
if (other.getPriorityConfiguration() == null ^ this.getPriorityConfiguration() == null)
return false;
if (other.getPriorityConfiguration() != null && other.getPriorityConfiguration().equals(this.getPriorityConfiguration()) == false)
return false;
if (other.getCustomEventData() == null ^ this.getCustomEventData() == null)
return false;
if (other.getCustomEventData() != null && other.getCustomEventData().equals(this.getCustomEventData()) == false)
return false;
if (other.getNotificationTarget() == null ^ this.getNotificationTarget() == null)
return false;
if (other.getNotificationTarget() != null && other.getNotificationTarget().equals(this.getNotificationTarget()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getTimeoutInSeconds() == null) ? 0 : getTimeoutInSeconds().hashCode());
hashCode = prime * hashCode + ((getPlayerLatencyPolicies() == null) ? 0 : getPlayerLatencyPolicies().hashCode());
hashCode = prime * hashCode + ((getDestinations() == null) ? 0 : getDestinations().hashCode());
hashCode = prime * hashCode + ((getFilterConfiguration() == null) ? 0 : getFilterConfiguration().hashCode());
hashCode = prime * hashCode + ((getPriorityConfiguration() == null) ? 0 : getPriorityConfiguration().hashCode());
hashCode = prime * hashCode + ((getCustomEventData() == null) ? 0 : getCustomEventData().hashCode());
hashCode = prime * hashCode + ((getNotificationTarget() == null) ? 0 : getNotificationTarget().hashCode());
return hashCode;
}
@Override
public UpdateGameSessionQueueRequest clone() {
return (UpdateGameSessionQueueRequest) super.clone();
}
}