Class Plan

java.lang.Object
software.amazon.awssdk.services.arcregionswitch.model.Plan
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Plan.Builder,Plan>

@Generated("software.amazon.awssdk:codegen") public final class Plan extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Plan.Builder,Plan>

Represents a Region switch plan. A plan defines the steps required to shift traffic from one Amazon Web Services Region to another.

See Also:
  • 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 description for a plan.

      Returns:
      The description for a 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 workflows for a 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 workflows for a plan.
    • executionRole

      public final String executionRole()

      The execution role for a plan.

      Returns:
      The execution role for a plan.
    • recoveryTimeObjectiveMinutes

      public final Integer recoveryTimeObjectiveMinutes()

      The recovery time objective for a plan.

      Returns:
      The recovery time objective for a 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 associated application health alarms for a 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 associated application health alarms for a 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 triggers for a 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 triggers for a plan.
    • name

      public final String name()

      The name for a plan.

      Returns:
      The name for a plan.
    • hasRegions

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

      public final List<String> regions()

      The Amazon Web Services Regions for a 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 hasRegions() method.

      Returns:
      The Amazon Web Services Regions for a plan.
    • recoveryApproach

      public final RecoveryApproach recoveryApproach()

      The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).

      If the service returns an enum value that is not available in the current SDK version, recoveryApproach will return RecoveryApproach.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from recoveryApproachAsString().

      Returns:
      The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
      See Also:
    • recoveryApproachAsString

      public final String recoveryApproachAsString()

      The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).

      If the service returns an enum value that is not available in the current SDK version, recoveryApproach will return RecoveryApproach.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from recoveryApproachAsString().

      Returns:
      The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
      See Also:
    • primaryRegion

      public final String primaryRegion()

      The primary Region for a plan.

      Returns:
      The primary Region for a plan.
    • owner

      public final String owner()

      The owner of a plan.

      Returns:
      The owner of a plan.
    • version

      public final String version()

      The version for the plan.

      Returns:
      The version for the plan.
    • updatedAt

      public final Instant updatedAt()

      The timestamp when the plan was last updated.

      Returns:
      The timestamp when the plan was last updated.
    • toBuilder

      public Plan.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<Plan.Builder,Plan>
      Returns:
      a builder for type T
    • builder

      public static Plan.Builder builder()
    • serializableBuilderClass

      public static Class<? extends Plan.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • 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)
    • 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.