Class EvaluatorSummary

java.lang.Object
software.amazon.awssdk.services.bedrockagentcorecontrol.model.EvaluatorSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EvaluatorSummary.Builder,EvaluatorSummary>
@Generated("software.amazon.awssdk:codegen") public final class EvaluatorSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EvaluatorSummary.Builder,EvaluatorSummary>

The summary information about an evaluator, including basic metadata and status information.

See Also:

  • Method Details

    • evaluatorArn

      public final String evaluatorArn()

      The Amazon Resource Name (ARN) of the evaluator.

      Returns:
      The Amazon Resource Name (ARN) of the evaluator.

    • evaluatorId

      public final String evaluatorId()

      The unique identifier of the evaluator.

      Returns:
      The unique identifier of the evaluator.

    • evaluatorName

      public final String evaluatorName()

      The name of the evaluator.

      Returns:
      The name of the evaluator.

    • description

      public final String description()

      The description of the evaluator.

      Returns:
      The description of the evaluator.

    • evaluatorType

      public final EvaluatorType evaluatorType()

      The type of evaluator, indicating whether it is a built-in evaluator provided by the service or a custom evaluator created by the user.

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

      Returns:
      The type of evaluator, indicating whether it is a built-in evaluator provided by the service or a custom evaluator created by the user.
      See Also:

    • evaluatorTypeAsString

      public final String evaluatorTypeAsString()

      The type of evaluator, indicating whether it is a built-in evaluator provided by the service or a custom evaluator created by the user.

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

      Returns:
      The type of evaluator, indicating whether it is a built-in evaluator provided by the service or a custom evaluator created by the user.
      See Also:

    • level

      public final EvaluatorLevel level()

      The evaluation level (TOOL_CALL, TRACE, or SESSION) that determines the scope of evaluation.

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

      Returns:
      The evaluation level (TOOL_CALL, TRACE, or SESSION) that determines the scope of evaluation.
      See Also:

    • levelAsString

      public final String levelAsString()

      The evaluation level (TOOL_CALL, TRACE, or SESSION) that determines the scope of evaluation.

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

      Returns:
      The evaluation level (TOOL_CALL, TRACE, or SESSION) that determines the scope of evaluation.
      See Also:

    • status

      public final EvaluatorStatus status()

      The current status of the evaluator.

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

      Returns:
      The current status of the evaluator.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the evaluator.

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

      Returns:
      The current status of the evaluator.
      See Also:

    • createdAt

      public final Instant createdAt()

      The timestamp when the evaluator was created.

      Returns:
      The timestamp when the evaluator was created.

    • updatedAt

      public final Instant updatedAt()

      The timestamp when the evaluator was last updated.

      Returns:
      The timestamp when the evaluator was last updated.

    • lockedForModification

      public final Boolean lockedForModification()

      Whether the evaluator is locked for modification due to being referenced by active online evaluation configurations.

      Returns:
      Whether the evaluator is locked for modification due to being referenced by active online evaluation configurations.

    • toBuilder

      public EvaluatorSummary.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<EvaluatorSummary.Builder,EvaluatorSummary>
      Returns:
      a builder for type T

    • builder

      public static EvaluatorSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EvaluatorSummary.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)
      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)

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