DeprecatedTrait (Smithy API 1.47.0)

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

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait, ToSmithyBuilder<DeprecatedTrait>
```
public final class DeprecatedTrait
extends AbstractTrait
implements ToSmithyBuilder<DeprecatedTrait>
```
Marks a shape as deprecated.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class DeprecatedTrait.Builder
Builder used to create a DeprecatedTrait.

static class DeprecatedTrait.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 DeprecatedTrait.Builder`	`builder()`
`protected Node`	`createNode()`	The result of toNode is used for hashCodes and equality.
`java.util.Optional<java.lang.String>`	`getMessage()`	Gets the deprecation message value.
`java.util.Optional<java.lang.String>`	`getSince()`	Gets the deprecated since value.
`DeprecatedTrait.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
  - getSince
```
public java.util.Optional<java.lang.String> getSince()
```
    Gets the deprecated since value.
    
    Returns:
    
    returns the optional deprecated since value.
  - getMessage
```
public java.util.Optional<java.lang.String> getMessage()
```
    Gets the deprecation message value.
    
    Returns:
    
    returns the optional deprecation message value.
  - 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 DeprecatedTrait.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<DeprecatedTrait>
    
    Returns:
    
    a builder for type T
  - builder
```
public static DeprecatedTrait.Builder builder()
```
    Returns:
    
    Returns a builder used to create a deprecated trait.