Class BasicAuthenticationConfiguration

java.lang.Object
software.amazon.awssdk.services.kendra.model.BasicAuthenticationConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<BasicAuthenticationConfiguration.Builder,BasicAuthenticationConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class BasicAuthenticationConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BasicAuthenticationConfiguration.Builder,BasicAuthenticationConfiguration>

Provides the configuration information to connect to websites that require basic user authentication.

See Also:

  • Method Details

    • host

      public final String host()

      The name of the website host you want to connect to using authentication credentials.

      For example, the host name of https://a.example.com/page1.html is "a.example.com".

      Returns:
      The name of the website host you want to connect to using authentication credentials.

      For example, the host name of https://a.example.com/page1.html is "a.example.com".

    • port

      public final Integer port()

      The port number of the website host you want to connect to using authentication credentials.

      For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.

      Returns:
      The port number of the website host you want to connect to using authentication credentials.

      For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.

    • credentials

      public final String credentials()

      The Amazon Resource Name (ARN) of an Secrets Manager secret. You create a secret to store your credentials in Secrets Manager

      You use a secret if basic authentication credentials are required to connect to a website. The secret stores your credentials of user name and password.

      Returns:
      The Amazon Resource Name (ARN) of an Secrets Manager secret. You create a secret to store your credentials in Secrets Manager

      You use a secret if basic authentication credentials are required to connect to a website. The secret stores your credentials of user name and password.

    • toBuilder

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

    • builder

      public static BasicAuthenticationConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends BasicAuthenticationConfiguration.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)

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