software.amazon.awssdk.services.ssmincidents.model

Class CreateResponsePlanRequest

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.CreateResponsePlanRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateResponsePlanRequest.Builder,CreateResponsePlanRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateResponsePlanRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<Action>	actions() The actions that the response plan starts at the beginning of an incident.
static CreateResponsePlanRequest.Builder	builder()
ChatChannel	chatChannel() The Chatbot chat channel used for collaboration during an incident.
String	clientToken() A token ensuring that the operation is called only once with the specified details.
String	displayName() The long format of the response plan name.
List<String>	engagements() The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasActions() For responses, this returns true if the service returned a value for the Actions property.
boolean	hasEngagements() For responses, this returns true if the service returned a value for the Engagements property.
int	hashCode()
boolean	hasIntegrations() For responses, this returns true if the service returned a value for the Integrations property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
IncidentTemplate	incidentTemplate() Details used to create an incident when using this response plan.
List<Integration>	integrations() Information about third-party services integrated into the response plan.
String	name() The short format name of the response plan.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateResponsePlanRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() A list of tags that you are adding to the response plan.
CreateResponsePlanRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

hasActions

public final boolean hasActions()

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

actions

public final List<Action> actions()

The actions that the response plan starts at the beginning of 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 hasActions() method.

Returns:

The actions that the response plan starts at the beginning of an incident.

chatChannel

public final ChatChannel chatChannel()

The Chatbot chat channel used for collaboration during an incident.

Returns:

The Chatbot chat channel used for collaboration during an incident.

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.

displayName

public final String displayName()

The long format of the response plan name. This field can contain spaces.

Returns:

The long format of the response plan name. This field can contain spaces.

hasEngagements

public final boolean hasEngagements()

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

engagements

public final List<String> engagements()

The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during 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 hasEngagements() method.

Returns:

The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.

incidentTemplate

public final IncidentTemplate incidentTemplate()

Details used to create an incident when using this response plan.

Returns:

Details used to create an incident when using this response plan.

hasIntegrations

public final boolean hasIntegrations()

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

integrations

public final List<Integration> integrations()

Information about third-party services integrated into the response plan.

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

Returns:

Information about third-party services integrated into the response plan.

name

public final String name()

The short format name of the response plan. Can't include spaces.

Returns:

The short format name of the response plan. Can't include spaces.

hasTags

public final boolean hasTags()

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

tags

public final Map<String,String> tags()

A list of tags that you are adding to the response plan.

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

Returns:

A list of tags that you are adding to the response plan.

toBuilder

public CreateResponsePlanRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateResponsePlanRequest.Builder,CreateResponsePlanRequest>

Specified by:

toBuilder in class SsmIncidentsRequest

builder

public static CreateResponsePlanRequest.Builder builder()

serializableBuilderClass

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