com.amazonaws.services.gamelift.model.DescribeGameSessionsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-gamelift Show documentation
/*
* Copyright 2011-2016 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 com.amazonaws.AmazonWebServiceRequest;
/**
*
* Represents the input for a request action.
*
*/
public class DescribeGameSessionsRequest extends AmazonWebServiceRequest
implements Serializable, Cloneable {
/**
*
* Unique identifier for a fleet. Specify a fleet to retrieve information on
* all game sessions active on the fleet.
*
*/
private String fleetId;
/**
*
* Unique identifier for a game session. Specify the game session to
* retrieve information on.
*
*/
private String gameSessionId;
/**
*
* Unique identifier for a fleet alias. Specify an alias to retrieve
* information on all game sessions active on the fleet.
*
*/
private String aliasId;
/**
*
* Game session status to filter results on. Possible game session statuses
* include ACTIVE, TERMINATED,
* ACTIVATING, and TERMINATING (the last two are
* transitory).
*
*/
private String statusFilter;
/**
*
* Maximum number of results to return. Use this parameter with
* NextToken to get results as a set of sequential pages.
*
*/
private Integer limit;
/**
*
* Token indicating the start of the next sequential page of results. Use
* the token that is returned with a previous call to this action. To
* specify the start of the result set, do not specify a value.
*
*/
private String nextToken;
/**
*
* Unique identifier for a fleet. Specify a fleet to retrieve information on
* all game sessions active on the fleet.
*
*
* @param fleetId
* Unique identifier for a fleet. Specify a fleet to retrieve
* information on all game sessions active on the fleet.
*/
public void setFleetId(String fleetId) {
this.fleetId = fleetId;
}
/**
*
* Unique identifier for a fleet. Specify a fleet to retrieve information on
* all game sessions active on the fleet.
*
*
* @return Unique identifier for a fleet. Specify a fleet to retrieve
* information on all game sessions active on the fleet.
*/
public String getFleetId() {
return this.fleetId;
}
/**
*
* Unique identifier for a fleet. Specify a fleet to retrieve information on
* all game sessions active on the fleet.
*
*
* @param fleetId
* Unique identifier for a fleet. Specify a fleet to retrieve
* information on all game sessions active on the fleet.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeGameSessionsRequest withFleetId(String fleetId) {
setFleetId(fleetId);
return this;
}
/**
*
* Unique identifier for a game session. Specify the game session to
* retrieve information on.
*
*
* @param gameSessionId
* Unique identifier for a game session. Specify the game session to
* retrieve information on.
*/
public void setGameSessionId(String gameSessionId) {
this.gameSessionId = gameSessionId;
}
/**
*
* Unique identifier for a game session. Specify the game session to
* retrieve information on.
*
*
* @return Unique identifier for a game session. Specify the game session to
* retrieve information on.
*/
public String getGameSessionId() {
return this.gameSessionId;
}
/**
*
* Unique identifier for a game session. Specify the game session to
* retrieve information on.
*
*
* @param gameSessionId
* Unique identifier for a game session. Specify the game session to
* retrieve information on.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeGameSessionsRequest withGameSessionId(String gameSessionId) {
setGameSessionId(gameSessionId);
return this;
}
/**
*
* Unique identifier for a fleet alias. Specify an alias to retrieve
* information on all game sessions active on the fleet.
*
*
* @param aliasId
* Unique identifier for a fleet alias. Specify an alias to retrieve
* information on all game sessions active on the fleet.
*/
public void setAliasId(String aliasId) {
this.aliasId = aliasId;
}
/**
*
* Unique identifier for a fleet alias. Specify an alias to retrieve
* information on all game sessions active on the fleet.
*
*
* @return Unique identifier for a fleet alias. Specify an alias to retrieve
* information on all game sessions active on the fleet.
*/
public String getAliasId() {
return this.aliasId;
}
/**
*
* Unique identifier for a fleet alias. Specify an alias to retrieve
* information on all game sessions active on the fleet.
*
*
* @param aliasId
* Unique identifier for a fleet alias. Specify an alias to retrieve
* information on all game sessions active on the fleet.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeGameSessionsRequest withAliasId(String aliasId) {
setAliasId(aliasId);
return this;
}
/**
*
* Game session status to filter results on. Possible game session statuses
* include ACTIVE, TERMINATED,
* ACTIVATING, and TERMINATING (the last two are
* transitory).
*
*
* @param statusFilter
* Game session status to filter results on. Possible game session
* statuses include ACTIVE, TERMINATED,
* ACTIVATING, and TERMINATING (the last
* two are transitory).
*/
public void setStatusFilter(String statusFilter) {
this.statusFilter = statusFilter;
}
/**
*
* Game session status to filter results on. Possible game session statuses
* include ACTIVE, TERMINATED,
* ACTIVATING, and TERMINATING (the last two are
* transitory).
*
*
* @return Game session status to filter results on. Possible game session
* statuses include ACTIVE, TERMINATED,
* ACTIVATING, and TERMINATING (the last
* two are transitory).
*/
public String getStatusFilter() {
return this.statusFilter;
}
/**
*
* Game session status to filter results on. Possible game session statuses
* include ACTIVE, TERMINATED,
* ACTIVATING, and TERMINATING (the last two are
* transitory).
*
*
* @param statusFilter
* Game session status to filter results on. Possible game session
* statuses include ACTIVE, TERMINATED,
* ACTIVATING, and TERMINATING (the last
* two are transitory).
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeGameSessionsRequest withStatusFilter(String statusFilter) {
setStatusFilter(statusFilter);
return this;
}
/**
*
* Maximum number of results to return. Use this parameter with
* NextToken to get results as a set of sequential pages.
*
*
* @param limit
* Maximum number of results to return. Use this parameter with
* NextToken to get results as a set of sequential
* pages.
*/
public void setLimit(Integer limit) {
this.limit = limit;
}
/**
*
* Maximum number of results to return. Use this parameter with
* NextToken to get results as a set of sequential pages.
*
*
* @return Maximum number of results to return. Use this parameter with
* NextToken to get results as a set of sequential
* pages.
*/
public Integer getLimit() {
return this.limit;
}
/**
*
* Maximum number of results to return. Use this parameter with
* NextToken to get results as a set of sequential pages.
*
*
* @param limit
* Maximum number of results to return. Use this parameter with
* NextToken to get results as a set of sequential
* pages.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeGameSessionsRequest withLimit(Integer limit) {
setLimit(limit);
return this;
}
/**
*
* Token indicating the start of the next sequential page of results. Use
* the token that is returned with a previous call to this action. To
* specify the start of the result set, do not specify a value.
*
*
* @param nextToken
* Token indicating the start of the next sequential page of results.
* Use the token that is returned with a previous call to this
* action. To specify the start of the result set, do not specify a
* value.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* Token indicating the start of the next sequential page of results. Use
* the token that is returned with a previous call to this action. To
* specify the start of the result set, do not specify a value.
*
*
* @return Token indicating the start of the next sequential page of
* results. Use the token that is returned with a previous call to
* this action. To specify the start of the result set, do not
* specify a value.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* Token indicating the start of the next sequential page of results. Use
* the token that is returned with a previous call to this action. To
* specify the start of the result set, do not specify a value.
*
*
* @param nextToken
* Token indicating the start of the next sequential page of results.
* Use the token that is returned with a previous call to this
* action. To specify the start of the result set, do not specify a
* value.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeGameSessionsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getFleetId() != null)
sb.append("FleetId: " + getFleetId() + ",");
if (getGameSessionId() != null)
sb.append("GameSessionId: " + getGameSessionId() + ",");
if (getAliasId() != null)
sb.append("AliasId: " + getAliasId() + ",");
if (getStatusFilter() != null)
sb.append("StatusFilter: " + getStatusFilter() + ",");
if (getLimit() != null)
sb.append("Limit: " + getLimit() + ",");
if (getNextToken() != null)
sb.append("NextToken: " + getNextToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeGameSessionsRequest == false)
return false;
DescribeGameSessionsRequest other = (DescribeGameSessionsRequest) obj;
if (other.getFleetId() == null ^ this.getFleetId() == null)
return false;
if (other.getFleetId() != null
&& other.getFleetId().equals(this.getFleetId()) == false)
return false;
if (other.getGameSessionId() == null ^ this.getGameSessionId() == null)
return false;
if (other.getGameSessionId() != null
&& other.getGameSessionId().equals(this.getGameSessionId()) == false)
return false;
if (other.getAliasId() == null ^ this.getAliasId() == null)
return false;
if (other.getAliasId() != null
&& other.getAliasId().equals(this.getAliasId()) == false)
return false;
if (other.getStatusFilter() == null ^ this.getStatusFilter() == null)
return false;
if (other.getStatusFilter() != null
&& other.getStatusFilter().equals(this.getStatusFilter()) == false)
return false;
if (other.getLimit() == null ^ this.getLimit() == null)
return false;
if (other.getLimit() != null
&& other.getLimit().equals(this.getLimit()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null
&& other.getNextToken().equals(this.getNextToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode
+ ((getFleetId() == null) ? 0 : getFleetId().hashCode());
hashCode = prime
* hashCode
+ ((getGameSessionId() == null) ? 0 : getGameSessionId()
.hashCode());
hashCode = prime * hashCode
+ ((getAliasId() == null) ? 0 : getAliasId().hashCode());
hashCode = prime
* hashCode
+ ((getStatusFilter() == null) ? 0 : getStatusFilter()
.hashCode());
hashCode = prime * hashCode
+ ((getLimit() == null) ? 0 : getLimit().hashCode());
hashCode = prime * hashCode
+ ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public DescribeGameSessionsRequest clone() {
return (DescribeGameSessionsRequest) super.clone();
}
}