ExamplesTrait (smithy-model 0.9.8 API)

java.lang.Object
- software.amazon.smithy.model.traits.AbstractTrait
- - software.amazon.smithy.model.traits.ExamplesTrait

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait, software.amazon.smithy.utils.ToSmithyBuilder<ExamplesTrait>
```
public final class ExamplesTrait
extends AbstractTrait
implements software.amazon.smithy.utils.ToSmithyBuilder<ExamplesTrait>
```
Defines examples for an operation.

See Also:

ExamplesTraitValidator

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`ExamplesTrait.Builder`	Builds and examples trait.
`static class`	`ExamplesTrait.Example`	A specific example.
`static class`	`ExamplesTrait.Provider`

Field Summary

Fields
Modifier and Type Field Description

static ShapeId ID

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ExamplesTrait.Builder`	`builder()`
`protected Node`	`createNode()`	The result of toNode is used for hashCodes and equality.
`java.util.List<ExamplesTrait.Example>`	`getExamples()`
`ExamplesTrait.Builder`	`toBuilder()`

Methods inherited from class software.amazon.smithy.model.traits.AbstractTrait
equals, getSourceLocation, hashCode, toNode, toShapeId, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ID
```
public static final ShapeId ID
```
- Method Detail
  - getExamples
```
public java.util.List<ExamplesTrait.Example> getExamples()
```
    Returns:
    
    Each example.
  - 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.
  - toBuilder
```
public ExamplesTrait.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface software.amazon.smithy.utils.ToSmithyBuilder<ExamplesTrait>
  - builder
```
public static ExamplesTrait.Builder builder()
```
    Returns:
    
    Returns a builder used to create an examples trait.