Package software.amazon.awssdk.services.kendra.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BasicAuthenticationConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static BasicAuthenticationConfiguration.Builder	builder()
String	credentials()	Your secret ARN, which you can create in Secrets Manager
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	host()	The name of the website host you want to connect to using authentication credentials.
Integer	port()	The port number of the website host you want to connect to using authentication credentials.
List<SdkField<?>>	sdkFields()
static Class<? extends BasicAuthenticationConfiguration.Builder>	serializableBuilderClass()
BasicAuthenticationConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

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()

Your secret ARN, which you can create 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:

Your secret ARN, which you can create 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()

Specified by:

toBuilder in interface ToCopyableBuilder<BasicAuthenticationConfiguration.Builder,BasicAuthenticationConfiguration>

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)

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo