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 and Description
default DescribeDataSourceResponse.Builder	configuration(Consumer<DataSourceConfiguration.Builder> configuration) Information that describes where the data source is located and how the data source is configured.
DescribeDataSourceResponse.Builder	configuration(DataSourceConfiguration configuration) Information that describes where the data source is located and how the data source is configured.
DescribeDataSourceResponse.Builder	createdAt(Instant createdAt) The Unix timestamp of when the data source was created.
DescribeDataSourceResponse.Builder	description(String description) The description of the data source.
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.
DescribeDataSourceResponse.Builder	indexId(String indexId) The identifier of the index that contains the data source.
DescribeDataSourceResponse.Builder	name(String name) The name that you gave the data source when it was created.
DescribeDataSourceResponse.Builder	roleArn(String roleArn) The Amazon Resource Name (ARN) of the role that enables the data source to access its resources.
DescribeDataSourceResponse.Builder	schedule(String schedule) The schedule that Amazon Kendra will update the data source.
DescribeDataSourceResponse.Builder	status(DataSourceStatus status) The current status of the data source.
DescribeDataSourceResponse.Builder	status(String status) The current status of the data source.
DescribeDataSourceResponse.Builder	type(DataSourceType type) The type of the data source.
DescribeDataSourceResponse.Builder	type(String type) The type of the data source.
DescribeDataSourceResponse.Builder	updatedAt(Instant updatedAt) The Unix timestamp of when the data source was last updated.

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

build, responseMetadata, responseMetadata

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

sdkHttpResponse, sdkHttpResponse

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

id

DescribeDataSourceResponse.Builder id(String id)

The identifier of the data source.

Parameters:

id - The identifier of the data source.

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 that contains the data source.

Parameters:

indexId - The identifier of the index that contains the data source.

Returns:

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

name

DescribeDataSourceResponse.Builder name(String name)

The name that you gave the data source when it was created.

Parameters:

name - The name that you gave the data source when it was created.

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.

Parameters:

type - The type of the data source.

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.

Parameters:

type - The type of the data source.

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)

Information that describes where the data source is located and how the data source is configured. The specific information in the description depends on the data source provider.

Parameters:

configuration - Information that describes where the data source is located and how the data source is configured. The specific information in the description depends 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)

Information that describes where the data source is located and how the data source is configured. The specific information in the description depends on the data source provider.

This is a convenience 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)

createdAt

DescribeDataSourceResponse.Builder createdAt(Instant createdAt)

The Unix timestamp of when the data source was created.

Parameters:

createdAt - The Unix timestamp of when the data source 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 of when the data source was last updated.

Parameters:

updatedAt - The Unix timestamp of when the data source 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 of the data source.

Parameters:

description - The description of the data source.

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. 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. 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. 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. 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 that Amazon Kendra will update the data source.

Parameters:

schedule - The schedule that Amazon Kendra will update the data source.

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 that enables the data source to access its resources.

Parameters:

roleArn - The Amazon Resource Name (ARN) of the role that enables the data source to access its 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.