Package software.amazon.awssdk.services.kendraranking.model

Interface DescribeRescoreExecutionPlanResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeRescoreExecutionPlanResponse.Builder,DescribeRescoreExecutionPlanResponse>, KendraRankingResponse.Builder, SdkBuilder<DescribeRescoreExecutionPlanResponse.Builder,DescribeRescoreExecutionPlanResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeRescoreExecutionPlanResponse

public static interface DescribeRescoreExecutionPlanResponse.Builder
extends KendraRankingResponse.Builder, SdkPojo, CopyableBuilder<DescribeRescoreExecutionPlanResponse.Builder,DescribeRescoreExecutionPlanResponse>

Method Summary

Modifier and Type	Method	Description
DescribeRescoreExecutionPlanResponse.Builder	arn(String arn)	The Amazon Resource Name (ARN) of the rescore execution plan.
default DescribeRescoreExecutionPlanResponse.Builder	capacityUnits(Consumer<CapacityUnitsConfiguration.Builder> capacityUnits)	The capacity units set for the rescore execution plan.
DescribeRescoreExecutionPlanResponse.Builder	capacityUnits(CapacityUnitsConfiguration capacityUnits)	The capacity units set for the rescore execution plan.
DescribeRescoreExecutionPlanResponse.Builder	createdAt(Instant createdAt)	The Unix timestamp of when the rescore execution plan was created.
DescribeRescoreExecutionPlanResponse.Builder	description(String description)	The description for the rescore execution plan.
DescribeRescoreExecutionPlanResponse.Builder	errorMessage(String errorMessage)	When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
DescribeRescoreExecutionPlanResponse.Builder	id(String id)	The identifier of the rescore execution plan.
DescribeRescoreExecutionPlanResponse.Builder	name(String name)	The name for the rescore execution plan.
DescribeRescoreExecutionPlanResponse.Builder	status(String status)	The current status of the rescore execution plan.
DescribeRescoreExecutionPlanResponse.Builder	status(RescoreExecutionPlanStatus status)	The current status of the rescore execution plan.
DescribeRescoreExecutionPlanResponse.Builder	updatedAt(Instant updatedAt)	The Unix timestamp of when the rescore execution plan was last updated.

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

copy

Methods inherited from interface software.amazon.awssdk.services.kendraranking.model.KendraRankingResponse.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

DescribeRescoreExecutionPlanResponse.Builder id(String id)

The identifier of the rescore execution plan.

Parameters:

id - The identifier of the rescore execution plan.

Returns:

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

arn

DescribeRescoreExecutionPlanResponse.Builder arn(String arn)

The Amazon Resource Name (ARN) of the rescore execution plan.

Parameters:

arn - The Amazon Resource Name (ARN) of the rescore execution plan.

Returns:

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

name

DescribeRescoreExecutionPlanResponse.Builder name(String name)

The name for the rescore execution plan.

Parameters:

name - The name for the rescore execution plan.

Returns:

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

description

DescribeRescoreExecutionPlanResponse.Builder description(String description)

The description for the rescore execution plan.

Parameters:

description - The description for the rescore execution plan.

Returns:

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

capacityUnits

DescribeRescoreExecutionPlanResponse.Builder capacityUnits(CapacityUnitsConfiguration capacityUnits)

The capacity units set for the rescore execution plan. A capacity of zero indicates that the rescore execution plan is using the default capacity. For more information on the default capacity and additional capacity units, see Adjusting capacity.

Parameters:

capacityUnits - The capacity units set for the rescore execution plan. A capacity of zero indicates that the rescore execution plan is using the default capacity. For more information on the default capacity and additional capacity units, see Adjusting capacity.

Returns:

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

capacityUnits

default DescribeRescoreExecutionPlanResponse.Builder capacityUnits(Consumer<CapacityUnitsConfiguration.Builder> capacityUnits)

The capacity units set for the rescore execution plan. A capacity of zero indicates that the rescore execution plan is using the default capacity. For more information on the default capacity and additional capacity units, see Adjusting capacity.

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

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

Parameters:

capacityUnits - a consumer that will call methods on CapacityUnitsConfiguration.Builder

Returns:

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

See Also:

capacityUnits(CapacityUnitsConfiguration)

createdAt

DescribeRescoreExecutionPlanResponse.Builder createdAt(Instant createdAt)

The Unix timestamp of when the rescore execution plan was created.

Parameters:

createdAt - The Unix timestamp of when the rescore execution plan was created.

Returns:

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

updatedAt

DescribeRescoreExecutionPlanResponse.Builder updatedAt(Instant updatedAt)

The Unix timestamp of when the rescore execution plan was last updated.

Parameters:

updatedAt - The Unix timestamp of when the rescore execution plan was last updated.

Returns:

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

status

DescribeRescoreExecutionPlanResponse.Builder status(String status)

The current status of the rescore execution plan. When the value is ACTIVE, the rescore execution plan is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

Parameters:

status - The current status of the rescore execution plan. When the value is ACTIVE, the rescore execution plan is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

Returns:

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

See Also:

RescoreExecutionPlanStatus, RescoreExecutionPlanStatus

status

DescribeRescoreExecutionPlanResponse.Builder status(RescoreExecutionPlanStatus status)

The current status of the rescore execution plan. When the value is ACTIVE, the rescore execution plan is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

Parameters:

status - The current status of the rescore execution plan. When the value is ACTIVE, the rescore execution plan is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

Returns:

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

See Also:

RescoreExecutionPlanStatus, RescoreExecutionPlanStatus

errorMessage

DescribeRescoreExecutionPlanResponse.Builder errorMessage(String errorMessage)

When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

Parameters:

errorMessage - When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

Returns:

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