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

Class SourceDocument

java.lang.Object

software.amazon.awssdk.services.kendra.model.SourceDocument

All Implemented Interfaces:

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

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

The document ID and its fields/attributes that are used for a query suggestion, if document fields set to use for query suggestions.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SourceDocument.Builder

Method Summary

Modifier and Type	Method	Description
List<DocumentAttribute>	additionalAttributes()	The additional fields/attributes to include in the response.
static SourceDocument.Builder	builder()
String	documentId()	The identifier of the document used for a query suggestion.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAdditionalAttributes()	For responses, this returns true if the service returned a value for the AdditionalAttributes property.
int	hashCode()
boolean	hasSuggestionAttributes()	For responses, this returns true if the service returned a value for the SuggestionAttributes property.
List<SdkField<?>>	sdkFields()
static Class<? extends SourceDocument.Builder>	serializableBuilderClass()
List<String>	suggestionAttributes()	The document fields/attributes used for a query suggestion.
SourceDocument.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

documentId

public final String documentId()

The identifier of the document used for a query suggestion.

Returns:

The identifier of the document used for a query suggestion.

hasSuggestionAttributes

public final boolean hasSuggestionAttributes()

For responses, this returns true if the service returned a value for the SuggestionAttributes 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.

suggestionAttributes

public final List<String> suggestionAttributes()

The document fields/attributes used for a query suggestion.

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 hasSuggestionAttributes() method.

Returns:

The document fields/attributes used for a query suggestion.

hasAdditionalAttributes

public final boolean hasAdditionalAttributes()

For responses, this returns true if the service returned a value for the AdditionalAttributes 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.

additionalAttributes

public final List<DocumentAttribute> additionalAttributes()

The additional fields/attributes to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.

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 hasAdditionalAttributes() method.

Returns:

The additional fields/attributes to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.

toBuilder

public SourceDocument.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SourceDocument.Builder,SourceDocument>

builder

public static SourceDocument.Builder builder()

serializableBuilderClass

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