Package software.amazon.awssdk.services.ssmincidents.model

Class UpdateResponsePlanRequest

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.UpdateResponsePlanRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateResponsePlanRequest.Builder,UpdateResponsePlanRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateResponsePlanRequest extends SsmIncidentsRequest implements ToCopyableBuilder<UpdateResponsePlanRequest.Builder,UpdateResponsePlanRequest>

  • Method Details

    • 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 this response plan takes 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 this response plan takes at the beginning of an incident.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the response plan.

      Returns:
      The Amazon Resource Name (ARN) of the response plan.

    • chatChannel

      public final ChatChannel chatChannel()

      The Chatbot chat channel used for collaboration during an incident.

      Use the empty structure to remove the chat channel from the response plan.

      Returns:
      The Chatbot chat channel used for collaboration during an incident.

      Use the empty structure to remove the chat channel from the response plan.

    • 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 name of the response plan. The display name can't contain spaces.

      Returns:
      The long format name of the response plan. The display name can't 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.

    • incidentTemplateDedupeString

      public final String incidentTemplateDedupeString()

      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.

    • incidentTemplateImpact

      public final Integer incidentTemplateImpact()

      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

    • hasIncidentTemplateNotificationTargets

      public final boolean hasIncidentTemplateNotificationTargets()
      For responses, this returns true if the service returned a value for the IncidentTemplateNotificationTargets 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.

    • incidentTemplateNotificationTargets

      public final List<NotificationTargetItem> incidentTemplateNotificationTargets()

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

      Returns:
      The Amazon SNS targets that are notified when updates are made to an incident.

    • incidentTemplateSummary

      public final String incidentTemplateSummary()

      A brief summary of the incident. This typically contains what has happened, what's currently happening, and next steps.

      Returns:
      A brief summary of the incident. This typically contains what has happened, what's currently happening, and next steps.

    • hasIncidentTemplateTags

      public final boolean hasIncidentTemplateTags()
      For responses, this returns true if the service returned a value for the IncidentTemplateTags 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.

    • incidentTemplateTags

      public final Map<String,String> incidentTemplateTags()

      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. To call this action, you must also have permission to call the TagResource API action for the incident record resource.

      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 hasIncidentTemplateTags() 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. To call this action, you must also have permission to call the TagResource API action for the incident record resource.

    • incidentTemplateTitle

      public final String incidentTemplateTitle()

      The short format name of the incident. The title can't contain spaces.

      Returns:
      The short format name of the incident. The title can't contain spaces.

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

    • toBuilder

      public UpdateResponsePlanRequest.Builder 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 interface ToCopyableBuilder<UpdateResponsePlanRequest.Builder,UpdateResponsePlanRequest>
      Specified by:
      toBuilder in class SsmIncidentsRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateResponsePlanRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateResponsePlanRequest.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.