Class IncidentRecord
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<IncidentRecord.Builder,
IncidentRecord>
The record of the incident that's created when an incident occurs.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the incident record.final List
<AutomationExecution> The runbook, or automation document, that's run at the beginning of the incident.static IncidentRecord.Builder
builder()
final ChatChannel
The chat channel used for collaboration during an incident.final Instant
The timestamp for when Incident Manager created the incident record.final String
The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AutomationExecutions property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the NotificationTargets property.final Integer
impact()
The impact of the incident on customers and applications.final IncidentRecordSource
Details about the action that started the incident.final String
Who modified the incident most recently.final Instant
The timestamp for when the incident was most recently modified.final List
<NotificationTargetItem> The Amazon SNS targets that are notified when updates are made to an incident.final Instant
The timestamp for when the incident was resolved.static Class
<? extends IncidentRecord.Builder> final IncidentRecordStatus
status()
The current status of the incident.final String
The current status of the incident.final String
summary()
The summary of the incident.final String
title()
The title of the incident.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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
The chat channel used for collaboration during an incident.
- Returns:
- The chat channel used for collaboration during an incident.
-
creationTime
The timestamp for when Incident Manager created the incident record.
- Returns:
- The timestamp for when Incident Manager created the incident record.
-
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
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
Details about the action that started the incident.
- Returns:
- Details about the action that started the incident.
-
lastModifiedBy
Who modified the incident most recently.
- Returns:
- Who modified the incident most recently.
-
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 theisEmpty()
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
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
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
The current status of the incident.
If the service returns an enum value that is not available in the current SDK version,
status
will returnIncidentRecordStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the incident.
- See Also:
-
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 returnIncidentRecordStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the incident.
- See Also:
-
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
The title of the incident.
- Returns:
- The title of the incident.
-
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 interfaceToCopyableBuilder<IncidentRecord.Builder,
IncidentRecord> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-