Class StartPracticeRunResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.arczonalshift.model.ArcZonalShiftResponse
software.amazon.awssdk.services.arczonalshift.model.StartPracticeRunResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartPracticeRunResponse.Builder,StartPracticeRunResponse>
@Generated("software.amazon.awssdk:codegen") public final class StartPracticeRunResponse extends ArcZonalShiftResponse implements ToCopyableBuilder<StartPracticeRunResponse.Builder,StartPracticeRunResponse>

  • Method Details

    • zonalShiftId

      public final String zonalShiftId()

      The identifier of a practice run zonal shift.

      Returns:
      The identifier of a practice run zonal shift.

    • resourceIdentifier

      public final String resourceIdentifier()

      The identifier for the resource that you want to shift traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.

      Returns:
      The identifier for the resource that you want to shift traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.

    • awayFrom

      public final String awayFrom()

      The Availability Zone (for example, use1-az1) that traffic is shifted away from for the resource that you specify for the practice run.

      Returns:
      The Availability Zone (for example, use1-az1) that traffic is shifted away from for the resource that you specify for the practice run.

    • expiryTime

      public final Instant expiryTime()

      The expiry time (expiration time) for an on-demand practice run zonal shift is 30 minutes from the time when you start the practice run, unless you cancel it before that time. However, be aware that the expiryTime field for practice run zonal shifts always has a value of 1 minute.

      Returns:
      The expiry time (expiration time) for an on-demand practice run zonal shift is 30 minutes from the time when you start the practice run, unless you cancel it before that time. However, be aware that the expiryTime field for practice run zonal shifts always has a value of 1 minute.

    • startTime

      public final Instant startTime()

      The time (UTC) when the zonal shift starts.

      Returns:
      The time (UTC) when the zonal shift starts.

    • status

      public final ZonalShiftStatus status()

      A status for the practice run (expected status is ACTIVE).

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

      Returns:
      A status for the practice run (expected status is ACTIVE).
      See Also:

    • statusAsString

      public final String statusAsString()

      A status for the practice run (expected status is ACTIVE).

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

      Returns:
      A status for the practice run (expected status is ACTIVE).
      See Also:

    • comment

      public final String comment()

      The initial comment that you enter about the practice run. Be aware that this comment can be overwritten by Amazon Web Services if the automatic check for balanced capacity fails. For more information, see Capacity checks for practice runs in the Amazon Application Recovery Controller Developer Guide.

      Returns:
      The initial comment that you enter about the practice run. Be aware that this comment can be overwritten by Amazon Web Services if the automatic check for balanced capacity fails. For more information, see Capacity checks for practice runs in the Amazon Application Recovery Controller Developer Guide.

    • toBuilder

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

    • builder

      public static StartPracticeRunResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartPracticeRunResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.