Package software.amazon.awssdk.services.kendra.model

Interface DescribeDataSourceResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeDataSourceResponse.Builder,DescribeDataSourceResponse>, KendraResponse.Builder, SdkBuilder<DescribeDataSourceResponse.Builder,DescribeDataSourceResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeDataSourceResponse

public static interface DescribeDataSourceResponse.Builder
extends KendraResponse.Builder, SdkPojo, CopyableBuilder<DescribeDataSourceResponse.Builder,DescribeDataSourceResponse>

Method Summary

Modifier and Type	Method	Description
default DescribeDataSourceResponse.Builder	configuration(Consumer<DataSourceConfiguration.Builder> configuration)	Configuration details for the data source connector.
DescribeDataSourceResponse.Builder	configuration(DataSourceConfiguration configuration)	Configuration details for the data source connector.
DescribeDataSourceResponse.Builder	createdAt(Instant createdAt)	The Unix timestamp when the data source connector was created.
default DescribeDataSourceResponse.Builder	customDocumentEnrichmentConfiguration(Consumer<CustomDocumentEnrichmentConfiguration.Builder> customDocumentEnrichmentConfiguration)	Configuration information for altering document metadata and content during the document ingestion process when you describe a data source.
DescribeDataSourceResponse.Builder	customDocumentEnrichmentConfiguration(CustomDocumentEnrichmentConfiguration customDocumentEnrichmentConfiguration)	Configuration information for altering document metadata and content during the document ingestion process when you describe a data source.
DescribeDataSourceResponse.Builder	description(String description)	The description for the data source connector.
DescribeDataSourceResponse.Builder	errorMessage(String errorMessage)	When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source to fail.
DescribeDataSourceResponse.Builder	id(String id)	The identifier of the data source connector.
DescribeDataSourceResponse.Builder	indexId(String indexId)	The identifier of the index used with the data source connector.
DescribeDataSourceResponse.Builder	languageCode(String languageCode)	The code for a language.
DescribeDataSourceResponse.Builder	name(String name)	The name for the data source connector.
DescribeDataSourceResponse.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.
DescribeDataSourceResponse.Builder	schedule(String schedule)	The schedule for Amazon Kendra to update the index.
DescribeDataSourceResponse.Builder	status(String status)	The current status of the data source connector.
DescribeDataSourceResponse.Builder	status(DataSourceStatus status)	The current status of the data source connector.
DescribeDataSourceResponse.Builder	type(String type)	The type of the data source.
DescribeDataSourceResponse.Builder	type(DataSourceType type)	The type of the data source.
DescribeDataSourceResponse.Builder	updatedAt(Instant updatedAt)	The Unix timestamp when the data source connector was last updated.
default DescribeDataSourceResponse.Builder	vpcConfiguration(Consumer<DataSourceVpcConfiguration.Builder> vpcConfiguration)	Configuration information for an Amazon Virtual Private Cloud to connect to your data source.
DescribeDataSourceResponse.Builder	vpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)	Configuration information for an Amazon Virtual Private Cloud to connect to your data source.

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

copy

Methods inherited from interface software.amazon.awssdk.services.kendra.model.KendraResponse.Builder

build, responseMetadata, responseMetadata

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

id

DescribeDataSourceResponse.Builder id(String id)

The identifier of the data source connector.

Parameters:

id - The identifier of the data source connector.

Returns:

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

indexId

DescribeDataSourceResponse.Builder indexId(String indexId)

The identifier of the index used with the data source connector.

Parameters:

indexId - The identifier of the index used with the data source connector.

Returns:

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

name

DescribeDataSourceResponse.Builder name(String name)

The name for the data source connector.

Parameters:

name - The name for the data source connector.

Returns:

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

type

DescribeDataSourceResponse.Builder type(String type)

The type of the data source. For example, SHAREPOINT.

Parameters:

type - The type of the data source. For example, SHAREPOINT.

Returns:

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

See Also:

DataSourceType, DataSourceType

type

DescribeDataSourceResponse.Builder type(DataSourceType type)

The type of the data source. For example, SHAREPOINT.

Parameters:

type - The type of the data source. For example, SHAREPOINT.

Returns:

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

See Also:

DataSourceType, DataSourceType

configuration

