software.amazon.awssdk.services.ssmincidents.model

Class StartIncidentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssmincidents.model.SsmIncidentsRequest

software.amazon.awssdk.services.ssmincidents.model.StartIncidentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartIncidentRequest.Builder,StartIncidentRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartIncidentRequest
extends SsmIncidentsRequest
implements ToCopyableBuilder<StartIncidentRequest.Builder,StartIncidentRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartIncidentRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartIncidentRequest.Builder	builder()
String	clientToken() A token ensuring that the operation is called only once with the specified details.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRelatedItems() For responses, this returns true if the service returned a value for the RelatedItems property.
Integer	impact() Defines the impact to the customers.
List<RelatedItem>	relatedItems() Add related items to the incident for other responders to use.
String	responsePlanArn() The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat channels, Amazon SNS topics, runbooks, title, and impact of the incident.
List<SdkField<?>>	sdkFields()
static Class<? extends StartIncidentRequest.Builder>	serializableBuilderClass()
String	title() Provide a title for the incident.
StartIncidentRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
TriggerDetails	triggerDetails() Details of what created the incident record in Incident Manager.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

clientToken

public final String clientToken()

A token ensuring that the operation is called only once with the specified details.

Returns:

A token ensuring that the operation is called only once with the specified details.

impact

public final Integer impact()

Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.

Possible impacts:

• 1 - Critical impact, this typically relates to full application failure that impacts many to all customers.

• 2 - High impact, partial application failure with impact to many customers.

• 3 - Medium impact, the application is providing reduced service to customers.

• 4 - Low impact, customer might aren't impacted by the problem yet.

• 5 - No impact, customers aren't currently impacted but urgent action is needed to avoid impact.

Returns:

Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.

Possible impacts:

• 1 - Critical impact, this typically relates to full application failure that impacts many to all customers.

• 2 - High impact, partial application failure with impact to many customers.

• 3 - Medium impact, the application is providing reduced service to customers.

• 4 - Low impact, customer might aren't impacted by the problem yet.

• 5 - No impact, customers aren't currently impacted but urgent action is needed to avoid impact.

hasRelatedItems

public final boolean hasRelatedItems()

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

relatedItems

public final List<RelatedItem> relatedItems()

Add related items to the incident for other responders to use. Related items are Amazon Web Services resources, external links, or files uploaded to an Amazon S3 bucket.

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

Returns:

Add related items to the incident for other responders to use. Related items are Amazon Web Services resources, external links, or files uploaded to an Amazon S3 bucket.

responsePlanArn

public final String responsePlanArn()

The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat channels, Amazon SNS topics, runbooks, title, and impact of the incident.

Returns:

The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat channels, Amazon SNS topics, runbooks, title, and impact of the incident.

title

public final String title()

Provide a title for the incident. Providing a title overwrites the title provided by the response plan.

Returns:

Provide a title for the incident. Providing a title overwrites the title provided by the response plan.

triggerDetails

public final TriggerDetails triggerDetails()

Details of what created the incident record in Incident Manager.

Returns:

Details of what created the incident record in Incident Manager.

toBuilder

public StartIncidentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartIncidentRequest.Builder,StartIncidentRequest>

Specified by:

toBuilder in class SsmIncidentsRequest

builder

public static StartIncidentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartIncidentRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo