Class AbbreviatedPlan

java.lang.Object
software.amazon.awssdk.services.arcregionswitch.model.AbbreviatedPlan
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AbbreviatedPlan.Builder,AbbreviatedPlan>
@Generated("software.amazon.awssdk:codegen") public final class AbbreviatedPlan extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AbbreviatedPlan.Builder,AbbreviatedPlan>

A summarized representation of a Region switch plan. This structure contains key information about a plan without all the detailed workflow and step data.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the Region switch plan.

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

    • owner

      public final String owner()

      The owner of a Region switch plan.

      Returns:
      The owner of a Region switch plan.

    • name

      public final String name()

      The name of a Region switch plan.

      Returns:
      The name of a Region switch 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 Region specified for a 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 hasRegions() method.

      Returns:
      The Amazon Web Services Region specified for a Region switch 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.

    • 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 execution was last updated.

      Returns:
      The timestamp when the plan execution was last updated.

    • description

      public final String description()

      The description of a Region switch plan.

      Returns:
      The description of a Region switch plan.

    • executionRole

      public final String executionRole()

      The execution role is a way to categorize a Region switch plan.

      Returns:
      The execution role is a way to categorize a Region switch plan.

    • activePlanExecution

      public final String activePlanExecution()

      Specifies if this is the active plan execution at this time.

      Returns:
      Specifies if this is the active plan execution at this time.

    • recoveryTimeObjectiveMinutes

      public final Integer recoveryTimeObjectiveMinutes()

      The recovery time objective that you've specified.

      Returns:
      The recovery time objective that you've specified.

    • toBuilder

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

    • builder

      public static AbbreviatedPlan.Builder builder()

    • serializableBuilderClass

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