Package software.amazon.awssdk.services.lexmodelsv2.model

Class OpensearchConfiguration

java.lang.Object

software.amazon.awssdk.services.lexmodelsv2.model.OpensearchConfiguration

All Implemented Interfaces:

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

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

Contains details about the configuration of the Amazon OpenSearch Service database used for the AMAZON.QnAIntent.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OpensearchConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static OpensearchConfiguration.Builder	builder()
String	domainEndpoint()	The endpoint of the Amazon OpenSearch Service domain.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	exactResponse()	Specifies whether to return an exact response or to return an answer generated by the model using the fields you specify from the database.
ExactResponseFields	exactResponseFields()	Contains the names of the fields used for an exact response to the user.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIncludeFields()	For responses, this returns true if the service returned a value for the IncludeFields property.
List<String>	includeFields()	Contains a list of fields from the Amazon OpenSearch Service that the model can use to generate the answer to the query.
String	indexName()	The name of the Amazon OpenSearch Service index.
List<SdkField<?>>	sdkFields()
static Class<? extends OpensearchConfiguration.Builder>	serializableBuilderClass()
OpensearchConfiguration.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

domainEndpoint

public final String domainEndpoint()

The endpoint of the Amazon OpenSearch Service domain.

Returns:

The endpoint of the Amazon OpenSearch Service domain.

indexName

public final String indexName()

The name of the Amazon OpenSearch Service index.

Returns:

The name of the Amazon OpenSearch Service index.

exactResponse

public final Boolean exactResponse()

Specifies whether to return an exact response or to return an answer generated by the model using the fields you specify from the database.

Returns:

Specifies whether to return an exact response or to return an answer generated by the model using the fields you specify from the database.

exactResponseFields

public final ExactResponseFields exactResponseFields()

Contains the names of the fields used for an exact response to the user.

Returns:

Contains the names of the fields used for an exact response to the user.

hasIncludeFields

public final boolean hasIncludeFields()

For responses, this returns true if the service returned a value for the IncludeFields property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

includeFields

public final List<String> includeFields()

Contains a list of fields from the Amazon OpenSearch Service that the model can use to generate the answer to the query.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIncludeFields() method.

Returns:

Contains a list of fields from the Amazon OpenSearch Service that the model can use to generate the answer to the query.

toBuilder

public OpensearchConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OpensearchConfiguration.Builder,OpensearchConfiguration>

builder

public static OpensearchConfiguration.Builder builder()

serializableBuilderClass

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