Class OperationEvent

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

An operation event returns details for an operation, including key milestones which can be used to monitor and track operations in progress.

Operation events contain:

  • Description string

  • Resource, including its ARN and type

  • Status

  • StatusMessage string

  • TimeStamp

Operation event examples include StartApplication or StopApplication.

See Also:

  • Method Details

    • description

      public final String description()

      A description of the operation event. For example, "Stop the EC2 instance i-abcdefgh987654321".

      Returns:
      A description of the operation event. For example, "Stop the EC2 instance i-abcdefgh987654321".

    • resource

      public final Resource resource()

      The resource involved in the operations event.

      Contains ResourceArn ARN and ResourceType.

      Returns:
      The resource involved in the operations event.

      Contains ResourceArn ARN and ResourceType.

    • status

      public final OperationEventStatus status()

      The status of the operation event. The possible statuses are: IN_PROGRESS, COMPLETED, and FAILED.

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

      Returns:
      The status of the operation event. The possible statuses are: IN_PROGRESS, COMPLETED, and FAILED.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the operation event. The possible statuses are: IN_PROGRESS, COMPLETED, and FAILED.

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

      Returns:
      The status of the operation event. The possible statuses are: IN_PROGRESS, COMPLETED, and FAILED.
      See Also:

    • statusMessage

      public final String statusMessage()

      The status message relating to a specific operation event.

      Returns:
      The status message relating to a specific operation event.

    • timestamp

      public final Instant timestamp()

      The timestamp of the specified operation event.

      Returns:
      The timestamp of the specified operation event.

    • toBuilder

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

    • builder

      public static OperationEvent.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.