Package software.amazon.smithy.waiters

Class WaitableTrait

java.lang.Object
software.amazon.smithy.model.traits.AbstractTrait
software.amazon.smithy.waiters.WaitableTrait
All Implemented Interfaces:
software.amazon.smithy.model.FromSourceLocation, software.amazon.smithy.model.node.ToNode, software.amazon.smithy.model.shapes.ToShapeId, software.amazon.smithy.model.traits.Trait, software.amazon.smithy.utils.ToSmithyBuilder<WaitableTrait>
public final class WaitableTrait extends software.amazon.smithy.model.traits.AbstractTrait implements software.amazon.smithy.utils.ToSmithyBuilder<WaitableTrait>
Indicates that an operation has various named "waiters" that can be used to poll a resource until it enters a desired state.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    WaitableTrait.Builder
     
    static final class 
    WaitableTrait.Provider
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final software.amazon.smithy.model.shapes.ShapeId
    ID
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static WaitableTrait.Builder
    builder()
     
    protected software.amazon.smithy.model.node.Node
    createNode()
     
    Map<String,Waiter>
    getWaiters()
    Gets the waiters defined on the trait.
    software.amazon.smithy.utils.SmithyBuilder<WaitableTrait>
    toBuilder()
     

    Methods inherited from class software.amazon.smithy.model.traits.AbstractTrait

    equals, getSourceLocation, hashCode, setNodeCache, toNode, toShapeId, toString

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface software.amazon.smithy.model.traits.Trait

    isSynthetic

  • Field Details

    • ID

      public static final software.amazon.smithy.model.shapes.ShapeId ID

  • Method Details

    • builder

      public static WaitableTrait.Builder builder()

    • toBuilder

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

    • getWaiters

      public Map<String,Waiter> getWaiters()
      Gets the waiters defined on the trait.
      Returns:
      Returns the defined waiters.

    • createNode

      protected software.amazon.smithy.model.node.Node createNode()
      Specified by:
      createNode in class software.amazon.smithy.model.traits.AbstractTrait