Interface DescribeScalingPoliciesRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribeScalingPoliciesRequest.Builder,
,DescribeScalingPoliciesRequest> GameLiftRequest.Builder
,SdkBuilder<DescribeScalingPoliciesRequest.Builder,
,DescribeScalingPoliciesRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
DescribeScalingPoliciesRequest
-
Method Summary
Modifier and TypeMethodDescriptionA unique identifier for the fleet for which to retrieve scaling policies.The maximum number of results to return.The fleet location.A token that indicates the start of the next sequential page of results.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.statusFilter
(String statusFilter) Scaling policy status to filter results on.statusFilter
(ScalingStatusType statusFilter) Scaling policy status to filter results on.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.gamelift.model.GameLiftRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
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
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 anACTIVE
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 anACTIVE
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 withNextToken
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 interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
DescribeScalingPoliciesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-