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

Class DescribeScalingPoliciesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.gamelift.model.GameLiftRequest

software.amazon.awssdk.services.gamelift.model.DescribeScalingPoliciesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeScalingPoliciesRequest.Builder,DescribeScalingPoliciesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeScalingPoliciesRequest
extends GameLiftRequest
implements ToCopyableBuilder<DescribeScalingPoliciesRequest.Builder,DescribeScalingPoliciesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeScalingPoliciesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeScalingPoliciesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fleetId()	A unique identifier for the fleet for which to retrieve scaling policies.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	limit()	The maximum number of results to return.
String	location()	The fleet location.
String	nextToken()	A token that indicates the start of the next sequential page of results.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeScalingPoliciesRequest.Builder>	serializableBuilderClass()
ScalingStatusType	statusFilter()	Scaling policy status to filter results on.
String	statusFilterAsString()	Scaling policy status to filter results on.
DescribeScalingPoliciesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

fleetId

public final String fleetId()

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

Returns:

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

statusFilter

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

If the service returns an enum value that is not available in the current SDK version, statusFilter will return ScalingStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusFilterAsString().

Returns:

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.

See Also:

ScalingStatusType

statusFilterAsString

public final String statusFilterAsString()

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.

If the service returns an enum value that is not available in the current SDK version, statusFilter will return ScalingStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusFilterAsString().

Returns:

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.

See Also:

ScalingStatusType

limit

public final Integer limit()

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

Returns:

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

nextToken

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

Returns:

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.

location

public final String location()

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

Returns:

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

toBuilder

public DescribeScalingPoliciesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeScalingPoliciesRequest.Builder,DescribeScalingPoliciesRequest>

Specified by:

toBuilder in class GameLiftRequest

builder

public static DescribeScalingPoliciesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeScalingPoliciesRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo