Class DescribeScalingActivitiesRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.autoscaling.model.AutoScalingRequest
-
- software.amazon.awssdk.services.autoscaling.model.DescribeScalingActivitiesRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<DescribeScalingActivitiesRequest.Builder,DescribeScalingActivitiesRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeScalingActivitiesRequest extends AutoScalingRequest implements ToCopyableBuilder<DescribeScalingActivitiesRequest.Builder,DescribeScalingActivitiesRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDescribeScalingActivitiesRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<String>activityIds()The activity IDs of the desired scaling activities.StringautoScalingGroupName()The name of the Auto Scaling group.static DescribeScalingActivitiesRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<Filter>filters()One or more filters to limit the results based on specific criteria.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasActivityIds()For responses, this returns true if the service returned a value for the ActivityIds property.booleanhasFilters()For responses, this returns true if the service returned a value for the Filters property.inthashCode()BooleanincludeDeletedGroups()Indicates whether to include scaling activity from deleted Auto Scaling groups.IntegermaxRecords()The maximum number of items to return with this call.StringnextToken()The token for the next set of items to return.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends DescribeScalingActivitiesRequest.Builder>serializableBuilderClass()DescribeScalingActivitiesRequest.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
-
hasActivityIds
public final boolean hasActivityIds()
For responses, this returns true if the service returned a value for the ActivityIds 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.
-
activityIds
public final List<String> activityIds()
The activity IDs of the desired scaling activities. If unknown activity IDs are requested, they are ignored with no error. Only activities started within the last six weeks can be returned regardless of the activity IDs specified. If other filters are specified with the request, only results matching all filter criteria can be returned.
Array Members: Maximum number of 50 IDs.
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
hasActivityIds()method.- Returns:
- The activity IDs of the desired scaling activities. If unknown activity IDs are requested, they are
ignored with no error. Only activities started within the last six weeks can be returned regardless of
the activity IDs specified. If other filters are specified with the request, only results matching all
filter criteria can be returned.
Array Members: Maximum number of 50 IDs.
-
autoScalingGroupName
public final String autoScalingGroupName()
The name of the Auto Scaling group.
Omitting this property performs an account-wide operation, which can result in slower or timed-out requests.
- Returns:
- The name of the Auto Scaling group.
Omitting this property performs an account-wide operation, which can result in slower or timed-out requests.
-
includeDeletedGroups
public final Boolean includeDeletedGroups()
Indicates whether to include scaling activity from deleted Auto Scaling groups.
- Returns:
- Indicates whether to include scaling activity from deleted Auto Scaling groups.
-
maxRecords
public final Integer maxRecords()
The maximum number of items to return with this call. The default value is
100and the maximum value is100.- Returns:
- The maximum number of items to return with this call. The default value is
100and the maximum value is100.
-
nextToken
public final String nextToken()
The token for the next set of items to return. (You received this token from a previous call.)
- Returns:
- The token for the next set of items to return. (You received this token from a previous call.)
-
hasFilters
public final boolean hasFilters()
For responses, this returns true if the service returned a value for the Filters 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.
-
filters
public final List<Filter> filters()
One or more filters to limit the results based on specific criteria. The following filters are supported:
-
StartTimeLowerBound- The earliest scaling activities to return based on the activity start time. Scaling activities with a start time earlier than this value are not included in the results. Only activities started within the last six weeks can be returned regardless of the value specified. -
StartTimeUpperBound- The latest scaling activities to return based on the activity start time. Scaling activities with a start time later than this value are not included in the results. Only activities started within the last six weeks can be returned regardless of the value specified. -
Status- TheStatusCodevalue of the scaling activity. This filter can only be used in combination with theAutoScalingGroupNameparameter. For validStatusCodevalues, see Activity in the Amazon EC2 Auto Scaling API Reference.
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
hasFilters()method.- Returns:
- One or more filters to limit the results based on specific criteria. The following filters are supported:
-
StartTimeLowerBound- The earliest scaling activities to return based on the activity start time. Scaling activities with a start time earlier than this value are not included in the results. Only activities started within the last six weeks can be returned regardless of the value specified. -
StartTimeUpperBound- The latest scaling activities to return based on the activity start time. Scaling activities with a start time later than this value are not included in the results. Only activities started within the last six weeks can be returned regardless of the value specified. -
Status- TheStatusCodevalue of the scaling activity. This filter can only be used in combination with theAutoScalingGroupNameparameter. For validStatusCodevalues, see Activity in the Amazon EC2 Auto Scaling API Reference.
-
-
-
toBuilder
public DescribeScalingActivitiesRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DescribeScalingActivitiesRequest.Builder,DescribeScalingActivitiesRequest>- Specified by:
toBuilderin classAutoScalingRequest
-
builder
public static DescribeScalingActivitiesRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeScalingActivitiesRequest.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
-
-