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:

  • Method Details

    • 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.

    • idcAuthConfiguration

      public final IdcAuthConfiguration idcAuthConfiguration()

      Information about the IAM Identity Center Application used to configure authentication for a plugin.

      Returns:
      Information about the IAM Identity Center Application used to configure authentication for a plugin.

    • toBuilder

      public PluginAuthConfiguration.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<PluginAuthConfiguration.Builder,PluginAuthConfiguration>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.

    • fromIdcAuthConfiguration

      public static PluginAuthConfiguration fromIdcAuthConfiguration(IdcAuthConfiguration idcAuthConfiguration)
      Create an instance of this class with idcAuthConfiguration() initialized to the given value.

      Information about the IAM Identity Center Application used to configure authentication for a plugin.

      Parameters:
      idcAuthConfiguration - Information about the IAM Identity Center Application used to configure authentication for a plugin.

    • fromIdcAuthConfiguration

      public static PluginAuthConfiguration fromIdcAuthConfiguration(Consumer<IdcAuthConfiguration.Builder> idcAuthConfiguration)
      Create an instance of this class with idcAuthConfiguration() initialized to the given value.

      Information about the IAM Identity Center Application used to configure authentication for a plugin.

      Parameters:
      idcAuthConfiguration - Information about the IAM Identity Center Application used to configure authentication for a plugin.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.