Package software.amazon.smithy.model.traits

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

Nested Classes

Modifier and Type	Class	Description
static final class	HttpApiKeyAuthTrait.Builder
static enum	HttpApiKeyAuthTrait.Location
static final class	HttpApiKeyAuthTrait.Provider

Field Summary

Fields

Modifier and Type	Field	Description
static final ShapeId	ID

Method Summary

Modifier and Type	Method	Description
static HttpApiKeyAuthTrait.Builder	builder()
protected Node	createNode()	The result of toNode is used for hashCodes and equality.
HttpApiKeyAuthTrait.Location	getIn()
String	getName()
Optional<String>	getScheme()
HttpApiKeyAuthTrait.Builder	toBuilder()

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

Method Details

getScheme

public Optional<String> getScheme()

getName

public String getName()

getIn

public HttpApiKeyAuthTrait.Location getIn()

toBuilder

public HttpApiKeyAuthTrait.Builder toBuilder()

Specified by:

toBuilder in interface software.amazon.smithy.utils.ToSmithyBuilder<HttpApiKeyAuthTrait>

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.

builder

public static HttpApiKeyAuthTrait.Builder builder()