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

Class RescoreExecutionPlanSummary

java.lang.Object

software.amazon.awssdk.services.kendraranking.model.RescoreExecutionPlanSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RescoreExecutionPlanSummary.Builder,RescoreExecutionPlanSummary>

@Generated("software.amazon.awssdk:codegen")
public final class RescoreExecutionPlanSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RescoreExecutionPlanSummary.Builder,RescoreExecutionPlanSummary>

Summary information for a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RescoreExecutionPlanSummary.Builder

Method Summary

Modifier and Type	Method	Description
static RescoreExecutionPlanSummary.Builder	builder()
Instant	createdAt()	The Unix timestamp when the rescore execution plan was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The identifier of the rescore execution plan.
String	name()	The name of the rescore execution plan.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RescoreExecutionPlanSummary.Builder>	serializableBuilderClass()
RescoreExecutionPlanStatus	status()	The current status of the rescore execution plan.
String	statusAsString()	The current status of the rescore execution plan.
RescoreExecutionPlanSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Instant	updatedAt()	The Unix timestamp when the rescore execution plan was last updated.

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

name

public final String name()

The name of the rescore execution plan.

Returns:

The name of the rescore execution plan.

id

public final String id()

The identifier of the rescore execution plan.

Returns:

The identifier of the rescore execution plan.

createdAt

public final Instant createdAt()

The Unix timestamp when the rescore execution plan was created.

Returns:

The Unix timestamp when the rescore execution plan was created.

updatedAt

public final Instant updatedAt()

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

Returns:

The Unix timestamp 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 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.

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

See Also:

RescoreExecutionPlanStatus

toBuilder

public RescoreExecutionPlanSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RescoreExecutionPlanSummary.Builder,RescoreExecutionPlanSummary>

builder

public static RescoreExecutionPlanSummary.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo