Class StartPlanExecutionRequest

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.StartPlanExecutionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartPlanExecutionRequest.Builder,StartPlanExecutionRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartPlanExecutionRequest extends ArcRegionSwitchRequest implements ToCopyableBuilder<StartPlanExecutionRequest.Builder,StartPlanExecutionRequest>

  • Method Details

    • planArn

      public final String planArn()

      The Amazon Resource Name (ARN) of the plan to execute.

      Returns:
      The Amazon Resource Name (ARN) of the plan to execute.

    • targetRegion

      public final String targetRegion()

      The Amazon Web Services Region to target with this execution. This is the Region that traffic will be shifted to or from, depending on the action.

      Returns:
      The Amazon Web Services Region to target with this execution. This is the Region that traffic will be shifted to or from, depending on the action.

    • action

      public final ExecutionAction action()

      The action to perform. Valid values are ACTIVATE (to shift traffic to the target Region) or DEACTIVATE (to shift traffic away from the target Region).

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

      Returns:
      The action to perform. Valid values are ACTIVATE (to shift traffic to the target Region) or DEACTIVATE (to shift traffic away from the target Region).
      See Also:

    • actionAsString

      public final String actionAsString()

      The action to perform. Valid values are ACTIVATE (to shift traffic to the target Region) or DEACTIVATE (to shift traffic away from the target Region).

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

      Returns:
      The action to perform. Valid values are ACTIVATE (to shift traffic to the target Region) or DEACTIVATE (to shift traffic away from the target Region).
      See Also:

    • mode

      public final ExecutionMode mode()

      The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.

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

      Returns:
      The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.
      See Also:

    • modeAsString

      public final String modeAsString()

      The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.

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

      Returns:
      The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.
      See Also:

    • comment

      public final String comment()

      An optional comment explaining why the plan execution is being started.

      Returns:
      An optional comment explaining why the plan execution is being started.

    • latestVersion

      public final String latestVersion()

      A boolean value indicating whether to use the latest version of the plan. If set to false, you must specify a specific version.

      Returns:
      A boolean value indicating whether to use the latest version of the plan. If set to false, you must specify a specific version.

    • toBuilder

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

    • builder

      public static StartPlanExecutionRequest.Builder builder()

    • serializableBuilderClass

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