Class DescribeScalingPoliciesRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.gamelift.model.DescribeScalingPoliciesRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class DescribeScalingPoliciesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

Represents the input for a request action.

See Also:
  • Constructor Details

    • DescribeScalingPoliciesRequest

      public DescribeScalingPoliciesRequest()
  • Method Details

    • setFleetId

      public void setFleetId(String fleetId)

      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

      public String 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

      public DescribeScalingPoliciesRequest withFleetId(String fleetId)

      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

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

      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

      public String 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

      public DescribeScalingPoliciesRequest withStatusFilter(String 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.

      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

      public void setStatusFilter(ScalingStatusType 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.

      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

      public DescribeScalingPoliciesRequest withStatusFilter(ScalingStatusType 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.

      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

      public void setLimit(Integer limit)

      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

      public Integer 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

      public DescribeScalingPoliciesRequest withLimit(Integer limit)

      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

      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.

      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

      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.

      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

      public DescribeScalingPoliciesRequest 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.

      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

      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:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • 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 class AmazonWebServiceRequest
      See Also: