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 java.lang.Object
implements Tagged, ToNode, ToSmithyBuilder<Waiter>

Defines an individual operation waiter.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Waiter.Builder

Method Summary

Modifier and Type	Method	Description
static Waiter.Builder	builder()
boolean	equals(java.lang.Object o)
static Waiter	fromNode(Node node)	Create a Waiter from a Node.
java.util.List<Acceptor>	getAcceptors()	Gets the list of Acceptors.
java.util.Optional<java.lang.String>	getDocumentation()	Gets the documentation of the waiter.
int	getMaxDelay()	Gets the maximum amount of time allowed to wait between retries in seconds.
int	getMinDelay()	Gets the minimum amount of time to wait between retries in seconds.
java.util.List<java.lang.String>	getTags()	Gets the tags applied to an object.
int	hashCode()
boolean	isDeprecated()	Checks if the waiter is deprecated.
Waiter.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
Node	toNode()	Converts a value to a Node.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.smithy.utils.Tagged

hasTag

Method Detail

builder

public static Waiter.Builder builder()

toBuilder

public Waiter.Builder 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 java.util.Optional<java.lang.String> getDocumentation()

Gets the documentation of the waiter.

Returns:

Return the optional documentation.

getAcceptors

public java.util.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 java.util.List<java.lang.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(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object