ExternalDocumentationTrait (smithy-model 0.9.8 API)

java.lang.Object
- software.amazon.smithy.model.traits.AbstractTrait
- - software.amazon.smithy.model.traits.StringTrait
  - - software.amazon.smithy.model.traits.ExternalDocumentationTrait

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait
```
public final class ExternalDocumentationTrait
extends StringTrait
```
Provides a link to external documentation of a service or operation.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ExternalDocumentationTrait.Provider

Field Summary

Fields
Modifier and Type Field Description

static ShapeId ID

Constructor Summary

Constructors
Constructor	Description
`ExternalDocumentationTrait(java.lang.String value)`
`ExternalDocumentationTrait(java.lang.String value, SourceLocation sourceLocation)`

Method Summary
- Methods inherited from class software.amazon.smithy.model.traits.StringTrait
  createNode, getValue
- 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
```

Constructor Detail

ExternalDocumentationTrait

public ExternalDocumentationTrait(java.lang.String value,
                                  SourceLocation sourceLocation)

ExternalDocumentationTrait

public ExternalDocumentationTrait(java.lang.String value)