ExamplesTrait (Smithy API 1.47.0)

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

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait, ToSmithyBuilder<ExamplesTrait>
```
public final class ExamplesTrait
extends AbstractTrait
implements 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 an examples trait.
`static class`	`ExamplesTrait.ErrorExample`
`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.
`boolean`	`equals(java.lang.Object other)`
`java.util.List<ExamplesTrait.Example>`	`getExamples()`
`int`	`hashCode()`
`ExamplesTrait.Builder`	`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
getSourceLocation, 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 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.
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class AbstractTrait
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AbstractTrait
  - toBuilder
```
public ExamplesTrait.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>
    
    Returns:
    
    a builder for type T
  - builder
```
public static ExamplesTrait.Builder builder()
```
    Returns:
    
    Returns a builder used to create an examples trait.