software.amazon.awssdk.services.kendra.model

Interface DescribeExperienceResponse.Builder

All Superinterfaces:

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

Enclosing class:

DescribeExperienceResponse

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

Method Summary

Modifier and Type	Method and Description
default DescribeExperienceResponse.Builder	configuration(Consumer<ExperienceConfiguration.Builder> configuration) Shows the configuration information for your Amazon Kendra experience.
DescribeExperienceResponse.Builder	configuration(ExperienceConfiguration configuration) Shows the configuration information for your Amazon Kendra experience.
DescribeExperienceResponse.Builder	createdAt(Instant createdAt) The Unix timestamp when your Amazon Kendra experience was created.
DescribeExperienceResponse.Builder	description(String description) Shows the description for your Amazon Kendra experience.
DescribeExperienceResponse.Builder	endpoints(Collection<ExperienceEndpoint> endpoints) Shows the endpoint URLs for your Amazon Kendra experiences.
DescribeExperienceResponse.Builder	endpoints(Consumer<ExperienceEndpoint.Builder>... endpoints) Shows the endpoint URLs for your Amazon Kendra experiences.
DescribeExperienceResponse.Builder	endpoints(ExperienceEndpoint... endpoints) Shows the endpoint URLs for your Amazon Kendra experiences.
DescribeExperienceResponse.Builder	errorMessage(String errorMessage) The reason your Amazon Kendra experience could not properly process.
DescribeExperienceResponse.Builder	id(String id) Shows the identifier of your Amazon Kendra experience.
DescribeExperienceResponse.Builder	indexId(String indexId) Shows the identifier of the index for your Amazon Kendra experience.
DescribeExperienceResponse.Builder	name(String name) Shows the name of your Amazon Kendra experience.
DescribeExperienceResponse.Builder	roleArn(String roleArn) Shows the Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center that stores your user and group information.
DescribeExperienceResponse.Builder	status(ExperienceStatus status) The current processing status of your Amazon Kendra experience.
DescribeExperienceResponse.Builder	status(String status) The current processing status of your Amazon Kendra experience.
DescribeExperienceResponse.Builder	updatedAt(Instant updatedAt) The Unix timestamp when your Amazon Kendra experience 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

DescribeExperienceResponse.Builder id(String id)

Shows the identifier of your Amazon Kendra experience.

Parameters:

id - Shows the identifier of your Amazon Kendra experience.

Returns:

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

indexId

DescribeExperienceResponse.Builder indexId(String indexId)

Shows the identifier of the index for your Amazon Kendra experience.

Parameters:

indexId - Shows the identifier of the index for your Amazon Kendra experience.

Returns:

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

name

DescribeExperienceResponse.Builder name(String name)

Shows the name of your Amazon Kendra experience.

Parameters:

name - Shows the name of your Amazon Kendra experience.

Returns:

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

endpoints

DescribeExperienceResponse.Builder endpoints(Collection<ExperienceEndpoint> endpoints)

Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.

Parameters:

endpoints - Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.

Returns:

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

endpoints

DescribeExperienceResponse.Builder endpoints(ExperienceEndpoint... endpoints)

Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.

Parameters:

endpoints - Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.

Returns:

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

endpoints

DescribeExperienceResponse.Builder endpoints(Consumer<ExperienceEndpoint.Builder>... endpoints)

Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #endpoints(List).

Parameters:

endpoints - a consumer that will call methods on ExperienceEndpoint.Builder

Returns:

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

See Also:

#endpoints(java.util.Collection)

configuration

DescribeExperienceResponse.Builder configuration(ExperienceConfiguration configuration)

Shows the configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.

Parameters:

configuration - Shows the configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.

Returns:

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

configuration

default DescribeExperienceResponse.Builder configuration(Consumer<ExperienceConfiguration.Builder> configuration)

Shows the configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.

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

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

Parameters:

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

Returns:

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

See Also:

configuration(ExperienceConfiguration)

createdAt

DescribeExperienceResponse.Builder createdAt(Instant createdAt)

The Unix timestamp when your Amazon Kendra experience was created.

Parameters:

createdAt - The Unix timestamp when your Amazon Kendra experience was created.

Returns:

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

updatedAt

DescribeExperienceResponse.Builder updatedAt(Instant updatedAt)

The Unix timestamp when your Amazon Kendra experience was last updated.

Parameters:

updatedAt - The Unix timestamp when your Amazon Kendra experience was last updated.

Returns:

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

description

DescribeExperienceResponse.Builder description(String description)

Shows the description for your Amazon Kendra experience.

Parameters:

description - Shows the description for your Amazon Kendra experience.

Returns:

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

status

DescribeExperienceResponse.Builder status(String status)

The current processing status of your Amazon Kendra experience. When the status is ACTIVE, your Amazon Kendra experience is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that this failed.

Parameters:

status - The current processing status of your Amazon Kendra experience. When the status is ACTIVE , your Amazon Kendra experience is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that this failed.

Returns:

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

See Also:

ExperienceStatus, ExperienceStatus

status

DescribeExperienceResponse.Builder status(ExperienceStatus status)

The current processing status of your Amazon Kendra experience. When the status is ACTIVE, your Amazon Kendra experience is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that this failed.

Parameters:

status - The current processing status of your Amazon Kendra experience. When the status is ACTIVE , your Amazon Kendra experience is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that this failed.

Returns:

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

See Also:

ExperienceStatus, ExperienceStatus

roleArn

DescribeExperienceResponse.Builder roleArn(String roleArn)

Shows the Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center that stores your user and group information.

Parameters:

roleArn - Shows the Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center that stores your user and group information.

Returns:

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

errorMessage

DescribeExperienceResponse.Builder errorMessage(String errorMessage)

The reason your Amazon Kendra experience could not properly process.

Parameters:

errorMessage - The reason your Amazon Kendra experience could not properly process.

Returns:

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