Package software.amazon.smithy.model.traits

Class ExamplesTrait.Example

java.lang.Object

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

All Implemented Interfaces:

ToNode, ToSmithyBuilder<ExamplesTrait.Example>

Enclosing class:

ExamplesTrait

public static final class ExamplesTrait.Example
extends Object
implements ToNode, ToSmithyBuilder<ExamplesTrait.Example>

A specific example.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ExamplesTrait.Example.Builder	builder()
Optional<String>	getDocumentation()
Optional<ExamplesTrait.ErrorExample>	getError()
ObjectNode	getInput()
ObjectNode	getOutput()
String	getTitle()
ExamplesTrait.Example.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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getTitle

public String getTitle()

Returns:

Returns the title.

getDocumentation

public Optional<String> getDocumentation()

Returns:

Gets the optional documentation.

getInput

public ObjectNode getInput()

Returns:

Gets the input object.

getOutput

public ObjectNode getOutput()

Returns:

Gets the output object.

getError

public Optional<ExamplesTrait.ErrorExample> getError()

Returns:

Gets the error example.

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()

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<ExamplesTrait.Example>

Returns:

a builder for type T

builder

public static ExamplesTrait.Example.Builder builder()