Package software.amazon.awssdk.services.qbusiness.model

Class PluginAuthConfiguration

java.lang.Object

software.amazon.awssdk.services.qbusiness.model.PluginAuthConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PluginAuthConfiguration.Builder,PluginAuthConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class PluginAuthConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PluginAuthConfiguration.Builder,PluginAuthConfiguration>

Authentication configuration information for an Amazon Q Business plugin.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PluginAuthConfiguration.Builder
static class	PluginAuthConfiguration.Type

Method Summary

Modifier and Type	Method	Description
BasicAuthConfiguration	basicAuthConfiguration()	Information about the basic authentication credentials used to configure a plugin.
static PluginAuthConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static PluginAuthConfiguration	fromBasicAuthConfiguration(Consumer<BasicAuthConfiguration.Builder> basicAuthConfiguration)	Create an instance of this class with basicAuthConfiguration() initialized to the given value.
static PluginAuthConfiguration	fromBasicAuthConfiguration(BasicAuthConfiguration basicAuthConfiguration)	Create an instance of this class with basicAuthConfiguration() initialized to the given value.
static PluginAuthConfiguration	fromNoAuthConfiguration(Consumer<NoAuthConfiguration.Builder> noAuthConfiguration)	Create an instance of this class with noAuthConfiguration() initialized to the given value.
static PluginAuthConfiguration	fromNoAuthConfiguration(NoAuthConfiguration noAuthConfiguration)	Create an instance of this class with noAuthConfiguration() initialized to the given value.
static PluginAuthConfiguration	fromOAuth2ClientCredentialConfiguration(Consumer<OAuth2ClientCredentialConfiguration.Builder> oAuth2ClientCredentialConfiguration)	Create an instance of this class with oAuth2ClientCredentialConfiguration() initialized to the given value.
static PluginAuthConfiguration	fromOAuth2ClientCredentialConfiguration(OAuth2ClientCredentialConfiguration oAuth2ClientCredentialConfiguration)	Create an instance of this class with oAuth2ClientCredentialConfiguration() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
NoAuthConfiguration	noAuthConfiguration()	Information about invoking a custom plugin without any authentication.
OAuth2ClientCredentialConfiguration	oAuth2ClientCredentialConfiguration()	Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
List<SdkField<?>>	sdkFields()
static Class<? extends PluginAuthConfiguration.Builder>	serializableBuilderClass()
PluginAuthConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
PluginAuthConfiguration.Type	type()	Retrieve an enum value representing which member of this object is populated.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

basicAuthConfiguration

public final BasicAuthConfiguration basicAuthConfiguration()

Information about the basic authentication credentials used to configure a plugin.

Returns:

Information about the basic authentication credentials used to configure a plugin.

oAuth2ClientCredentialConfiguration

public final OAuth2ClientCredentialConfiguration oAuth2ClientCredentialConfiguration()

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

Returns:

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

noAuthConfiguration

public final NoAuthConfiguration noAuthConfiguration()

Information about invoking a custom plugin without any authentication.

Returns:

Information about invoking a custom plugin without any authentication.

toBuilder

public PluginAuthConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PluginAuthConfiguration.Builder,PluginAuthConfiguration>

builder

public static PluginAuthConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends PluginAuthConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

fromBasicAuthConfiguration

public static PluginAuthConfiguration fromBasicAuthConfiguration(BasicAuthConfiguration basicAuthConfiguration)

Create an instance of this class with basicAuthConfiguration() initialized to the given value.

Information about the basic authentication credentials used to configure a plugin.

Parameters:

basicAuthConfiguration - Information about the basic authentication credentials used to configure a plugin.

fromBasicAuthConfiguration

public static PluginAuthConfiguration fromBasicAuthConfiguration(Consumer<BasicAuthConfiguration.Builder> basicAuthConfiguration)

Create an instance of this class with basicAuthConfiguration() initialized to the given value.

Information about the basic authentication credentials used to configure a plugin.

Parameters:

basicAuthConfiguration - Information about the basic authentication credentials used to configure a plugin.

fromOAuth2ClientCredentialConfiguration

public static PluginAuthConfiguration fromOAuth2ClientCredentialConfiguration(OAuth2ClientCredentialConfiguration oAuth2ClientCredentialConfiguration)

Create an instance of this class with oAuth2ClientCredentialConfiguration() initialized to the given value.

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

Parameters:

oAuth2ClientCredentialConfiguration - Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

fromOAuth2ClientCredentialConfiguration

public static PluginAuthConfiguration fromOAuth2ClientCredentialConfiguration(Consumer<OAuth2ClientCredentialConfiguration.Builder> oAuth2ClientCredentialConfiguration)

Create an instance of this class with oAuth2ClientCredentialConfiguration() initialized to the given value.

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

Parameters:

oAuth2ClientCredentialConfiguration - Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

fromNoAuthConfiguration

public static PluginAuthConfiguration fromNoAuthConfiguration(NoAuthConfiguration noAuthConfiguration)

Create an instance of this class with noAuthConfiguration() initialized to the given value.

Information about invoking a custom plugin without any authentication.

Parameters:

noAuthConfiguration - Information about invoking a custom plugin without any authentication.

fromNoAuthConfiguration

public static PluginAuthConfiguration fromNoAuthConfiguration(Consumer<NoAuthConfiguration.Builder> noAuthConfiguration)

Create an instance of this class with noAuthConfiguration() initialized to the given value.

Information about invoking a custom plugin without any authentication.

Parameters:

noAuthConfiguration - Information about invoking a custom plugin without any authentication.

type

public PluginAuthConfiguration.Type type()

Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be PluginAuthConfiguration.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be PluginAuthConfiguration.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo