Interface RetrievalResultLocation.Builder

All Superinterfaces:

Buildable, CopyableBuilder<RetrievalResultLocation.Builder,RetrievalResultLocation>, SdkBuilder<RetrievalResultLocation.Builder,RetrievalResultLocation>, SdkPojo

Enclosing class:

RetrievalResultLocation

@Mutable
@NotThreadSafe
public static interface RetrievalResultLocation.Builder
extends SdkPojo, CopyableBuilder<RetrievalResultLocation.Builder,RetrievalResultLocation>

Method Summary

Modifier and Type	Method	Description
default RetrievalResultLocation.Builder	confluenceLocation(Consumer<RetrievalResultConfluenceLocation.Builder> confluenceLocation)	The Confluence data source location.
RetrievalResultLocation.Builder	confluenceLocation(RetrievalResultConfluenceLocation confluenceLocation)	The Confluence data source location.
default RetrievalResultLocation.Builder	customDocumentLocation(Consumer<RetrievalResultCustomDocumentLocation.Builder> customDocumentLocation)	Specifies the location of a document in a custom data source.
RetrievalResultLocation.Builder	customDocumentLocation(RetrievalResultCustomDocumentLocation customDocumentLocation)	Specifies the location of a document in a custom data source.
default RetrievalResultLocation.Builder	kendraDocumentLocation(Consumer<RetrievalResultKendraDocumentLocation.Builder> kendraDocumentLocation)	The location of a document in Amazon Kendra.
RetrievalResultLocation.Builder	kendraDocumentLocation(RetrievalResultKendraDocumentLocation kendraDocumentLocation)	The location of a document in Amazon Kendra.
default RetrievalResultLocation.Builder	s3Location(Consumer<RetrievalResultS3Location.Builder> s3Location)	The S3 data source location.
RetrievalResultLocation.Builder	s3Location(RetrievalResultS3Location s3Location)	The S3 data source location.
default RetrievalResultLocation.Builder	salesforceLocation(Consumer<RetrievalResultSalesforceLocation.Builder> salesforceLocation)	The Salesforce data source location.
RetrievalResultLocation.Builder	salesforceLocation(RetrievalResultSalesforceLocation salesforceLocation)	The Salesforce data source location.
default RetrievalResultLocation.Builder	sharePointLocation(Consumer<RetrievalResultSharePointLocation.Builder> sharePointLocation)	The SharePoint data source location.
RetrievalResultLocation.Builder	sharePointLocation(RetrievalResultSharePointLocation sharePointLocation)	The SharePoint data source location.
default RetrievalResultLocation.Builder	sqlLocation(Consumer<RetrievalResultSqlLocation.Builder> sqlLocation)	Specifies information about the SQL query used to retrieve the result.
RetrievalResultLocation.Builder	sqlLocation(RetrievalResultSqlLocation sqlLocation)	Specifies information about the SQL query used to retrieve the result.
RetrievalResultLocation.Builder	type(String type)	The type of data source location.
RetrievalResultLocation.Builder	type(RetrievalResultLocationType type)	The type of data source location.
default RetrievalResultLocation.Builder	webLocation(Consumer<RetrievalResultWebLocation.Builder> webLocation)	The web URL/URLs data source location.
RetrievalResultLocation.Builder	webLocation(RetrievalResultWebLocation webLocation)	The web URL/URLs data source location.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

confluenceLocation

RetrievalResultLocation.Builder confluenceLocation(RetrievalResultConfluenceLocation confluenceLocation)

The Confluence data source location.

Parameters:

confluenceLocation - The Confluence data source location.

Returns:

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

confluenceLocation

default RetrievalResultLocation.Builder confluenceLocation(Consumer<RetrievalResultConfluenceLocation.Builder> confluenceLocation)

The Confluence data source location.

This is a convenience method that creates an instance of the RetrievalResultConfluenceLocation.Builder avoiding the need to create one manually via RetrievalResultConfluenceLocation.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to confluenceLocation(RetrievalResultConfluenceLocation).

Parameters:

confluenceLocation - a consumer that will call methods on RetrievalResultConfluenceLocation.Builder

Returns:

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

See Also:

• confluenceLocation(RetrievalResultConfluenceLocation)

customDocumentLocation

RetrievalResultLocation.Builder customDocumentLocation(RetrievalResultCustomDocumentLocation customDocumentLocation)

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

Parameters:

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

Returns:

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

customDocumentLocation

default RetrievalResultLocation.Builder customDocumentLocation(Consumer<RetrievalResultCustomDocumentLocation.Builder> customDocumentLocation)

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

This is a convenience method that creates an instance of the RetrievalResultCustomDocumentLocation.Builder avoiding the need to create one manually via RetrievalResultCustomDocumentLocation.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customDocumentLocation(RetrievalResultCustomDocumentLocation).

Parameters:

customDocumentLocation - a consumer that will call methods on RetrievalResultCustomDocumentLocation.Builder

Returns:

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

See Also:

• customDocumentLocation(RetrievalResultCustomDocumentLocation)

kendraDocumentLocation

RetrievalResultLocation.Builder kendraDocumentLocation(RetrievalResultKendraDocumentLocation kendraDocumentLocation)

