@Generated(value="software.amazon.awssdk:codegen") public final class DescribeScalingPoliciesRequest extends GameLiftRequest implements ToCopyableBuilder<DescribeScalingPoliciesRequest.Builder,DescribeScalingPoliciesRequest>
Represents the input for a request action.
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeScalingPoliciesRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static DescribeScalingPoliciesRequest.Builder |
builder() |
boolean |
equals(Object obj) |
String |
fleetId()
Unique identifier for a fleet to retrieve scaling policies for.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
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() |
ScalingStatusType |
statusFilter()
Scaling policy status to filter results on.
|
String |
statusFilterAsString()
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() |
overrideConfiguration
copy
public String fleetId()
Unique identifier for a fleet to retrieve scaling policies for.
public 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()
.
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.
ScalingStatusType
public 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()
.
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.
ScalingStatusType
public Integer limit()
Maximum number of results to return. Use this parameter with NextToken
to get results as a set of
sequential pages.
NextToken
to get results as a
set of sequential pages.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 start at the beginning of the result set, do not specify a value.
public DescribeScalingPoliciesRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeScalingPoliciesRequest.Builder,DescribeScalingPoliciesRequest>
toBuilder
in class GameLiftRequest
public static DescribeScalingPoliciesRequest.Builder builder()
public static Class<? extends DescribeScalingPoliciesRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.