Package software.amazon.awssdk.services.qbusiness.model

Class SourceAttribution

java.lang.Object

software.amazon.awssdk.services.qbusiness.model.SourceAttribution

All Implemented Interfaces:

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

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

The documents used to generate an Amazon Q Business web experience response.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SourceAttribution.Builder

Method Summary

Modifier and Type	Method	Description
static SourceAttribution.Builder	builder()
Integer	citationNumber()	The number attached to a citation in an Amazon Q Business generated response.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTextMessageSegments()	For responses, this returns true if the service returned a value for the TextMessageSegments property.
List<SdkField<?>>	sdkFields()
static Class<? extends SourceAttribution.Builder>	serializableBuilderClass()
String	snippet()	The content extract from the document on which the generated response is based.
List<TextSegment>	textMessageSegments()	A text extract from a source document that is used for source attribution.
String	title()	The title of the document which is the source for the Amazon Q Business generated response.
SourceAttribution.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Instant	updatedAt()	The Unix timestamp when the Amazon Q Business application was last updated.
String	url()	The URL of the document which is the source for the Amazon Q Business generated response.

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

title

public final String title()

The title of the document which is the source for the Amazon Q Business generated response.

Returns:

The title of the document which is the source for the Amazon Q Business generated response.

snippet

public final String snippet()

The content extract from the document on which the generated response is based.

Returns:

The content extract from the document on which the generated response is based.

url

public final String url()

The URL of the document which is the source for the Amazon Q Business generated response.

Returns:

The URL of the document which is the source for the Amazon Q Business generated response.

citationNumber

public final Integer citationNumber()

The number attached to a citation in an Amazon Q Business generated response.

Returns:

The number attached to a citation in an Amazon Q Business generated response.

updatedAt

public final Instant updatedAt()

The Unix timestamp when the Amazon Q Business application was last updated.

Returns:

The Unix timestamp when the Amazon Q Business application was last updated.

hasTextMessageSegments

public final boolean hasTextMessageSegments()

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

textMessageSegments

public final List<TextSegment> textMessageSegments()

A text extract from a source document that is used for source attribution.

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

Returns:

A text extract from a source document that is used for source attribution.

toBuilder

public SourceAttribution.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SourceAttribution.Builder,SourceAttribution>

builder

public static SourceAttribution.Builder builder()

serializableBuilderClass

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