Package software.amazon.awssdk.services.gamelift.model

Interface DescribeScalingPoliciesRequest.Builder

    • Method Detail

      • fleetId

        DescribeScalingPoliciesRequest.Builder fleetId​(String fleetId)

        A unique identifier for the fleet for which to retrieve scaling policies. You can use either the fleet ID or ARN value.

        Parameters:
        fleetId - A unique identifier for the fleet for which to retrieve scaling policies. You can use either the fleet ID or ARN value.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • statusFilter

        DescribeScalingPoliciesRequest.Builder statusFilter​(String statusFilter)

        Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE status.

        • 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 - Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE status.

        • 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:
        ScalingStatusType, ScalingStatusType

      • statusFilter

        DescribeScalingPoliciesRequest.Builder statusFilter​(ScalingStatusType statusFilter)

        Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE status.

        • 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 - Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE status.

        • 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:
        ScalingStatusType, ScalingStatusType

      • limit

        DescribeScalingPoliciesRequest.Builder limit​(Integer limit)

        The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

        Parameters:
        limit - The maximum number of results to return. 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.

      • nextToken

        DescribeScalingPoliciesRequest.Builder nextToken​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • location

        DescribeScalingPoliciesRequest.Builder location​(String location)

        The fleet location. If you don't specify this value, the response contains the scaling policies of every location in the fleet.

        Parameters:
        location - The fleet location. If you don't specify this value, the response contains the scaling policies of every location in the fleet.
        Returns:
        Returns a reference to this object so that method calls can be chained together.