software.amazon.awssdk.services.kendra.model

Class DocumentMetadataConfiguration

java.lang.Object

software.amazon.awssdk.services.kendra.model.DocumentMetadataConfiguration

All Implemented Interfaces:

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

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

Specifies the properties of a custom index field.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DocumentMetadataConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static DocumentMetadataConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name() The name of the index field.
Relevance	relevance() Provides manual tuning parameters to determine how the field affects the search results.
List<SdkField<?>>	sdkFields()
Search	search() Provides information about how the field is used during a search.
static Class<? extends DocumentMetadataConfiguration.Builder>	serializableBuilderClass()
DocumentMetadataConfiguration.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
DocumentAttributeValueType	type() The data type of the index field.
String	typeAsString() The data type of the index field.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

name

public final String name()

The name of the index field.

Returns:

The name of the index field.

type

public final DocumentAttributeValueType type()

The data type of the index field.

If the service returns an enum value that is not available in the current SDK version, type will return DocumentAttributeValueType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The data type of the index field.

See Also:

DocumentAttributeValueType

typeAsString

public final String typeAsString()

The data type of the index field.

If the service returns an enum value that is not available in the current SDK version, type will return DocumentAttributeValueType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The data type of the index field.

See Also:

DocumentAttributeValueType

relevance

public final Relevance relevance()

Provides manual tuning parameters to determine how the field affects the search results.

Returns:

Provides manual tuning parameters to determine how the field affects the search results.

search

public final Search search()

Provides information about how the field is used during a search.

Returns:

Provides information about how the field is used during a search.

toBuilder

public DocumentMetadataConfiguration.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<DocumentMetadataConfiguration.Builder,DocumentMetadataConfiguration>

Returns:

a builder for type T

builder

public static DocumentMetadataConfiguration.Builder builder()

serializableBuilderClass

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