Package software.amazon.awssdk.services.ec2.model

Class InstanceStatus

java.lang.Object

software.amazon.awssdk.services.ec2.model.InstanceStatus

All Implemented Interfaces:

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

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

Describes the status of an instance.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InstanceStatus.Builder

Method Summary

Modifier and Type	Method	Description
String	availabilityZone()	The Availability Zone of the instance.
static InstanceStatus.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<InstanceStatusEvent>	events()	Any scheduled events associated with the instance.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEvents()	For responses, this returns true if the service returned a value for the Events property.
int	hashCode()
String	instanceId()	The ID of the instance.
InstanceState	instanceState()	The intended state of the instance.
InstanceStatusSummary	instanceStatus()	Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.
String	outpostArn()	The Amazon Resource Name (ARN) of the Outpost.
List<SdkField<?>>	sdkFields()
static Class<? extends InstanceStatus.Builder>	serializableBuilderClass()
InstanceStatusSummary	systemStatus()	Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.
InstanceStatus.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

availabilityZone

public final String availabilityZone()

The Availability Zone of the instance.

Returns:

The Availability Zone of the instance.

outpostArn

public final String outpostArn()

The Amazon Resource Name (ARN) of the Outpost.

Returns:

The Amazon Resource Name (ARN) of the Outpost.

hasEvents

public final boolean hasEvents()

For responses, this returns true if the service returned a value for the Events property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

events

public final List<InstanceStatusEvent> events()

Any scheduled events associated with the instance.

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 hasEvents() method.

Returns:

Any scheduled events associated with the instance.

instanceId

public final String instanceId()

The ID of the instance.

Returns:

The ID of the instance.

instanceState

public final InstanceState instanceState()

The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.

Returns:

The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.

instanceStatus

public final InstanceStatusSummary instanceStatus()

Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.

Returns:

Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.

systemStatus

public final InstanceStatusSummary systemStatus()

Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.

Returns:

Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.

toBuilder

public InstanceStatus.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InstanceStatus.Builder,InstanceStatus>

builder

public static InstanceStatus.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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