com.amazonaws.services.bedrockagentruntime.model

Class RetrievedReference

java.lang.Object

com.amazonaws.services.bedrockagentruntime.model.RetrievedReference

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RetrievedReference
extends Object
implements Serializable, Cloneable, StructuredPojo

Contains metadata about a source cited for the generated response.

This data type is used in the following API operations:

• RetrieveAndGenerate response – in the retrievedReferences field

• InvokeAgent response – in the retrievedReferences field

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
RetrievedReference()

Method Summary

Modifier and Type	Method and Description
RetrievedReference	clone()
boolean	equals(Object obj)
RetrievalResultContent	getContent() Contains the cited text from the data source.
RetrievalResultLocation	getLocation() Contains information about the location of the data source.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setContent(RetrievalResultContent content) Contains the cited text from the data source.
void	setLocation(RetrievalResultLocation location) Contains information about the location of the data source.
String	toString() Returns a string representation of this object.
RetrievedReference	withContent(RetrievalResultContent content) Contains the cited text from the data source.
RetrievedReference	withLocation(RetrievalResultLocation location) Contains information about the location of the data source.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RetrievedReference

public RetrievedReference()

Method Detail

setContent

public void setContent(RetrievalResultContent content)

Contains the cited text from the data source.

Parameters:

content - Contains the cited text from the data source.

getContent

public RetrievalResultContent getContent()

Contains the cited text from the data source.

Returns:

Contains the cited text from the data source.

withContent

public RetrievedReference withContent(RetrievalResultContent content)

Contains the cited text from the data source.

Parameters:

content - Contains the cited text from the data source.

Returns:

Returns a reference to this object so that method calls can be chained together.

setLocation

public void setLocation(RetrievalResultLocation location)

Contains information about the location of the data source.

Parameters:

location - Contains information about the location of the data source.

getLocation

public RetrievalResultLocation getLocation()

Contains information about the location of the data source.

Returns:

Contains information about the location of the data source.

withLocation

public RetrievedReference withLocation(RetrievalResultLocation location)

Contains information about the location of the data source.

Parameters:

location - Contains information about the location of the data source.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public RetrievedReference clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.