AuthDefinitionTrait (smithy-model 1.0.1 API)

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

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait, software.amazon.smithy.utils.ToSmithyBuilder<AuthDefinitionTrait>
```
public final class AuthDefinitionTrait
extends AbstractTrait
implements software.amazon.smithy.utils.ToSmithyBuilder<AuthDefinitionTrait>
```
This trait is attached to another trait to define an auth scheme.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class AuthDefinitionTrait.Builder

static class AuthDefinitionTrait.Provider

Field Summary

Fields
Modifier and Type Field Description

static ShapeId ID

Constructor Summary

Constructors
Constructor Description

AuthDefinitionTrait(AuthDefinitionTrait.Builder builder)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static AuthDefinitionTrait.Builder`	`builder()`
`protected Node`	`createNode()`	The result of toNode is used for hashCodes and equality.
`java.util.List<ShapeId>`	`getTraits()`	Gets the list of shape IDs that auth implementations must know about in order to successfully utilize the auth scheme.
`AuthDefinitionTrait.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
```
- Constructor Detail
  - AuthDefinitionTrait
```
public AuthDefinitionTrait(AuthDefinitionTrait.Builder builder)
```
- Method Detail
  - getTraits
```
public java.util.List<ShapeId> getTraits()
```
    Gets the list of shape IDs that auth implementations must know about in order to successfully utilize the auth scheme.
    
    Returns:
    
    Returns the auth traits.
  - builder
```
public static AuthDefinitionTrait.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 class AbstractTrait
    
    Returns:
    
    Returns the trait as a node.
  - toBuilder
```
public AuthDefinitionTrait.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface software.amazon.smithy.utils.ToSmithyBuilder<AuthDefinitionTrait>