com.amazonaws.services.gamelift.model.StartGameSessionPlacementRequest 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 StartGameSessionPlacementRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A unique identifier to assign to the new game session placement. This value is developer-defined. The value must
* be unique across all Regions and cannot be reused.
*
*/
private String placementId;
/**
*
* Name of the queue to use to place the new game session. You can use either the queue name or ARN value.
*
*/
private String gameSessionQueueName;
/**
*
* A set of key-value pairs that can store custom data in a game session. For example:
* {"Key": "difficulty", "Value": "novice"}.
*
*/
private java.util.List gameProperties;
/**
*
* The maximum number of players that can be connected simultaneously to the game session.
*
*/
private Integer maximumPlayerSessionCount;
/**
*
* A descriptive label that is associated with a game session. Session names do not need to be unique.
*
*/
private String gameSessionName;
/**
*
* A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when
* connected to Amazon Web Services Regions. This information is used to try to place the new game session where it
* can offer the best possible gameplay experience for the players.
*
*/
private java.util.List playerLatencies;
/**
*
* Set of information on each player to create a player session for.
*
*/
private java.util.List desiredPlayerSessions;
/**
*
* A set of custom game session properties, formatted as a single string value. This data is passed to a game server
* process in the GameSession object with a request to start a new game session (see Start a Game Session).
*
*/
private String gameSessionData;
/**
*
* A unique identifier to assign to the new game session placement. This value is developer-defined. The value must
* be unique across all Regions and cannot be reused.
*
*
* @param placementId
* A unique identifier to assign to the new game session placement. This value is developer-defined. The
* value must be unique across all Regions and cannot be reused.
*/
public void setPlacementId(String placementId) {
this.placementId = placementId;
}
/**
*
* A unique identifier to assign to the new game session placement. This value is developer-defined. The value must
* be unique across all Regions and cannot be reused.
*
*
* @return A unique identifier to assign to the new game session placement. This value is developer-defined. The
* value must be unique across all Regions and cannot be reused.
*/
public String getPlacementId() {
return this.placementId;
}
/**
*
* A unique identifier to assign to the new game session placement. This value is developer-defined. The value must
* be unique across all Regions and cannot be reused.
*
*
* @param placementId
* A unique identifier to assign to the new game session placement. This value is developer-defined. The
* value must be unique across all Regions and cannot be reused.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartGameSessionPlacementRequest withPlacementId(String placementId) {
setPlacementId(placementId);
return this;
}
/**
*
* Name of the queue to use to place the new game session. You can use either the queue name or ARN value.
*
*
* @param gameSessionQueueName
* Name of the queue to use to place the new game session. You can use either the queue name or ARN value.
*/
public void setGameSessionQueueName(String gameSessionQueueName) {
this.gameSessionQueueName = gameSessionQueueName;
}
/**
*
* Name of the queue to use to place the new game session. You can use either the queue name or ARN value.
*
*
* @return Name of the queue to use to place the new game session. You can use either the queue name or ARN value.
*/
public String getGameSessionQueueName() {
return this.gameSessionQueueName;
}
/**
*
* Name of the queue to use to place the new game session. You can use either the queue name or ARN value.
*
*
* @param gameSessionQueueName
* Name of the queue to use to place the new game session. You can use either the queue name or ARN value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartGameSessionPlacementRequest withGameSessionQueueName(String gameSessionQueueName) {
setGameSessionQueueName(gameSessionQueueName);
return this;
}
/**
*
* A set of key-value pairs that can store custom data in a game session. For example:
* {"Key": "difficulty", "Value": "novice"}.
*
*
* @return A set of key-value pairs that can store custom data in a game session. For example:
* {"Key": "difficulty", "Value": "novice"}.
*/
public java.util.List getGameProperties() {
return gameProperties;
}
/**
*
* A set of key-value pairs that can store custom data in a game session. For example:
* {"Key": "difficulty", "Value": "novice"}.
*
*
* @param gameProperties
* A set of key-value pairs that can store custom data in a game session. For example:
* {"Key": "difficulty", "Value": "novice"}.
*/
public void setGameProperties(java.util.Collection gameProperties) {
if (gameProperties == null) {
this.gameProperties = null;
return;
}
this.gameProperties = new java.util.ArrayList(gameProperties);
}
/**
*
* A set of key-value pairs that can store custom data in a game session. For example:
* {"Key": "difficulty", "Value": "novice"}.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setGameProperties(java.util.Collection)} or {@link #withGameProperties(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param gameProperties
* A set of key-value pairs that can store custom data in a game session. For example:
* {"Key": "difficulty", "Value": "novice"}.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartGameSessionPlacementRequest withGameProperties(GameProperty... gameProperties) {
if (this.gameProperties == null) {
setGameProperties(new java.util.ArrayList(gameProperties.length));
}
for (GameProperty ele : gameProperties) {
this.gameProperties.add(ele);
}
return this;
}
/**
*
* A set of key-value pairs that can store custom data in a game session. For example:
* {"Key": "difficulty", "Value": "novice"}.
*
*
* @param gameProperties
* A set of key-value pairs that can store custom data in a game session. For example:
* {"Key": "difficulty", "Value": "novice"}.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartGameSessionPlacementRequest withGameProperties(java.util.Collection gameProperties) {
setGameProperties(gameProperties);
return this;
}
/**
*
* The maximum number of players that can be connected simultaneously to the game session.
*
*
* @param maximumPlayerSessionCount
* The maximum number of players that can be connected simultaneously to the game session.
*/
public void setMaximumPlayerSessionCount(Integer maximumPlayerSessionCount) {
this.maximumPlayerSessionCount = maximumPlayerSessionCount;
}
/**
*
* The maximum number of players that can be connected simultaneously to the game session.
*
*
* @return The maximum number of players that can be connected simultaneously to the game session.
*/
public Integer getMaximumPlayerSessionCount() {
return this.maximumPlayerSessionCount;
}
/**
*
* The maximum number of players that can be connected simultaneously to the game session.
*
*
* @param maximumPlayerSessionCount
* The maximum number of players that can be connected simultaneously to the game session.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartGameSessionPlacementRequest withMaximumPlayerSessionCount(Integer maximumPlayerSessionCount) {
setMaximumPlayerSessionCount(maximumPlayerSessionCount);
return this;
}
/**
*
* A descriptive label that is associated with a game session. Session names do not need to be unique.
*
*
* @param gameSessionName
* A descriptive label that is associated with a game session. Session names do not need to be unique.
*/
public void setGameSessionName(String gameSessionName) {
this.gameSessionName = gameSessionName;
}
/**
*
* A descriptive label that is associated with a game session. Session names do not need to be unique.
*
*
* @return A descriptive label that is associated with a game session. Session names do not need to be unique.
*/
public String getGameSessionName() {
return this.gameSessionName;
}
/**
*
* A descriptive label that is associated with a game session. Session names do not need to be unique.
*
*
* @param gameSessionName
* A descriptive label that is associated with a game session. Session names do not need to be unique.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartGameSessionPlacementRequest withGameSessionName(String gameSessionName) {
setGameSessionName(gameSessionName);
return this;
}
/**
*
* A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when
* connected to Amazon Web Services Regions. This information is used to try to place the new game session where it
* can offer the best possible gameplay experience for the players.
*
*
* @return A set of values, expressed in milliseconds, that indicates the amount of latency that a player
* experiences when connected to Amazon Web Services Regions. This information is used to try to place the
* new game session where it can offer the best possible gameplay experience for the players.
*/
public java.util.List getPlayerLatencies() {
return playerLatencies;
}
/**
*
* A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when
* connected to Amazon Web Services Regions. This information is used to try to place the new game session where it
* can offer the best possible gameplay experience for the players.
*
*
* @param playerLatencies
* A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences
* when connected to Amazon Web Services Regions. This information is used to try to place the new game
* session where it can offer the best possible gameplay experience for the players.
*/
public void setPlayerLatencies(java.util.Collection playerLatencies) {
if (playerLatencies == null) {
this.playerLatencies = null;
return;
}
this.playerLatencies = new java.util.ArrayList(playerLatencies);
}
/**
*
* A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when
* connected to Amazon Web Services Regions. This information is used to try to place the new game session where it
* can offer the best possible gameplay experience for the players.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setPlayerLatencies(java.util.Collection)} or {@link #withPlayerLatencies(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param playerLatencies
* A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences
* when connected to Amazon Web Services Regions. This information is used to try to place the new game
* session where it can offer the best possible gameplay experience for the players.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartGameSessionPlacementRequest withPlayerLatencies(PlayerLatency... playerLatencies) {
if (this.playerLatencies == null) {
setPlayerLatencies(new java.util.ArrayList(playerLatencies.length));
}
for (PlayerLatency ele : playerLatencies) {
this.playerLatencies.add(ele);
}
return this;
}
/**
*
* A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when
* connected to Amazon Web Services Regions. This information is used to try to place the new game session where it
* can offer the best possible gameplay experience for the players.
*
*
* @param playerLatencies
* A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences
* when connected to Amazon Web Services Regions. This information is used to try to place the new game
* session where it can offer the best possible gameplay experience for the players.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartGameSessionPlacementRequest withPlayerLatencies(java.util.Collection playerLatencies) {
setPlayerLatencies(playerLatencies);
return this;
}
/**
*
* Set of information on each player to create a player session for.
*
*
* @return Set of information on each player to create a player session for.
*/
public java.util.List getDesiredPlayerSessions() {
return desiredPlayerSessions;
}
/**
*
* Set of information on each player to create a player session for.
*
*
* @param desiredPlayerSessions
* Set of information on each player to create a player session for.
*/
public void setDesiredPlayerSessions(java.util.Collection desiredPlayerSessions) {
if (desiredPlayerSessions == null) {
this.desiredPlayerSessions = null;
return;
}
this.desiredPlayerSessions = new java.util.ArrayList(desiredPlayerSessions);
}
/**
*
* Set of information on each player to create a player session for.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setDesiredPlayerSessions(java.util.Collection)} or
* {@link #withDesiredPlayerSessions(java.util.Collection)} if you want to override the existing values.
*
*
* @param desiredPlayerSessions
* Set of information on each player to create a player session for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartGameSessionPlacementRequest withDesiredPlayerSessions(DesiredPlayerSession... desiredPlayerSessions) {
if (this.desiredPlayerSessions == null) {
setDesiredPlayerSessions(new java.util.ArrayList(desiredPlayerSessions.length));
}
for (DesiredPlayerSession ele : desiredPlayerSessions) {
this.desiredPlayerSessions.add(ele);
}
return this;
}
/**
*
* Set of information on each player to create a player session for.
*
*
* @param desiredPlayerSessions
* Set of information on each player to create a player session for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartGameSessionPlacementRequest withDesiredPlayerSessions(java.util.Collection desiredPlayerSessions) {
setDesiredPlayerSessions(desiredPlayerSessions);
return this;
}
/**
*
* A set of custom game session properties, formatted as a single string value. This data is passed to a game server
* process in the GameSession object with a request to start a new game session (see Start a Game Session).
*
*
* @param gameSessionData
* A set of custom game session properties, formatted as a single string value. This data is passed to a game
* server process in the GameSession object with a request to start a new game session (see Start a Game Session).
*/
public void setGameSessionData(String gameSessionData) {
this.gameSessionData = gameSessionData;
}
/**
*
* A set of custom game session properties, formatted as a single string value. This data is passed to a game server
* process in the GameSession object with a request to start a new game session (see Start a Game Session).
*
*
* @return A set of custom game session properties, formatted as a single string value. This data is passed to a
* game server process in the GameSession object with a request to start a new game session
* (see Start a Game Session).
*/
public String getGameSessionData() {
return this.gameSessionData;
}
/**
*
* A set of custom game session properties, formatted as a single string value. This data is passed to a game server
* process in the GameSession object with a request to start a new game session (see Start a Game Session).
*
*
* @param gameSessionData
* A set of custom game session properties, formatted as a single string value. This data is passed to a game
* server process in the GameSession object with a request to start a new game session (see Start a Game Session).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartGameSessionPlacementRequest withGameSessionData(String gameSessionData) {
setGameSessionData(gameSessionData);
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 (getPlacementId() != null)
sb.append("PlacementId: ").append(getPlacementId()).append(",");
if (getGameSessionQueueName() != null)
sb.append("GameSessionQueueName: ").append(getGameSessionQueueName()).append(",");
if (getGameProperties() != null)
sb.append("GameProperties: ").append(getGameProperties()).append(",");
if (getMaximumPlayerSessionCount() != null)
sb.append("MaximumPlayerSessionCount: ").append(getMaximumPlayerSessionCount()).append(",");
if (getGameSessionName() != null)
sb.append("GameSessionName: ").append(getGameSessionName()).append(",");
if (getPlayerLatencies() != null)
sb.append("PlayerLatencies: ").append(getPlayerLatencies()).append(",");
if (getDesiredPlayerSessions() != null)
sb.append("DesiredPlayerSessions: ").append(getDesiredPlayerSessions()).append(",");
if (getGameSessionData() != null)
sb.append("GameSessionData: ").append(getGameSessionData());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof StartGameSessionPlacementRequest == false)
return false;
StartGameSessionPlacementRequest other = (StartGameSessionPlacementRequest) obj;
if (other.getPlacementId() == null ^ this.getPlacementId() == null)
return false;
if (other.getPlacementId() != null && other.getPlacementId().equals(this.getPlacementId()) == false)
return false;
if (other.getGameSessionQueueName() == null ^ this.getGameSessionQueueName() == null)
return false;
if (other.getGameSessionQueueName() != null && other.getGameSessionQueueName().equals(this.getGameSessionQueueName()) == false)
return false;
if (other.getGameProperties() == null ^ this.getGameProperties() == null)
return false;
if (other.getGameProperties() != null && other.getGameProperties().equals(this.getGameProperties()) == false)
return false;
if (other.getMaximumPlayerSessionCount() == null ^ this.getMaximumPlayerSessionCount() == null)
return false;
if (other.getMaximumPlayerSessionCount() != null && other.getMaximumPlayerSessionCount().equals(this.getMaximumPlayerSessionCount()) == false)
return false;
if (other.getGameSessionName() == null ^ this.getGameSessionName() == null)
return false;
if (other.getGameSessionName() != null && other.getGameSessionName().equals(this.getGameSessionName()) == false)
return false;
if (other.getPlayerLatencies() == null ^ this.getPlayerLatencies() == null)
return false;
if (other.getPlayerLatencies() != null && other.getPlayerLatencies().equals(this.getPlayerLatencies()) == false)
return false;
if (other.getDesiredPlayerSessions() == null ^ this.getDesiredPlayerSessions() == null)
return false;
if (other.getDesiredPlayerSessions() != null && other.getDesiredPlayerSessions().equals(this.getDesiredPlayerSessions()) == false)
return false;
if (other.getGameSessionData() == null ^ this.getGameSessionData() == null)
return false;
if (other.getGameSessionData() != null && other.getGameSessionData().equals(this.getGameSessionData()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getPlacementId() == null) ? 0 : getPlacementId().hashCode());
hashCode = prime * hashCode + ((getGameSessionQueueName() == null) ? 0 : getGameSessionQueueName().hashCode());
hashCode = prime * hashCode + ((getGameProperties() == null) ? 0 : getGameProperties().hashCode());
hashCode = prime * hashCode + ((getMaximumPlayerSessionCount() == null) ? 0 : getMaximumPlayerSessionCount().hashCode());
hashCode = prime * hashCode + ((getGameSessionName() == null) ? 0 : getGameSessionName().hashCode());
hashCode = prime * hashCode + ((getPlayerLatencies() == null) ? 0 : getPlayerLatencies().hashCode());
hashCode = prime * hashCode + ((getDesiredPlayerSessions() == null) ? 0 : getDesiredPlayerSessions().hashCode());
hashCode = prime * hashCode + ((getGameSessionData() == null) ? 0 : getGameSessionData().hashCode());
return hashCode;
}
@Override
public StartGameSessionPlacementRequest clone() {
return (StartGameSessionPlacementRequest) super.clone();
}
}