com.amazonaws.services.gamelift.model.DescribeFleetCapacityRequest 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 DescribeFleetCapacityRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A unique identifier for the fleet to retrieve capacity information for. You can use either the fleet ID or ARN
* value. Leave this parameter empty to retrieve capacity information for all fleets.
*
*/
private java.util.List fleetIds;
/**
*
* The 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;
/**
*
* A token that indicates the start of the next sequential page of results. Use the token that is returned with a
* previous call to this operation. To start at the beginning 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;
/**
*
* A unique identifier for the fleet to retrieve capacity information for. You can use either the fleet ID or ARN
* value. Leave this parameter empty to retrieve capacity information for all fleets.
*
*
* @return A unique identifier for the fleet to retrieve capacity information for. You can use either the fleet ID
* or ARN value. Leave this parameter empty to retrieve capacity information for all fleets.
*/
public java.util.List getFleetIds() {
return fleetIds;
}
/**
*
* A unique identifier for the fleet to retrieve capacity information for. You can use either the fleet ID or ARN
* value. Leave this parameter empty to retrieve capacity information for all fleets.
*
*
* @param fleetIds
* A unique identifier for the fleet to retrieve capacity information for. You can use either the fleet ID or
* ARN value. Leave this parameter empty to retrieve capacity information for all fleets.
*/
public void setFleetIds(java.util.Collection fleetIds) {
if (fleetIds == null) {
this.fleetIds = null;
return;
}
this.fleetIds = new java.util.ArrayList(fleetIds);
}
/**
*
* A unique identifier for the fleet to retrieve capacity information for. You can use either the fleet ID or ARN
* value. Leave this parameter empty to retrieve capacity information for all fleets.
*
*
* 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
* A unique identifier for the fleet to retrieve capacity information for. You can use either the fleet ID or
* ARN value. Leave this parameter empty to retrieve capacity information for all fleets.
* @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;
}
/**
*
* A unique identifier for the fleet to retrieve capacity information for. You can use either the fleet ID or ARN
* value. Leave this parameter empty to retrieve capacity information for all fleets.
*
*
* @param fleetIds
* A unique identifier for the fleet to retrieve capacity information for. You can use either the fleet ID or
* ARN value. Leave this parameter empty to retrieve capacity information for all fleets.
* @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;
}
/**
*
* The 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
* The 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;
}
/**
*
* The 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 The 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;
}
/**
*
* The 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
* The 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;
}
/**
*
* A token that indicates the start of the next sequential page of results. Use the token that is returned with a
* previous call to this operation. To start at the beginning 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
* A token that indicates the start of the next sequential page of results. Use the token that is returned
* with a previous call to this operation. To start at the beginning 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;
}
/**
*
* A token that indicates the start of the next sequential page of results. Use the token that is returned with a
* previous call to this operation. To start at the beginning 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 A token that indicates the start of the next sequential page of results. Use the token that is returned
* with a previous call to this operation. To start at the beginning 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;
}
/**
*
* A token that indicates the start of the next sequential page of results. Use the token that is returned with a
* previous call to this operation. To start at the beginning 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
* A token that indicates the start of the next sequential page of results. Use the token that is returned
* with a previous call to this operation. To start at the beginning 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. 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 (getFleetIds() != null)
sb.append("FleetIds: ").append(getFleetIds()).append(",");
if (getLimit() != null)
sb.append("Limit: ").append(getLimit()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(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();
}
}