Class MaintenanceWindowExecutionTaskInvocationIdentity

java.lang.Object
software.amazon.awssdk.services.ssm.model.MaintenanceWindowExecutionTaskInvocationIdentity
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<MaintenanceWindowExecutionTaskInvocationIdentity.Builder,MaintenanceWindowExecutionTaskInvocationIdentity>
@Generated("software.amazon.awssdk:codegen") public final class MaintenanceWindowExecutionTaskInvocationIdentity extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MaintenanceWindowExecutionTaskInvocationIdentity.Builder,MaintenanceWindowExecutionTaskInvocationIdentity>

Describes the information about a task invocation for a particular target as part of 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.

    • invocationId

      public final String invocationId()

      The ID of the task invocation.

      Returns:
      The ID of the task invocation.

    • executionId

      public final String executionId()

      The ID of the action performed in the service that actually handled the task invocation. If the task type is RUN_COMMAND, this value is the command ID.

      Returns:
      The ID of the action performed in the service that actually handled the task invocation. If the task type is RUN_COMMAND, this value is the command ID.

    • taskType

      public final MaintenanceWindowTaskType taskType()

      The task type.

      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 task type.
      See Also:

    • taskTypeAsString

      public final String taskTypeAsString()

      The task type.

      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 task type.
      See Also:

    • parameters

      public final String parameters()

      The parameters that were provided for the invocation when it was run.

      Returns:
      The parameters that were provided for the invocation when it was run.

    • status

      public final MaintenanceWindowExecutionStatus status()

      The status of the task invocation.

      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 invocation.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the task invocation.

      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 invocation.
      See Also:

    • statusDetails

      public final String statusDetails()

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

      Returns:
      The details explaining the status of the task invocation. Not available for all status values.

    • startTime

      public final Instant startTime()

      The time the invocation started.

      Returns:
      The time the invocation started.

    • endTime

      public final Instant endTime()

      The time the invocation finished.

      Returns:
      The time the invocation finished.

    • ownerInformation

      public final String ownerInformation()

      User-provided value that was specified when the target was registered with the maintenance window. This was also included in any Amazon CloudWatch Events events raised during the task invocation.

      Returns:
      User-provided value that was specified when the target was registered with the maintenance window. This was also included in any Amazon CloudWatch Events events raised during the task invocation.

    • windowTargetId

      public final String windowTargetId()

      The ID of the target definition in this maintenance window the invocation was performed for.

      Returns:
      The ID of the target definition in this maintenance window the invocation was performed for.

    • toBuilder

      public MaintenanceWindowExecutionTaskInvocationIdentity.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<MaintenanceWindowExecutionTaskInvocationIdentity.Builder,MaintenanceWindowExecutionTaskInvocationIdentity>
      Returns:
      a builder for type T

    • builder

      public static MaintenanceWindowExecutionTaskInvocationIdentity.Builder builder()

    • serializableBuilderClass

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