Package software.amazon.smithy.waiters

Class Waiter

java.lang.Object
software.amazon.smithy.waiters.Waiter
All Implemented Interfaces:
ToNode, Tagged, ToSmithyBuilder<Waiter>
public final class Waiter extends Object implements Tagged, ToNode, ToSmithyBuilder<Waiter>
Defines an individual operation waiter.

  • Method Details

    • builder

      public static Waiter.Builder builder()

    • toBuilder

      public SmithyBuilder<Waiter> toBuilder()
      Description copied from interface: ToSmithyBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToSmithyBuilder<Waiter>
      Returns:
      a builder for type T

    • fromNode

      public static Waiter fromNode(Node node)
      Create a Waiter from a Node.
      Parameters:
      node - Node to create the Waiter from.
      Returns:
      Returns the created Waiter.
      Throws:
      ExpectationNotMetException - if the given node is invalid.

    • getDocumentation

      public Optional<String> getDocumentation()
      Gets the documentation of the waiter.
      Returns:
      Return the optional documentation.

    • getAcceptors

      public List<Acceptor> getAcceptors()
      Gets the list of Acceptors.
      Returns:
      Returns the acceptors of the waiter.

    • getMinDelay

      public int getMinDelay()
      Gets the minimum amount of time to wait between retries in seconds.
      Returns:
      Gets the minimum retry wait time in seconds.

    • getMaxDelay

      public int getMaxDelay()
      Gets the maximum amount of time allowed to wait between retries in seconds.
      Returns:
      Gets the maximum retry wait time in seconds.

    • getTags

      public List<String> getTags()
      Description copied from interface: Tagged
      Gets the tags applied to an object.
      Specified by:
      getTags in interface Tagged
      Returns:
      Returns the tag values.

    • isDeprecated

      public boolean isDeprecated()
      Checks if the waiter is deprecated.
      Returns:
      Returns true if the waiter is deprecated.

    • toNode

      public Node toNode()
      Description copied from interface: ToNode
      Converts a value to a Node.
      Specified by:
      toNode in interface ToNode
      Returns:
      Returns the creates Node.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object