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("software.amazon.awssdk:codegen") public final class DescribeScalingPlansRequest extends AutoScalingPlansRequest implements ToCopyableBuilder<DescribeScalingPlansRequest.Builder,DescribeScalingPlansRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDescribeScalingPlansRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<ApplicationSource>applicationSources()The sources for the applications (up to 10).static DescribeScalingPlansRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasApplicationSources()For responses, this returns true if the service returned a value for the ApplicationSources property.inthashCode()booleanhasScalingPlanNames()For responses, this returns true if the service returned a value for the ScalingPlanNames property.IntegermaxResults()The maximum number of scalable resources to return.StringnextToken()The token for the next set of results.List<String>scalingPlanNames()The names of the scaling plans (up to 10).LongscalingPlanVersion()The version number of the scaling plan.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends DescribeScalingPlansRequest.Builder>serializableBuilderClass()DescribeScalingPlansRequest.BuildertoBuilder()StringtoString()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
-
hasScalingPlanNames
public final boolean hasScalingPlanNames()
For responses, this returns true if the service returned a value for the ScalingPlanNames property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
scalingPlanNames
public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasScalingPlanNames()method.- Returns:
- The names of the scaling plans (up to 10). If you specify application sources, you cannot specify scaling plan names.
-
scalingPlanVersion
public final Long scalingPlanVersion()
The version number of the scaling plan. Currently, the only valid value is
1.If you specify a scaling plan version, you must also specify a scaling plan name.
- Returns:
- The version number of the scaling plan. Currently, the only valid value is
1.If you specify a scaling plan version, you must also specify a scaling plan name.
-
hasApplicationSources
public final boolean hasApplicationSources()
For responses, this returns true if the service returned a value for the ApplicationSources property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
applicationSources
public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasApplicationSources()method.- Returns:
- The sources for the applications (up to 10). If you specify scaling plan names, you cannot specify application sources.
-
maxResults
public final 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 final String nextToken()
The token for the next set of results.
- Returns:
- The token for the next set of results.
-
toBuilder
public DescribeScalingPlansRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DescribeScalingPlansRequest.Builder,DescribeScalingPlansRequest>- Specified by:
toBuilderin classAutoScalingPlansRequest
-
builder
public static DescribeScalingPlansRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeScalingPlansRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-