Package software.amazon.smithy.model.traits

Class AuthTrait

java.lang.Object

software.amazon.smithy.model.traits.AbstractTrait

software.amazon.smithy.model.traits.AuthTrait

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait

public final class AuthTrait
extends AbstractTrait

Specifies the auth schemes supported by default for operations bound to a service.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AuthTrait.Provider

Field Summary

Fields

Modifier and Type	Field	Description
static final ShapeId	ID

Constructor Summary

Constructors

Constructor	Description
AuthTrait(List<ShapeId> values)	Deprecated.
AuthTrait(List<ShapeId> values, FromSourceLocation sourceLocation)	Deprecated.
AuthTrait(Set<ShapeId> values)
AuthTrait(Set<ShapeId> values, FromSourceLocation sourceLocation)

Method Summary

Modifier and Type	Method	Description
protected Node	createNode()	The result of toNode is used for hashCodes and equality.
List<ShapeId>	getValues()	Deprecated.
Set<ShapeId>	getValueSet()	Gets the auth scheme trait values.

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

AuthTrait

@Deprecated
public AuthTrait(List<ShapeId> values,
 FromSourceLocation sourceLocation)

Deprecated.

AuthTrait

@Deprecated
public AuthTrait(List<ShapeId> values)

Deprecated.

AuthTrait

public AuthTrait(Set<ShapeId> values,
 FromSourceLocation sourceLocation)

AuthTrait

public AuthTrait(Set<ShapeId> values)

Method Details

getValueSet

public Set<ShapeId> getValueSet()

Gets the auth scheme trait values.

Returns:

Returns the supported auth schemes.

getValues

@Deprecated
public List<ShapeId> getValues()

Deprecated.

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.