com.amazonaws.services.gamelift.model.DescribeFleetCapacityRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osgi 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 DescribeFleetCapacityRequest extends AmazonWebServiceRequest
implements Serializable, Cloneable {
/**
*
* Unique identifier for the fleet(s) you want to retrieve capacity
* information for. To request capacity information for all fleets, leave
* this parameter empty.
*
*/
private java.util.List fleetIds;
/**
*
* Maximum number of results to return. Use this parameter with
* NextToken to get results as a set of sequential pages. This
* parameter is ignored when the request specifies one or a list of fleet
* IDs.
*
*/
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. This
* parameter is ignored when the request specifies one or a list of fleet
* IDs.
*
*/
private String nextToken;
/**
*
* Unique identifier for the fleet(s) you want to retrieve capacity
* information for. To request capacity information for all fleets, leave
* this parameter empty.
*
*
* @return Unique identifier for the fleet(s) you want to retrieve capacity
* information for. To request capacity information for all fleets,
* leave this parameter empty.
*/
public java.util.List getFleetIds() {
return fleetIds;
}
/**
*
* Unique identifier for the fleet(s) you want to retrieve capacity
* information for. To request capacity information for all fleets, leave
* this parameter empty.
*
*
* @param fleetIds
* Unique identifier for the fleet(s) you want to retrieve capacity
* information for. To request capacity information for all fleets,
* leave this parameter empty.
*/
public void setFleetIds(java.util.Collection fleetIds) {
if (fleetIds == null) {
this.fleetIds = null;
return;
}
this.fleetIds = new java.util.ArrayList(fleetIds);
}
/**
*
* Unique identifier for the fleet(s) you want to retrieve capacity
* information for. To request capacity information for all fleets, leave
* this parameter empty.
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setFleetIds(java.util.Collection)} or
* {@link #withFleetIds(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param fleetIds
* Unique identifier for the fleet(s) you want to retrieve capacity
* information for. To request capacity information for all fleets,
* leave this parameter empty.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeFleetCapacityRequest withFleetIds(String... fleetIds) {
if (this.fleetIds == null) {
setFleetIds(new java.util.ArrayList(fleetIds.length));
}
for (String ele : fleetIds) {
this.fleetIds.add(ele);
}
return this;
}
/**
*
* Unique identifier for the fleet(s) you want to retrieve capacity
* information for. To request capacity information for all fleets, leave
* this parameter empty.
*
*
* @param fleetIds
* Unique identifier for the fleet(s) you want to retrieve capacity
* information for. To request capacity information for all fleets,
* leave this parameter empty.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeFleetCapacityRequest withFleetIds(
java.util.Collection fleetIds) {
setFleetIds(fleetIds);
return this;
}
/**
*
* Maximum number of results to return. Use this parameter with
* NextToken to get results as a set of sequential pages. This
* parameter is ignored when the request specifies one or a list of fleet
* IDs.
*
*
* @param limit
* Maximum number of results to return. Use this parameter with
* NextToken to get results as a set of sequential
* pages. This parameter is ignored when the request specifies one or
* a list of fleet IDs.
*/
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. This
* parameter is ignored when the request specifies one or a list of fleet
* IDs.
*
*
* @return Maximum number of results to return. Use this parameter with
* NextToken to get results as a set of sequential
* pages. This parameter is ignored when the request specifies one
* or a list of fleet IDs.
*/
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. This
* parameter is ignored when the request specifies one or a list of fleet
* IDs.
*
*
* @param limit
* Maximum number of results to return. Use this parameter with
* NextToken to get results as a set of sequential
* pages. This parameter is ignored when the request specifies one or
* a list of fleet IDs.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeFleetCapacityRequest 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. This
* parameter is ignored when the request specifies one or a list of fleet
* IDs.
*
*
* @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. This parameter is ignored when the request specifies one or
* a list of fleet IDs.
*/
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. This
* parameter is ignored when the request specifies one or a list of fleet
* IDs.
*
*
* @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. This parameter is ignored when the request
* specifies one or a list of fleet IDs.
*/
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. This
* parameter is ignored when the request specifies one or a list of fleet
* IDs.
*
*
* @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. This parameter is ignored when the request specifies one or
* a list of fleet IDs.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeFleetCapacityRequest 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 (getFleetIds() != null)
sb.append("FleetIds: " + getFleetIds() + ",");
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 DescribeFleetCapacityRequest == false)
return false;
DescribeFleetCapacityRequest other = (DescribeFleetCapacityRequest) obj;
if (other.getFleetIds() == null ^ this.getFleetIds() == null)
return false;
if (other.getFleetIds() != null
&& other.getFleetIds().equals(this.getFleetIds()) == 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
+ ((getFleetIds() == null) ? 0 : getFleetIds().hashCode());
hashCode = prime * hashCode
+ ((getLimit() == null) ? 0 : getLimit().hashCode());
hashCode = prime * hashCode
+ ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public DescribeFleetCapacityRequest clone() {
return (DescribeFleetCapacityRequest) super.clone();
}
}