Class HttpApiKeyAuthTrait
java.lang.Object
software.amazon.smithy.model.traits.AbstractTrait
software.amazon.smithy.model.traits.HttpApiKeyAuthTrait
- All Implemented Interfaces:
FromSourceLocation
,ToNode
,ToShapeId
,Trait
,software.amazon.smithy.utils.ToSmithyBuilder<HttpApiKeyAuthTrait>
public final class HttpApiKeyAuthTrait
extends AbstractTrait
implements software.amazon.smithy.utils.ToSmithyBuilder<HttpApiKeyAuthTrait>
An HTTP-specific authentication scheme that sends an arbitrary
API key in a header or query string parameter.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
static enum
static final class
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic HttpApiKeyAuthTrait.Builder
builder()
protected Node
The result of toNode is used for hashCodes and equality.getIn()
getName()
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
-
-
Method Details
-
getScheme
-
getName
-
getIn
-
toBuilder
- Specified by:
toBuilder
in interfacesoftware.amazon.smithy.utils.ToSmithyBuilder<HttpApiKeyAuthTrait>
-
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.
-
builder
-