software.amazon.smithy.model.traits

Class ExamplesTrait.Example

java.lang.Object

software.amazon.smithy.model.traits.ExamplesTrait.Example

All Implemented Interfaces:

ToNode, software.amazon.smithy.utils.ToSmithyBuilder<ExamplesTrait.Example>

Enclosing class:

ExamplesTrait

public static final class ExamplesTrait.Example
extends java.lang.Object
implements ToNode, software.amazon.smithy.utils.ToSmithyBuilder<ExamplesTrait.Example>

A specific example.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExamplesTrait.Example.Builder Builder used to create ExamplesTrait.Examples.

Method Summary

Modifier and Type	Method and Description
static ExamplesTrait.Example.Builder	builder()
boolean	getAllowConstraintErrors()
java.util.Optional<java.lang.String>	getDocumentation()
java.util.Optional<ExamplesTrait.ErrorExample>	getError()
ObjectNode	getInput()
java.util.Optional<ObjectNode>	getOutput()
java.lang.String	getTitle()
ExamplesTrait.Example.Builder	toBuilder()
Node	toNode() Converts a value to a Node.

Methods inherited from class java.lang.Object

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

Method Detail

getTitle

public java.lang.String getTitle()

Returns:

Returns the title.

getDocumentation

public java.util.Optional<java.lang.String> getDocumentation()

Returns:

Gets the optional documentation.

getInput

public ObjectNode getInput()

Returns:

Gets the input object.

getOutput

public java.util.Optional<ObjectNode> getOutput()

Returns:

Gets the output object.

getError

public java.util.Optional<ExamplesTrait.ErrorExample> getError()

Returns:

Gets the error example.

getAllowConstraintErrors

public boolean getAllowConstraintErrors()

Returns:

Returns true if input constraints errors are allowed.

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.

toBuilder

public ExamplesTrait.Example.Builder toBuilder()

Specified by:

toBuilder in interface software.amazon.smithy.utils.ToSmithyBuilder<ExamplesTrait.Example>

builder

public static ExamplesTrait.Example.Builder builder()