Class TimelineEvent

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

A significant event that happened during the incident.

See Also:

  • Method Details

    • eventData

      public final String eventData()

      A short description of the event.

      Returns:
      A short description of the event.

    • eventId

      public final String eventId()

      The ID of the timeline event.

      Returns:
      The ID of the timeline event.

    • hasEventReferences

      public final boolean hasEventReferences()
      For responses, this returns true if the service returned a value for the EventReferences 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.

    • eventReferences

      public final List<EventReference> eventReferences()

      A list of references in a TimelineEvent.

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

      Returns:
      A list of references in a TimelineEvent.

    • eventTime

      public final Instant eventTime()

      The timestamp for when the event occurred.

      Returns:
      The timestamp for when the event occurred.

    • eventType

      public final String eventType()

      The type of event that occurred. Currently Incident Manager supports only the Custom Event and Note types.

      Returns:
      The type of event that occurred. Currently Incident Manager supports only the Custom Event and Note types.

    • eventUpdatedTime

      public final Instant eventUpdatedTime()

      The timestamp for when the timeline event was last updated.

      Returns:
      The timestamp for when the timeline event was last updated.

    • incidentRecordArn

      public final String incidentRecordArn()

      The Amazon Resource Name (ARN) of the incident that the event occurred during.

      Returns:
      The Amazon Resource Name (ARN) of the incident that the event occurred during.

    • toBuilder

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

    • builder

      public static TimelineEvent.Builder builder()

    • serializableBuilderClass

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