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

Class RetrievalResultLocation

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.RetrievalResultLocation

All Implemented Interfaces:

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

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

Contains information about the data source location.

This data type is used in the following API operations:

• Retrieve response – in the location field

• RetrieveAndGenerate response – in the location field

• InvokeAgent response – in the location field

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RetrievalResultLocation.Builder

Method Summary

Modifier and Type	Method	Description
static RetrievalResultLocation.Builder	builder()
RetrievalResultConfluenceLocation	confluenceLocation()	The Confluence data source location.
RetrievalResultCustomDocumentLocation	customDocumentLocation()	Specifies the location of a document in a custom data source.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
RetrievalResultKendraDocumentLocation	kendraDocumentLocation()	The location of a document in Amazon Kendra.
RetrievalResultS3Location	s3Location()	The S3 data source location.
RetrievalResultSalesforceLocation	salesforceLocation()	The Salesforce data source location.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RetrievalResultLocation.Builder>	serializableBuilderClass()
RetrievalResultSharePointLocation	sharePointLocation()	The SharePoint data source location.
RetrievalResultSqlLocation	sqlLocation()	Specifies information about the SQL query used to retrieve the result.
RetrievalResultLocation.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
RetrievalResultLocationType	type()	The type of data source location.
String	typeAsString()	The type of data source location.
RetrievalResultWebLocation	webLocation()	The web URL/URLs data source location.

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

confluenceLocation

public final RetrievalResultConfluenceLocation confluenceLocation()

The Confluence data source location.

Returns:

The Confluence data source location.

customDocumentLocation

public final RetrievalResultCustomDocumentLocation customDocumentLocation()

Specifies the location of a document in a custom data source.

Returns:

Specifies the location of a document in a custom data source.

kendraDocumentLocation

public final RetrievalResultKendraDocumentLocation kendraDocumentLocation()

The location of a document in Amazon Kendra.

Returns:

The location of a document in Amazon Kendra.

s3Location

public final RetrievalResultS3Location s3Location()

The S3 data source location.

Returns:

The S3 data source location.

salesforceLocation

public final RetrievalResultSalesforceLocation salesforceLocation()

The Salesforce data source location.

Returns:

The Salesforce data source location.

sharePointLocation

public final RetrievalResultSharePointLocation sharePointLocation()

The SharePoint data source location.

Returns:

The SharePoint data source location.

sqlLocation

public final RetrievalResultSqlLocation sqlLocation()

Specifies information about the SQL query used to retrieve the result.

Returns:

Specifies information about the SQL query used to retrieve the result.

type

public final RetrievalResultLocationType type()

The type of data source location.

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

Returns:

The type of data source location.

See Also:

RetrievalResultLocationType

typeAsString

public final String typeAsString()

The type of data source location.

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

Returns:

The type of data source location.

See Also:

RetrievalResultLocationType

webLocation

public final RetrievalResultWebLocation webLocation()

The web URL/URLs data source location.

Returns:

The web URL/URLs data source location.

toBuilder

public RetrievalResultLocation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RetrievalResultLocation.Builder,RetrievalResultLocation>

builder

public static RetrievalResultLocation.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo