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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      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<MaintenanceWindowExecutionTaskIdentity.Builder,MaintenanceWindowExecutionTaskIdentity>
      Returns:
      a builder for type T

    • 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)
      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.