Class UpdatePlanRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdatePlanRequest.Builder,UpdatePlanRequest>

@Generated("software.amazon.awssdk:codegen") public final class UpdatePlanRequest extends ArcRegionSwitchRequest implements ToCopyableBuilder<UpdatePlanRequest.Builder,UpdatePlanRequest>
  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the plan.

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

      public final String description()

      The updated description for the Region switch plan.

      Returns:
      The updated description for the Region switch plan.
    • hasWorkflows

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

      public final List<Workflow> workflows()

      The updated workflows for the Region switch 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 hasWorkflows() method.

      Returns:
      The updated workflows for the Region switch plan.
    • executionRole

      public final String executionRole()

      The updated IAM role ARN that grants Region switch the permissions needed to execute the plan steps.

      Returns:
      The updated IAM role ARN that grants Region switch the permissions needed to execute the plan steps.
    • recoveryTimeObjectiveMinutes

      public final Integer recoveryTimeObjectiveMinutes()

      The updated target recovery time objective (RTO) in minutes for the plan.

      Returns:
      The updated target recovery time objective (RTO) in minutes for the plan.
    • hasAssociatedAlarms

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

      public final Map<String,AssociatedAlarm> associatedAlarms()

      The updated CloudWatch alarms associated with the 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 hasAssociatedAlarms() method.

      Returns:
      The updated CloudWatch alarms associated with the plan.
    • hasTriggers

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

      public final List<Trigger> triggers()

      The updated conditions that can automatically trigger the execution of the 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 hasTriggers() method.

      Returns:
      The updated conditions that can automatically trigger the execution of the plan.
    • toBuilder

      public UpdatePlanRequest.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<UpdatePlanRequest.Builder,UpdatePlanRequest>
      Specified by:
      toBuilder in class ArcRegionSwitchRequest
      Returns:
      a builder for type T
    • builder

      public static UpdatePlanRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends UpdatePlanRequest.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.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.