Package software.amazon.awssdk.services.bedrockagentruntime.model

Class Attribution

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.Attribution

All Implemented Interfaces:

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

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

Contains citations for a part of an agent response.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Attribution.Builder

Method Summary

Modifier and Type	Method	Description
static Attribution.Builder	builder()
List<Citation>	citations()	A list of citations and related information for a part of an agent response.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCitations()	For responses, this returns true if the service returned a value for the Citations property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends Attribution.Builder>	serializableBuilderClass()
Attribution.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

hasCitations

public final boolean hasCitations()

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

citations

public final List<Citation> citations()

A list of citations and related information for a part of an agent response.

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

Returns:

A list of citations and related information for a part of an agent response.

toBuilder

public Attribution.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Attribution.Builder,Attribution>

builder

public static Attribution.Builder builder()

serializableBuilderClass

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