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

Class DescribeScalingPoliciesRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

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

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<DescribeScalingPoliciesRequest.Builder,DescribeScalingPoliciesRequest>

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

Represents the input for a request action.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeScalingPoliciesRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static DescribeScalingPoliciesRequest.Builder	builder()
boolean	equals(Object obj)
String	fleetId()	Unique identifier for a fleet to retrieve scaling policies for.
int	hashCode()
Integer	limit()	Maximum number of results to return.
String	nextToken()	Token that indicates the start of the next sequential page of results.
static Class<? extends DescribeScalingPoliciesRequest.Builder>	serializableBuilderClass()
String	statusFilter()	Scaling policy status to filter results on.
DescribeScalingPoliciesRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

fleetId

public String fleetId()

Unique identifier for a fleet to retrieve scaling policies for.

Returns:

Unique identifier for a fleet to retrieve scaling policies for.

statusFilter

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

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

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

Returns:

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

nextToken

public 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 specify the start of the result set, do not specify a value.

Returns:

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 specify the start of the result set, do not specify a value.

toBuilder

public DescribeScalingPoliciesRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeScalingPoliciesRequest.Builder,DescribeScalingPoliciesRequest>

Returns:

a builder for type T

builder

public static DescribeScalingPoliciesRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object