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("software.amazon.awssdk:codegen") public final class CreateResponsePlanRequest extends SsmIncidentsRequest implements ToCopyableBuilder<CreateResponsePlanRequest.Builder,CreateResponsePlanRequest>

  • 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 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()
      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<CreateResponsePlanRequest.Builder,CreateResponsePlanRequest>
      Specified by:
      toBuilder in class SsmIncidentsRequest
      Returns:
      a builder for type T

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