Package software.amazon.awssdk.http.auth.spi.internal.scheme

Class DefaultAuthSchemeOption

java.lang.Object

software.amazon.awssdk.http.auth.spi.internal.scheme.DefaultAuthSchemeOption

All Implemented Interfaces:

AuthSchemeOption, ToCopyableBuilder<AuthSchemeOption.Builder,AuthSchemeOption>

@Immutable
public final class DefaultAuthSchemeOption
extends Object
implements AuthSchemeOption

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DefaultAuthSchemeOption.BuilderImpl

Nested classes/interfaces inherited from interface software.amazon.awssdk.http.auth.spi.scheme.AuthSchemeOption

AuthSchemeOption.Builder, AuthSchemeOption.IdentityPropertyConsumer, AuthSchemeOption.SignerPropertyConsumer

Method Summary

Modifier and Type	Method	Description
static AuthSchemeOption.Builder	builder()
void	forEachIdentityProperty(AuthSchemeOption.IdentityPropertyConsumer consumer)	A method to operate on all IdentityProperty values of this AuthSchemeOption.
void	forEachSignerProperty(AuthSchemeOption.SignerPropertyConsumer consumer)	A method to operate on all SignerProperty values of this AuthSchemeOption.
<T> T	identityProperty(IdentityProperty<T> property)	Retrieve the value of an IdentityProperty.
String	schemeId()	Retrieve the scheme ID, a unique identifier for the authentication scheme (aws.auth#sigv4, smithy.api#httpBearerAuth).
<T> T	signerProperty(SignerProperty<T> property)	Retrieve the value of an SignerProperty.
AuthSchemeOption.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

builder

public static AuthSchemeOption.Builder builder()

schemeId

public String schemeId()

Description copied from interface: AuthSchemeOption

Retrieve the scheme ID, a unique identifier for the authentication scheme (aws.auth#sigv4, smithy.api#httpBearerAuth).

Specified by:

schemeId in interface AuthSchemeOption

identityProperty

public <T> T identityProperty(IdentityProperty<T> property)

Description copied from interface: AuthSchemeOption

Retrieve the value of an IdentityProperty.

Specified by:

identityProperty in interface AuthSchemeOption

Type Parameters:

T - The type of the IdentityProperty.

Parameters:

property - The IdentityProperty to retrieve the value of.

signerProperty

public <T> T signerProperty(SignerProperty<T> property)

Description copied from interface: AuthSchemeOption

Retrieve the value of an SignerProperty.

Specified by:

signerProperty in interface AuthSchemeOption

Type Parameters:

T - The type of the SignerProperty.

Parameters:

property - The SignerProperty to retrieve the value of.

forEachIdentityProperty

public void forEachIdentityProperty(AuthSchemeOption.IdentityPropertyConsumer consumer)

Description copied from interface: AuthSchemeOption

A method to operate on all IdentityProperty values of this AuthSchemeOption.

Specified by:

forEachIdentityProperty in interface AuthSchemeOption

Parameters:

consumer - The method to apply to each IdentityProperty.

forEachSignerProperty

public void forEachSignerProperty(AuthSchemeOption.SignerPropertyConsumer consumer)

Description copied from interface: AuthSchemeOption

A method to operate on all SignerProperty values of this AuthSchemeOption.

Specified by:

forEachSignerProperty in interface AuthSchemeOption

Parameters:

consumer - The method to apply to each SignerProperty.

toBuilder

public AuthSchemeOption.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<AuthSchemeOption.Builder,AuthSchemeOption>

Returns:

a builder for type T

toString

public String toString()

Overrides:

toString in class Object