Class StartIncidentRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<StartIncidentRequest.Builder,
StartIncidentRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic StartIncidentRequest.Builder
builder()
final String
A token ensuring that the operation is called only once with the specified details.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) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RelatedItems property.final Integer
impact()
Defines the impact to the customers.final List
<RelatedItem> Add related items to the incident for other responders to use.final String
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.static Class
<? extends StartIncidentRequest.Builder> final String
title()
Provide a title for 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.final TriggerDetails
Details of what created the incident record in Incident Manager.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.
Supported impact codes
-
1
- Critical -
2
- High -
3
- Medium -
4
- Low -
5
- No Impact
- Returns:
- Defines the impact to the customers. Providing an impact overwrites the impact provided by a response
plan.
Supported impact codes
-
1
- Critical -
2
- High -
3
- Medium -
4
- Low -
5
- No 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 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. -
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
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
Details of what created the incident record in Incident Manager.
- Returns:
- Details of what created the incident record in Incident Manager.
-
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<StartIncidentRequest.Builder,
StartIncidentRequest> - Specified by:
toBuilder
in classSsmIncidentsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-