Package software.amazon.awssdk.services.ssm.model

Class MaintenanceWindowExecutionTaskIdentity

java.lang.Object

software.amazon.awssdk.services.ssm.model.MaintenanceWindowExecutionTaskIdentity

All Implemented Interfaces:

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

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

Information about a task execution performed as part of a maintenance window execution.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MaintenanceWindowExecutionTaskIdentity.Builder

Method Summary

Modifier and Type	Method	Description
AlarmConfiguration	alarmConfiguration()	The details for the CloudWatch alarm applied to your maintenance window task.
static MaintenanceWindowExecutionTaskIdentity.Builder	builder()
Instant	endTime()	The time the task execution finished.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTriggeredAlarms()	For responses, this returns true if the service returned a value for the TriggeredAlarms property.
List<SdkField<?>>	sdkFields()
static Class<? extends MaintenanceWindowExecutionTaskIdentity.Builder>	serializableBuilderClass()
Instant	startTime()	The time the task execution started.
MaintenanceWindowExecutionStatus	status()	The status of the task execution.
String	statusAsString()	The status of the task execution.
String	statusDetails()	The details explaining the status of the task execution.
String	taskArn()	The Amazon Resource Name (ARN) of the task that ran.
String	taskExecutionId()	The ID of the specific task execution in the maintenance window execution.
MaintenanceWindowTaskType	taskType()	The type of task that ran.
String	taskTypeAsString()	The type of task that ran.
MaintenanceWindowExecutionTaskIdentity.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<AlarmStateInformation>	triggeredAlarms()	The CloudWatch alarm that was invoked by the maintenance window task.
String	windowExecutionId()	The ID of the maintenance window execution that ran the task.

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

windowExecutionId

public final String windowExecutionId()

The ID of the maintenance window execution that ran the task.

Returns:

The ID of the maintenance window execution that ran the task.

taskExecutionId

public final String taskExecutionId()

The ID of the specific task execution in the maintenance window execution.

Returns:

The ID of the specific task execution in the maintenance window execution.

status

public final MaintenanceWindowExecutionStatus status()

The status of the task execution.

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

Returns:

The status of the task execution.

See Also:

MaintenanceWindowExecutionStatus

statusAsString

public final String statusAsString()

The status of the task execution.

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

Returns:

The status of the task execution.

See Also:

MaintenanceWindowExecutionStatus

statusDetails

public final String statusDetails()

The details explaining the status of the task execution. Not available for all status values.

Returns:

The details explaining the status of the task execution. Not available for all status values.

startTime

public final Instant startTime()

The time the task execution started.

Returns:

The time the task execution started.

endTime

public final Instant endTime()

The time the task execution finished.

Returns:

The time the task execution finished.

taskArn

public final String taskArn()

The Amazon Resource Name (ARN) of the task that ran.

Returns:

The Amazon Resource Name (ARN) of the task that ran.

taskType

public final MaintenanceWindowTaskType taskType()

The type of task that ran.

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

Returns:

The type of task that ran.

See Also:

MaintenanceWindowTaskType

taskTypeAsString

public final String taskTypeAsString()

The type of task that ran.

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

Returns:

The type of task that ran.

See Also:

MaintenanceWindowTaskType

alarmConfiguration

public final AlarmConfiguration alarmConfiguration()

The details for the CloudWatch alarm applied to your maintenance window task.

Returns:

The details for the CloudWatch alarm applied to your maintenance window task.

hasTriggeredAlarms

public final boolean hasTriggeredAlarms()

For responses, this returns true if the service returned a value for the TriggeredAlarms 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.

triggeredAlarms

public final List<AlarmStateInformation> triggeredAlarms()

The CloudWatch alarm that was invoked by the maintenance window task.

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

Returns:

The CloudWatch alarm that was invoked by the maintenance window task.

toBuilder

public MaintenanceWindowExecutionTaskIdentity.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MaintenanceWindowExecutionTaskIdentity.Builder,MaintenanceWindowExecutionTaskIdentity>

builder

public static MaintenanceWindowExecutionTaskIdentity.Builder builder()

serializableBuilderClass

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