software.amazon.awssdk.services.gamelift.model

Interface DescribeScalingPoliciesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<DescribeScalingPoliciesRequest.Builder,DescribeScalingPoliciesRequest>, GameLiftRequest.Builder, SdkBuilder<DescribeScalingPoliciesRequest.Builder,DescribeScalingPoliciesRequest>, SdkRequest.Builder

Enclosing class:

DescribeScalingPoliciesRequest

public static interface DescribeScalingPoliciesRequest.Builder
extends GameLiftRequest.Builder, CopyableBuilder<DescribeScalingPoliciesRequest.Builder,DescribeScalingPoliciesRequest>

Method Summary

Modifier and Type	Method and Description
DescribeScalingPoliciesRequest.Builder	fleetId(String fleetId) Unique identifier for a fleet to retrieve scaling policies for.
DescribeScalingPoliciesRequest.Builder	limit(Integer limit) Maximum number of results to return.
DescribeScalingPoliciesRequest.Builder	nextToken(String nextToken) Token that indicates the start of the next sequential page of results.
DescribeScalingPoliciesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
DescribeScalingPoliciesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
DescribeScalingPoliciesRequest.Builder	statusFilter(ScalingStatusType statusFilter) Scaling policy status to filter results on.
DescribeScalingPoliciesRequest.Builder	statusFilter(String statusFilter) Scaling policy status to filter results on.

Methods inherited from interface software.amazon.awssdk.services.gamelift.model.GameLiftRequest.Builder

build

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.utils.builder.SdkBuilder

applyMutation, build

Method Detail

fleetId

DescribeScalingPoliciesRequest.Builder fleetId(String fleetId)

Unique identifier for a fleet to retrieve scaling policies for.

Parameters:

fleetId - Unique identifier for a fleet to retrieve scaling policies for.

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)

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

Parameters:

limit - 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)

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

Parameters:

nextToken - Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. 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.

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

DescribeScalingPoliciesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

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.