Class SpecificationExtensionTrait
- java.lang.Object
-
- software.amazon.smithy.model.traits.AbstractTrait
-
- software.amazon.smithy.openapi.traits.SpecificationExtensionTrait
-
- All Implemented Interfaces:
FromSourceLocation
,ToNode
,ToShapeId
,Trait
,ToSmithyBuilder<SpecificationExtensionTrait>
public final class SpecificationExtensionTrait extends AbstractTrait implements ToSmithyBuilder<SpecificationExtensionTrait>
smithy.openapi#specificationExtension
- Indicates a trait shape should be converted into an OpenAPI specification extension.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SpecificationExtensionTrait.Builder
Builds aSpecificationExtensionTrait
trait.static class
SpecificationExtensionTrait.Provider
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SpecificationExtensionTrait.Builder
builder()
protected Node
createNode()
The result of toNode is used for hashCodes and equality.java.util.Optional<java.lang.String>
getAs()
Gets the specification extension header value in "as".SpecificationExtensionTrait.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
equals, getSourceLocation, hashCode, 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
-
getAs
public java.util.Optional<java.lang.String> getAs()
Gets the specification extension header value in "as".- Returns:
- Returns the optionally present "as".
-
builder
public static SpecificationExtensionTrait.Builder builder()
-
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 classAbstractTrait
- Returns:
- Returns the trait as a node.
-
toBuilder
public SpecificationExtensionTrait.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 interfaceToSmithyBuilder<SpecificationExtensionTrait>
- Returns:
- a builder for type T
-
-