Enum State

java.lang.Object
java.lang.Enum<State>
software.amazon.awssdk.services.transfer.model.State
All Implemented Interfaces:
Serializable, Comparable<State>
@Generated("software.amazon.awssdk:codegen") public enum State extends Enum<State>

Describes the condition of a file transfer protocol-enabled server with respect to its ability to perform file operations. There are six possible states: OFFLINE, ONLINE, STARTING, STOPPING, START_FAILED, and STOP_FAILED.

OFFLINE indicates that the server exists, but that it is not available for file operations. ONLINE indicates that the server is available to perform file operations. STARTING indicates that the server's was instantiated, but the server is not yet available to perform file operations. Under normal conditions, it can take a couple of minutes for the server to be completely operational. Both START_FAILED and STOP_FAILED are error conditions.

  • Enum Constant Details

    • OFFLINE

      public static final State OFFLINE

    • ONLINE

      public static final State ONLINE

    • STARTING

      public static final State STARTING

    • STOPPING

      public static final State STOPPING

    • START_FAILED

      public static final State START_FAILED

    • STOP_FAILED

      public static final State STOP_FAILED

    • UNKNOWN_TO_SDK_VERSION

      public static final State UNKNOWN_TO_SDK_VERSION

  • Method Details

    • values

      public static State[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static State valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • toString

      public String toString()
      Overrides:
      toString in class Enum<State>

    • fromValue

      public static State fromValue(String value)
      Use this in place of valueOf to convert the raw string returned by the service into the enum value.
      Parameters:
      value - real value
      Returns:
      State corresponding to the value

    • knownValues

      public static Set<State> knownValues()
      Use this in place of values() to return a Set of all values known to the SDK. This will return all known enum values except UNKNOWN_TO_SDK_VERSION.
      Returns:
      a Set of known States