Package software.amazon.smithy.model.traits

Class AuthDefinitionTrait

java.lang.Object

software.amazon.smithy.model.traits.AbstractTrait

software.amazon.smithy.model.traits.AuthDefinitionTrait

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait, ToSmithyBuilder<AuthDefinitionTrait>

public final class AuthDefinitionTrait
extends AbstractTrait
implements 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 final class	AuthDefinitionTrait.Builder
static final class	AuthDefinitionTrait.Provider

Field Summary

Fields

Modifier and Type	Field	Description
static final ShapeId	ID

Constructor Summary

Constructors

Constructor	Description
AuthDefinitionTrait(AuthDefinitionTrait.Builder builder)

Method Summary

Modifier and Type	Method	Description
static AuthDefinitionTrait.Builder	builder()
protected Node	createNode()	The result of toNode is used for hashCodes and equality.
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()	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 Details

ID

public static final ShapeId ID

Constructor Details

AuthDefinitionTrait

public AuthDefinitionTrait(AuthDefinitionTrait.Builder builder)

Method Details

getTraits

public 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()

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<AuthDefinitionTrait>

Returns:

a builder for type T