software.amazon.awssdk.services.kendraranking.model

Class DescribeRescoreExecutionPlanResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.kendraranking.model.KendraRankingResponse

software.amazon.awssdk.services.kendraranking.model.DescribeRescoreExecutionPlanResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeRescoreExecutionPlanResponse.Builder,DescribeRescoreExecutionPlanResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeRescoreExecutionPlanResponse
extends KendraRankingResponse
implements ToCopyableBuilder<DescribeRescoreExecutionPlanResponse.Builder,DescribeRescoreExecutionPlanResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeRescoreExecutionPlanResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The Amazon Resource Name (ARN) of the rescore execution plan.
static DescribeRescoreExecutionPlanResponse.Builder	builder()
CapacityUnitsConfiguration	capacityUnits() The capacity units set for the rescore execution plan.
Instant	createdAt() The Unix timestamp of when the rescore execution plan was created.
String	description() The description for the rescore execution plan.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	errorMessage() When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The identifier of the rescore execution plan.
String	name() The name for the rescore execution plan.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeRescoreExecutionPlanResponse.Builder>	serializableBuilderClass()
RescoreExecutionPlanStatus	status() The current status of the rescore execution plan.
String	statusAsString() The current status of the rescore execution plan.
DescribeRescoreExecutionPlanResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Instant	updatedAt() The Unix timestamp of when the rescore execution plan was last updated.

Methods inherited from class software.amazon.awssdk.services.kendraranking.model.KendraRankingResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

id

public final String id()

The identifier of the rescore execution plan.

Returns:

The identifier of the rescore execution plan.

arn

public final String arn()

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

Returns:

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

name

public final String name()

The name for the rescore execution plan.

Returns:

The name for the rescore execution plan.

description

public final String description()

The description for the rescore execution plan.

Returns:

The description for the rescore execution plan.

capacityUnits

public final 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.

Returns:

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.

createdAt

public final Instant createdAt()

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

Returns:

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

updatedAt

public final Instant updatedAt()

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

Returns:

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

status

public final 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.

If the service returns an enum value that is not available in the current SDK version, status will return RescoreExecutionPlanStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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.

See Also:

RescoreExecutionPlanStatus

statusAsString

public final String statusAsString()

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.

If the service returns an enum value that is not available in the current SDK version, status will return RescoreExecutionPlanStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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.

See Also:

RescoreExecutionPlanStatus

errorMessage

public final String errorMessage()

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

Returns:

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

toBuilder

public DescribeRescoreExecutionPlanResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeRescoreExecutionPlanResponse.Builder,DescribeRescoreExecutionPlanResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeRescoreExecutionPlanResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeRescoreExecutionPlanResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo