Package software.amazon.smithy.waiters

Class Waiter

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

  • Method Details

    • builder

      public static Waiter.Builder builder()

    • toBuilder

      public software.amazon.smithy.utils.SmithyBuilder<Waiter> toBuilder()
      Specified by:
      toBuilder in interface software.amazon.smithy.utils.ToSmithyBuilder<Waiter>

    • fromNode

      public static Waiter fromNode(software.amazon.smithy.model.node.Node node)
      Create a Waiter from a Node.
      Parameters:
      node - Node to create the Waiter from.
      Returns:
      Returns the created Waiter.
      Throws:
      software.amazon.smithy.model.node.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()
      Specified by:
      getTags in interface software.amazon.smithy.utils.Tagged

    • isDeprecated

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

    • toNode

      public software.amazon.smithy.model.node.Node toNode()
      Specified by:
      toNode in interface software.amazon.smithy.model.node.ToNode

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object