Class IncidentRecord

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

The record of the incident that's created when an incident occurs.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the incident record.

      Returns:
      The Amazon Resource Name (ARN) of the incident record.

    • hasAutomationExecutions

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

    • automationExecutions

      public final List<AutomationExecution> automationExecutions()

      The runbook, or automation document, that's run at the beginning of the incident.

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

      Returns:
      The runbook, or automation document, that's run at the beginning of the incident.

    • chatChannel

      public final ChatChannel chatChannel()

      The chat channel used for collaboration during an incident.

      Returns:
      The chat channel used for collaboration during an incident.

    • creationTime

      public final Instant creationTime()

      The timestamp for when Incident Manager created the incident record.

      Returns:
      The timestamp for when Incident Manager created the incident record.

    • dedupeString

      public final String dedupeString()

      The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.

      Returns:
      The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.

    • impact

      public final Integer impact()

      The impact of the incident on customers and applications.

      Supported impact codes

      • 1 - Critical

      • 2 - High

      • 3 - Medium

      • 4 - Low

      • 5 - No Impact

      Returns:
      The impact of the incident on customers and applications.

      Supported impact codes

      • 1 - Critical

      • 2 - High

      • 3 - Medium

      • 4 - Low

      • 5 - No Impact

    • incidentRecordSource

      public final IncidentRecordSource incidentRecordSource()

      Details about the action that started the incident.

      Returns:
      Details about the action that started the incident.

    • lastModifiedBy

      public final String lastModifiedBy()

      Who modified the incident most recently.

      Returns:
      Who modified the incident most recently.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The timestamp for when the incident was most recently modified.

      Returns:
      The timestamp for when the incident was most recently modified.

    • hasNotificationTargets

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

    • notificationTargets

      public final List<NotificationTargetItem> notificationTargets()

      The Amazon SNS targets that are notified when updates are made to an incident.

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

      Returns:
      The Amazon SNS targets that are notified when updates are made to an incident.

    • resolvedTime

      public final Instant resolvedTime()

      The timestamp for when the incident was resolved. This appears as a timeline event.

      Returns:
      The timestamp for when the incident was resolved. This appears as a timeline event.

    • status

      public final IncidentRecordStatus status()

      The current status of the incident.

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

      Returns:
      The current status of the incident.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the incident.

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

      Returns:
      The current status of the incident.
      See Also:

    • summary

      public final String summary()

      The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context of the incident.

      Returns:
      The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context of the incident.

    • title

      public final String title()

      The title of the incident.

      Returns:
      The title of the incident.

    • toBuilder

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

    • builder

      public static IncidentRecord.Builder builder()

    • serializableBuilderClass

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