software.amazon.awssdk.services.ssmincidents.model

Class IncidentTemplate

java.lang.Object

software.amazon.awssdk.services.ssmincidents.model.IncidentTemplate

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<IncidentTemplate.Builder,IncidentTemplate>

@Generated(value="software.amazon.awssdk:codegen")
public final class IncidentTemplate
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<IncidentTemplate.Builder,IncidentTemplate>

Basic details used in creating a response plan. The response plan is then used to create an incident record.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IncidentTemplate.Builder

Method Summary

Modifier and Type	Method and Description
static IncidentTemplate.Builder	builder()
String	dedupeString() Used to stop Incident Manager from creating multiple incident records for the same incident.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIncidentTags() For responses, this returns true if the service returned a value for the IncidentTags property.
boolean	hasNotificationTargets() For responses, this returns true if the service returned a value for the NotificationTargets property.
Integer	impact() The impact of the incident on your customers and applications.
Map<String,String>	incidentTags() Tags to assign to the template.
List<NotificationTargetItem>	notificationTargets() The Amazon SNS targets that are notified when updates are made to an incident.
List<SdkField<?>>	sdkFields()
static Class<? extends IncidentTemplate.Builder>	serializableBuilderClass()
String	summary() The summary of the incident.
String	title() The title of the incident.
IncidentTemplate.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

dedupeString

public final String dedupeString()

Used to stop Incident Manager from creating multiple incident records for the same incident.

Returns:

Used to stop Incident Manager from creating multiple incident records for the same incident.

impact

public final Integer impact()

The impact of the incident on your customers and applications.

Returns:

The impact of the incident on your customers and applications.

hasIncidentTags

public final boolean hasIncidentTags()

For responses, this returns true if the service returned a value for the IncidentTags 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.

incidentTags

public final Map<String,String> incidentTags()

Tags to assign to the template. When the StartIncident API action is called, Incident Manager assigns the tags specified in the template to 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 hasIncidentTags() method.

Returns:

Tags to assign to the template. When the StartIncident API action is called, Incident Manager assigns the tags specified in the template to the incident.

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.

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.

Returns:

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

title

public final String title()

The title of the incident.

Returns:

The title of the incident.

toBuilder

public IncidentTemplate.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IncidentTemplate.Builder,IncidentTemplate>

builder

public static IncidentTemplate.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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