software.amazon.awssdk.services.autoscalingplans.model

Class DescribeScalingPlansRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.autoscalingplans.model.AutoScalingPlansRequest

software.amazon.awssdk.services.autoscalingplans.model.DescribeScalingPlansRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeScalingPlansRequest.Builder,DescribeScalingPlansRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeScalingPlansRequest
extends AutoScalingPlansRequest
implements ToCopyableBuilder<DescribeScalingPlansRequest.Builder,DescribeScalingPlansRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeScalingPlansRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<ApplicationSource>	applicationSources() The sources for the applications (up to 10).
static DescribeScalingPlansRequest.Builder	builder()
boolean	equals(Object obj)
<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	maxResults() The maximum number of scalable resources to return.
String	nextToken() The token for the next set of results.
List<String>	scalingPlanNames() The names of the scaling plans (up to 10).
Long	scalingPlanVersion() The version number of the scaling plan.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeScalingPlansRequest.Builder>	serializableBuilderClass()
DescribeScalingPlansRequest.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.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

scalingPlanNames

public List<String> scalingPlanNames()

The names of the scaling plans (up to 10). If you specify application sources, you cannot specify scaling plan names.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The names of the scaling plans (up to 10). If you specify application sources, you cannot specify scaling plan names.

scalingPlanVersion

public Long scalingPlanVersion()

The version number of the scaling plan. If you specify a scaling plan version, you must also specify a scaling plan name.

Returns:

The version number of the scaling plan. If you specify a scaling plan version, you must also specify a scaling plan name.

applicationSources

public List<ApplicationSource> applicationSources()

The sources for the applications (up to 10). If you specify scaling plan names, you cannot specify application sources.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The sources for the applications (up to 10). If you specify scaling plan names, you cannot specify application sources.

maxResults

public Integer maxResults()

The maximum number of scalable resources to return. This value can be between 1 and 50. The default value is 50.

Returns:

The maximum number of scalable resources to return. This value can be between 1 and 50. The default value is 50.

nextToken

public String nextToken()

The token for the next set of results.

Returns:

The token for the next set of results.

toBuilder

public DescribeScalingPlansRequest.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<DescribeScalingPlansRequest.Builder,DescribeScalingPlansRequest>

Specified by:

toBuilder in class AutoScalingPlansRequest

Returns:

a builder for type T

builder

public static DescribeScalingPlansRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeScalingPlansRequest.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

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.