Class CreatePlanRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.arcregionswitch.model.ArcRegionSwitchRequest
software.amazon.awssdk.services.arcregionswitch.model.CreatePlanRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreatePlanRequest.Builder,CreatePlanRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreatePlanRequest extends ArcRegionSwitchRequest implements ToCopyableBuilder<CreatePlanRequest.Builder,CreatePlanRequest>

  • Method Details

    • description

      public final String description()

      The description of a Region switch plan.

      Returns:
      The description of a 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()

      An array of workflows included in 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 hasWorkflows() method.

      Returns:
      An array of workflows included in a Region switch plan.

    • executionRole

      public final String executionRole()

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

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

    • recoveryTimeObjectiveMinutes

      public final Integer recoveryTimeObjectiveMinutes()

      Optionally, you can specify an recovery time objective for a Region switch plan, in minutes.

      Returns:
      Optionally, you can specify an recovery time objective for a Region switch plan, in minutes.

    • 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 alarms associated with 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 hasAssociatedAlarms() method.

      Returns:
      The alarms associated with a Region switch 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 associated with 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 hasTriggers() method.

      Returns:
      The triggers associated with 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()

      An array that specifies the Amazon Web Services Regions for a Region switch plan. Specify two Regions.

      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:
      An array that specifies the Amazon Web Services Regions for a Region switch plan. Specify two Regions.

    • 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 Amazon Web Services Region for the application. This is the Region where the application normally runs before any Region switch occurs.

      Returns:
      The primary Amazon Web Services Region for the application. This is the Region where the application normally runs before any Region switch occurs.

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

      The tags to apply to 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 hasTags() method.

      Returns:
      The tags to apply to the Region switch plan.

    • toBuilder

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

    • builder

      public static CreatePlanRequest.Builder builder()

    • serializableBuilderClass

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