Package software.amazon.smithy.waiters

Class WaitableTrait

java.lang.Object

software.amazon.smithy.model.traits.AbstractTrait

software.amazon.smithy.waiters.WaitableTrait

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait, ToSmithyBuilder<WaitableTrait>

public final class WaitableTrait
extends AbstractTrait
implements 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 ShapeId	ID

Method Summary

Modifier and Type	Method	Description
static WaitableTrait.Builder	builder()
protected Node	createNode()	The result of toNode is used for hashCodes and equality.
Map<String,Waiter>	getWaiters()	Gets the waiters defined on the trait.
SmithyBuilder<WaitableTrait>	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.

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 ShapeId ID

Method Details

builder

public static WaitableTrait.Builder builder()

toBuilder

public SmithyBuilder<WaitableTrait> 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<WaitableTrait>

Returns:

a builder for type T

getWaiters

public Map<String,Waiter> getWaiters()

Gets the waiters defined on the trait.

Returns:

Returns the defined waiters.

createNode

protected Node createNode()

Description copied from class: AbstractTrait

The result of toNode is used for hashCodes and equality. Subclasses must implement createNode to turn the trait into a Node. This is then cached for subsequent retrievals.

Specified by:

createNode in class AbstractTrait

Returns:

Returns the trait as a node.