Class DescribeScalingPoliciesRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Represents the input for a request action.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
Unique identifier for a fleet.getLimit()
Maximum number of results to return.Token indicating the start of the next sequential page of results.Game session status to filter results on.int
hashCode()
void
setFleetId
(String fleetId) Unique identifier for a fleet.void
Maximum number of results to return.void
setNextToken
(String nextToken) Token indicating the start of the next sequential page of results.void
setStatusFilter
(ScalingStatusType statusFilter) Game session status to filter results on.void
setStatusFilter
(String statusFilter) Game session status to filter results on.toString()
Returns a string representation of this object; useful for testing and debugging.withFleetId
(String fleetId) Unique identifier for a fleet.Maximum number of results to return.withNextToken
(String nextToken) Token indicating the start of the next sequential page of results.withStatusFilter
(ScalingStatusType statusFilter) Game session status to filter results on.withStatusFilter
(String statusFilter) Game session status to filter results on.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
-
Constructor Details
-
DescribeScalingPoliciesRequest
public DescribeScalingPoliciesRequest()
-
-
Method Details
-
setFleetId
Unique identifier for a fleet. Specify the fleet to retrieve scaling policies for.
- Parameters:
fleetId
- Unique identifier for a fleet. Specify the fleet to retrieve scaling policies for.
-
getFleetId
Unique identifier for a fleet. Specify the fleet to retrieve scaling policies for.
- Returns:
- Unique identifier for a fleet. Specify the fleet to retrieve scaling policies for.
-
withFleetId
Unique identifier for a fleet. Specify the fleet to retrieve scaling policies for.
- Parameters:
fleetId
- Unique identifier for a fleet. Specify the fleet to retrieve scaling policies for.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStatusFilter
Game session status to filter results on. A scaling policy is only in force when in an Active state.
- ACTIVE: The scaling policy is currently in force.
- UPDATEREQUESTED: A request to update the scaling policy has been received.
- UPDATING: A change is being made to the scaling policy.
- DELETEREQUESTED: A request to delete the scaling policy has been received.
- DELETING: The scaling policy is being deleted.
- DELETED: The scaling policy has been deleted.
- ERROR: An error occurred in creating the policy. It should be removed and recreated.
- Parameters:
statusFilter
- Game session status to filter results on. A scaling policy is only in force when in an Active state.- ACTIVE: The scaling policy is currently in force.
- UPDATEREQUESTED: A request to update the scaling policy has been received.
- UPDATING: A change is being made to the scaling policy.
- DELETEREQUESTED: A request to delete the scaling policy has been received.
- DELETING: The scaling policy is being deleted.
- DELETED: The scaling policy has been deleted.
- ERROR: An error occurred in creating the policy. It should be removed and recreated.
- See Also:
-
getStatusFilter
Game session status to filter results on. A scaling policy is only in force when in an Active state.
- ACTIVE: The scaling policy is currently in force.
- UPDATEREQUESTED: A request to update the scaling policy has been received.
- UPDATING: A change is being made to the scaling policy.
- DELETEREQUESTED: A request to delete the scaling policy has been received.
- DELETING: The scaling policy is being deleted.
- DELETED: The scaling policy has been deleted.
- ERROR: An error occurred in creating the policy. It should be removed and recreated.
- Returns:
- Game session status to filter results on. A scaling policy is
only in force when in an Active state.
- ACTIVE: The scaling policy is currently in force.
- UPDATEREQUESTED: A request to update the scaling policy has been received.
- UPDATING: A change is being made to the scaling policy.
- DELETEREQUESTED: A request to delete the scaling policy has been received.
- DELETING: The scaling policy is being deleted.
- DELETED: The scaling policy has been deleted.
- ERROR: An error occurred in creating the policy. It should be removed and recreated.
- See Also:
-
withStatusFilter
Game session status to filter results on. A scaling policy is only in force when in an Active state.
- ACTIVE: The scaling policy is currently in force.
- UPDATEREQUESTED: A request to update the scaling policy has been received.
- UPDATING: A change is being made to the scaling policy.
- DELETEREQUESTED: A request to delete the scaling policy has been received.
- DELETING: The scaling policy is being deleted.
- DELETED: The scaling policy has been deleted.
- ERROR: An error occurred in creating the policy. It should be removed and recreated.
- Parameters:
statusFilter
- Game session status to filter results on. A scaling policy is only in force when in an Active state.- ACTIVE: The scaling policy is currently in force.
- UPDATEREQUESTED: A request to update the scaling policy has been received.
- UPDATING: A change is being made to the scaling policy.
- DELETEREQUESTED: A request to delete the scaling policy has been received.
- DELETING: The scaling policy is being deleted.
- DELETED: The scaling policy has been deleted.
- ERROR: An error occurred in creating the policy. It should be removed and recreated.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setStatusFilter
Game session status to filter results on. A scaling policy is only in force when in an Active state.
- ACTIVE: The scaling policy is currently in force.
- UPDATEREQUESTED: A request to update the scaling policy has been received.
- UPDATING: A change is being made to the scaling policy.
- DELETEREQUESTED: A request to delete the scaling policy has been received.
- DELETING: The scaling policy is being deleted.
- DELETED: The scaling policy has been deleted.
- ERROR: An error occurred in creating the policy. It should be removed and recreated.
- Parameters:
statusFilter
- Game session status to filter results on. A scaling policy is only in force when in an Active state.- ACTIVE: The scaling policy is currently in force.
- UPDATEREQUESTED: A request to update the scaling policy has been received.
- UPDATING: A change is being made to the scaling policy.
- DELETEREQUESTED: A request to delete the scaling policy has been received.
- DELETING: The scaling policy is being deleted.
- DELETED: The scaling policy has been deleted.
- ERROR: An error occurred in creating the policy. It should be removed and recreated.
- See Also:
-
withStatusFilter
Game session status to filter results on. A scaling policy is only in force when in an Active state.
- ACTIVE: The scaling policy is currently in force.
- UPDATEREQUESTED: A request to update the scaling policy has been received.
- UPDATING: A change is being made to the scaling policy.
- DELETEREQUESTED: A request to delete the scaling policy has been received.
- DELETING: The scaling policy is being deleted.
- DELETED: The scaling policy has been deleted.
- ERROR: An error occurred in creating the policy. It should be removed and recreated.
- Parameters:
statusFilter
- Game session status to filter results on. A scaling policy is only in force when in an Active state.- ACTIVE: The scaling policy is currently in force.
- UPDATEREQUESTED: A request to update the scaling policy has been received.
- UPDATING: A change is being made to the scaling policy.
- DELETEREQUESTED: A request to delete the scaling policy has been received.
- DELETING: The scaling policy is being deleted.
- DELETED: The scaling policy has been deleted.
- ERROR: An error occurred in creating the policy. It should be removed and recreated.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setLimit
Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.
- Parameters:
limit
- Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.
-
getLimit
Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.
- Returns:
- Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.
-
withLimit
Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.
- Parameters:
limit
- Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNextToken
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.
- 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.
-
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.
- 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.
-
withNextToken
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.
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-