The location of a document in Amazon Kendra.

Parameters:

kendraDocumentLocation - The location of a document in Amazon Kendra.

Returns:

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

kendraDocumentLocation

default RetrievalResultLocation.Builder kendraDocumentLocation(Consumer<RetrievalResultKendraDocumentLocation.Builder> kendraDocumentLocation)

The location of a document in Amazon Kendra.

This is a convenience method that creates an instance of the RetrievalResultKendraDocumentLocation.Builder avoiding the need to create one manually via RetrievalResultKendraDocumentLocation.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to kendraDocumentLocation(RetrievalResultKendraDocumentLocation).

Parameters:

kendraDocumentLocation - a consumer that will call methods on RetrievalResultKendraDocumentLocation.Builder

Returns:

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

See Also:

• kendraDocumentLocation(RetrievalResultKendraDocumentLocation)

s3Location

RetrievalResultLocation.Builder s3Location(RetrievalResultS3Location s3Location)

The S3 data source location.

Parameters:

s3Location - The S3 data source location.

Returns:

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

s3Location

default RetrievalResultLocation.Builder s3Location(Consumer<RetrievalResultS3Location.Builder> s3Location)

The S3 data source location.

This is a convenience method that creates an instance of the RetrievalResultS3Location.Builder avoiding the need to create one manually via RetrievalResultS3Location.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to s3Location(RetrievalResultS3Location).

Parameters:

s3Location - a consumer that will call methods on RetrievalResultS3Location.Builder

Returns:

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

See Also:

• s3Location(RetrievalResultS3Location)

salesforceLocation

RetrievalResultLocation.Builder salesforceLocation(RetrievalResultSalesforceLocation salesforceLocation)

The Salesforce data source location.

Parameters:

salesforceLocation - The Salesforce data source location.

Returns:

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

salesforceLocation

default RetrievalResultLocation.Builder salesforceLocation(Consumer<RetrievalResultSalesforceLocation.Builder> salesforceLocation)

The Salesforce data source location.

This is a convenience method that creates an instance of the RetrievalResultSalesforceLocation.Builder avoiding the need to create one manually via RetrievalResultSalesforceLocation.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to salesforceLocation(RetrievalResultSalesforceLocation).

Parameters:

salesforceLocation - a consumer that will call methods on RetrievalResultSalesforceLocation.Builder

Returns:

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

See Also:

• salesforceLocation(RetrievalResultSalesforceLocation)

sharePointLocation

RetrievalResultLocation.Builder sharePointLocation(RetrievalResultSharePointLocation sharePointLocation)

The SharePoint data source location.

Parameters:

sharePointLocation - The SharePoint data source location.

Returns:

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

sharePointLocation

default RetrievalResultLocation.Builder sharePointLocation(Consumer<RetrievalResultSharePointLocation.Builder> sharePointLocation)

The SharePoint data source location.

This is a convenience method that creates an instance of the RetrievalResultSharePointLocation.Builder avoiding the need to create one manually via RetrievalResultSharePointLocation.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sharePointLocation(RetrievalResultSharePointLocation).

Parameters:

sharePointLocation - a consumer that will call methods on RetrievalResultSharePointLocation.Builder

Returns:

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

See Also:

• sharePointLocation(RetrievalResultSharePointLocation)

sqlLocation

RetrievalResultLocation.Builder sqlLocation(RetrievalResultSqlLocation sqlLocation)

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

Parameters:

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

Returns:

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

sqlLocation

default RetrievalResultLocation.Builder sqlLocation(Consumer<RetrievalResultSqlLocation.Builder> sqlLocation)

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

This is a convenience method that creates an instance of the RetrievalResultSqlLocation.Builder avoiding the need to create one manually via RetrievalResultSqlLocation.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sqlLocation(RetrievalResultSqlLocation).

Parameters:

sqlLocation - a consumer that will call methods on RetrievalResultSqlLocation.Builder

Returns:

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

See Also:

• sqlLocation(RetrievalResultSqlLocation)

type

RetrievalResultLocation.Builder type(String type)

The type of data source location.

Parameters:

type - The type of data source location.

Returns:

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

See Also:

• RetrievalResultLocationType
• RetrievalResultLocationType

type

RetrievalResultLocation.Builder type(RetrievalResultLocationType type)

The type of data source location.

Parameters:

type - The type of data source location.

Returns:

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

See Also:

• RetrievalResultLocationType
• RetrievalResultLocationType

webLocation

RetrievalResultLocation.Builder webLocation(RetrievalResultWebLocation webLocation)

The web URL/URLs data source location.

Parameters:

webLocation - The web URL/URLs data source location.

Returns:

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

webLocation

default RetrievalResultLocation.Builder webLocation(Consumer<RetrievalResultWebLocation.Builder> webLocation)

The web URL/URLs data source location.

This is a convenience method that creates an instance of the RetrievalResultWebLocation.Builder avoiding the need to create one manually via RetrievalResultWebLocation.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to webLocation(RetrievalResultWebLocation).

Parameters:

webLocation - a consumer that will call methods on RetrievalResultWebLocation.Builder

Returns:

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

See Also:

• webLocation(RetrievalResultWebLocation)