software.amazon.awssdk.services.autoscaling.model

Class Activity

java.lang.Object

software.amazon.awssdk.services.autoscaling.model.Activity

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Activity.Builder,Activity>

@Generated(value="software.amazon.awssdk:codegen")
public final class Activity
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Activity.Builder,Activity>

Describes scaling activity, which is a long-running process that represents a change to your Auto Scaling group, such as changing its size or replacing an instance.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Activity.Builder

Method Summary

Modifier and Type	Method and Description
String	activityId() The ID of the activity.
String	autoScalingGroupARN() The Amazon Resource Name (ARN) of the Auto Scaling group.
String	autoScalingGroupName() The name of the Auto Scaling group.
String	autoScalingGroupState() The state of the Auto Scaling group, which is either InService or Deleted.
static Activity.Builder	builder()
String	cause() The reason the activity began.
String	description() A friendly, more verbose description of the activity.
String	details() The details about the activity.
Instant	endTime() The end time of the activity.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	progress() A value between 0 and 100 that indicates the progress of the activity.
List<SdkField<?>>	sdkFields()
static Class<? extends Activity.Builder>	serializableBuilderClass()
Instant	startTime() The start time of the activity.
ScalingActivityStatusCode	statusCode() The current status of the activity.
String	statusCodeAsString() The current status of the activity.
String	statusMessage() A friendly, more verbose description of the activity status.
Activity.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

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

activityId

public final String activityId()

The ID of the activity.

Returns:

The ID of the activity.

autoScalingGroupName

public final String autoScalingGroupName()

The name of the Auto Scaling group.

Returns:

The name of the Auto Scaling group.

description

public final String description()

A friendly, more verbose description of the activity.

Returns:

A friendly, more verbose description of the activity.

cause

public final String cause()

The reason the activity began.

Returns:

The reason the activity began.

startTime

public final Instant startTime()

The start time of the activity.

Returns:

The start time of the activity.

endTime

public final Instant endTime()

The end time of the activity.

Returns:

The end time of the activity.

statusCode

public final ScalingActivityStatusCode statusCode()

The current status of the activity.

If the service returns an enum value that is not available in the current SDK version, statusCode will return ScalingActivityStatusCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusCodeAsString().

Returns:

The current status of the activity.

See Also:

ScalingActivityStatusCode

statusCodeAsString

public final String statusCodeAsString()

The current status of the activity.

If the service returns an enum value that is not available in the current SDK version, statusCode will return ScalingActivityStatusCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusCodeAsString().

Returns:

The current status of the activity.

See Also:

ScalingActivityStatusCode

statusMessage

public final String statusMessage()

A friendly, more verbose description of the activity status.

Returns:

A friendly, more verbose description of the activity status.

progress

public final Integer progress()

A value between 0 and 100 that indicates the progress of the activity.

Returns:

A value between 0 and 100 that indicates the progress of the activity.

details

public final String details()

The details about the activity.

Returns:

The details about the activity.

autoScalingGroupState

public final String autoScalingGroupState()

The state of the Auto Scaling group, which is either InService or Deleted.

Returns:

The state of the Auto Scaling group, which is either InService or Deleted.

autoScalingGroupARN

public final String autoScalingGroupARN()

The Amazon Resource Name (ARN) of the Auto Scaling group.

Returns:

The Amazon Resource Name (ARN) of the Auto Scaling group.

toBuilder

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

Returns:

a builder for type T

builder

public static Activity.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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.

Overrides:

toString in class Object

getValueForField

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

sdkFields

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