Interface DescribeScalingPoliciesRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<DescribeScalingPoliciesRequest.Builder,DescribeScalingPoliciesRequest>, GameLiftRequest.Builder, SdkBuilder<DescribeScalingPoliciesRequest.Builder,DescribeScalingPoliciesRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DescribeScalingPoliciesRequest

public static interface DescribeScalingPoliciesRequest.Builder extends GameLiftRequest.Builder, SdkPojo, CopyableBuilder<DescribeScalingPoliciesRequest.Builder,DescribeScalingPoliciesRequest>
  • Method Details

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

      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

      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.
    • overrideConfiguration

      DescribeScalingPoliciesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.