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("software.amazon.awssdk:codegen") public final class DescribeRescoreExecutionPlanResponse extends KendraRankingResponse implements ToCopyableBuilder<DescribeRescoreExecutionPlanResponse.Builder,DescribeRescoreExecutionPlanResponse>

  • Method Details

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeRescoreExecutionPlanResponse.Builder,DescribeRescoreExecutionPlanResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.