DescribeDataSourceResponse.Builder configuration(DataSourceConfiguration configuration)

Configuration details for the data source connector. This shows how the data source is configured. The configuration options for a data source depend on the data source provider.

Parameters:

configuration - Configuration details for the data source connector. This shows how the data source is configured. The configuration options for a data source depend on the data source provider.

Returns:

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

configuration

default DescribeDataSourceResponse.Builder configuration(Consumer<DataSourceConfiguration.Builder> configuration)

Configuration details for the data source connector. This shows how the data source is configured. The configuration options for a data source depend on the data source provider.

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

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

Parameters:

configuration - a consumer that will call methods on DataSourceConfiguration.Builder

Returns:

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

See Also:

configuration(DataSourceConfiguration)

vpcConfiguration

DescribeDataSourceResponse.Builder vpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)

Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.

Parameters:

vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.

Returns:

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

vpcConfiguration

default DescribeDataSourceResponse.Builder vpcConfiguration(Consumer<DataSourceVpcConfiguration.Builder> vpcConfiguration)

Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.

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

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

Parameters:

vpcConfiguration - a consumer that will call methods on DataSourceVpcConfiguration.Builder

Returns:

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

See Also:

vpcConfiguration(DataSourceVpcConfiguration)

createdAt

DescribeDataSourceResponse.Builder createdAt(Instant createdAt)

The Unix timestamp when the data source connector was created.

Parameters:

createdAt - The Unix timestamp when the data source connector was created.

Returns:

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

updatedAt

DescribeDataSourceResponse.Builder updatedAt(Instant updatedAt)

The Unix timestamp when the data source connector was last updated.

Parameters:

updatedAt - The Unix timestamp when the data source connector was last updated.

Returns:

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

description

DescribeDataSourceResponse.Builder description(String description)

The description for the data source connector.

Parameters:

description - The description for the data source connector.

Returns:

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

status

DescribeDataSourceResponse.Builder status(String status)

The current status of the data source connector. When the status is ACTIVE the data source is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that the data source failed.

Parameters:

status - The current status of the data source connector. When the status is ACTIVE the data source is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that the data source failed.

Returns:

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

See Also:

DataSourceStatus, DataSourceStatus

status

DescribeDataSourceResponse.Builder status(DataSourceStatus status)

The current status of the data source connector. When the status is ACTIVE the data source is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that the data source failed.

Parameters:

status - The current status of the data source connector. When the status is ACTIVE the data source is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that the data source failed.

Returns:

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

See Also:

DataSourceStatus, DataSourceStatus

schedule

DescribeDataSourceResponse.Builder schedule(String schedule)

The schedule for Amazon Kendra to update the index.

Parameters:

schedule - The schedule for Amazon Kendra to update the index.

Returns:

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

roleArn

DescribeDataSourceResponse.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.

Parameters:

roleArn - The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.

Returns:

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

errorMessage

DescribeDataSourceResponse.Builder errorMessage(String errorMessage)

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source to fail.

Parameters:

errorMessage - When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source to fail.

Returns:

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

languageCode

DescribeDataSourceResponse.Builder languageCode(String languageCode)

The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

Parameters:

languageCode - The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

Returns:

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

customDocumentEnrichmentConfiguration

DescribeDataSourceResponse.Builder customDocumentEnrichmentConfiguration(CustomDocumentEnrichmentConfiguration customDocumentEnrichmentConfiguration)

Configuration information for altering document metadata and content during the document ingestion process when you describe a data source.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

Parameters:

customDocumentEnrichmentConfiguration - Configuration information for altering document metadata and content during the document ingestion process when you describe a data source.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

Returns:

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

customDocumentEnrichmentConfiguration

default DescribeDataSourceResponse.Builder customDocumentEnrichmentConfiguration(Consumer<CustomDocumentEnrichmentConfiguration.Builder> customDocumentEnrichmentConfiguration)

Configuration information for altering document metadata and content during the document ingestion process when you describe a data source.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

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

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

Parameters:

customDocumentEnrichmentConfiguration - a consumer that will call methods on CustomDocumentEnrichmentConfiguration.Builder

Returns:

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

See Also:

customDocumentEnrichmentConfiguration(CustomDocumentEnrichmentConfiguration)