com.amazonaws.services.gamelift.model

Class DescribeFleetCapacityRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.gamelift.model.DescribeFleetCapacityRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeFleetCapacityRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the input for a request action.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeFleetCapacityRequest()

Method Summary

Modifier and Type	Method and Description
DescribeFleetCapacityRequest	clone()
boolean	equals(Object obj)
List<String>	getFleetIds() Unique identifier for the fleet(s) you want to retrieve capacity information for.
Integer	getLimit() Maximum number of results to return.
String	getNextToken() Token indicating the start of the next sequential page of results.
int	hashCode()
void	setFleetIds(Collection<String> fleetIds) Unique identifier for the fleet(s) you want to retrieve capacity information for.
void	setLimit(Integer limit) Maximum number of results to return.
void	setNextToken(String nextToken) Token indicating the start of the next sequential page of results.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeFleetCapacityRequest	withFleetIds(Collection<String> fleetIds) Unique identifier for the fleet(s) you want to retrieve capacity information for.
DescribeFleetCapacityRequest	withFleetIds(String... fleetIds) Unique identifier for the fleet(s) you want to retrieve capacity information for.
DescribeFleetCapacityRequest	withLimit(Integer limit) Maximum number of results to return.
DescribeFleetCapacityRequest	withNextToken(String nextToken) Token indicating the start of the next sequential page of results.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeFleetCapacityRequest

public DescribeFleetCapacityRequest()

Method Detail

getFleetIds

public List<String> getFleetIds()

Unique identifier for the fleet(s) you want to retrieve capacity information for. To request capacity information for all fleets, leave this parameter empty.

Returns:

Unique identifier for the fleet(s) you want to retrieve capacity information for. To request capacity information for all fleets, leave this parameter empty.

setFleetIds

public void setFleetIds(Collection<String> 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.

Parameters:

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.

withFleetIds

public DescribeFleetCapacityRequest withFleetIds(String... 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 setFleetIds(java.util.Collection) or withFleetIds(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withFleetIds

public DescribeFleetCapacityRequest withFleetIds(Collection<String> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setLimit

public void setLimit(Integer 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.

Parameters:

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.

getLimit

public Integer getLimit()

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.

Returns:

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.

withLimit

public DescribeFleetCapacityRequest withLimit(Integer 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(String 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.

Parameters:

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.

getNextToken

public String getNextToken()

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.

Returns:

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.

withNextToken

public DescribeFleetCapacityRequest withNextToken(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeFleetCapacityRequest clone()

Overrides:

clone in class AmazonWebServiceRequest