Class BatchEvaluationSummary

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

Summary representation for list responses.

See Also:

  • Method Details

    • batchEvaluationId

      public final String batchEvaluationId()

      The unique identifier of the batch evaluation.

      Returns:
      The unique identifier of the batch evaluation.

    • batchEvaluationArn

      public final String batchEvaluationArn()

      The Amazon Resource Name (ARN) of the batch evaluation.

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

    • batchEvaluationName

      public final String batchEvaluationName()

      The name of the batch evaluation.

      Returns:
      The name of the batch evaluation.

    • status

      public final BatchEvaluationStatus status()

      The current status of the batch evaluation.

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

      Returns:
      The current status of the batch evaluation.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the batch evaluation.

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

      Returns:
      The current status of the batch evaluation.
      See Also:

    • createdAt

      public final Instant createdAt()

      The timestamp when the batch evaluation was created.

      Returns:
      The timestamp when the batch evaluation was created.

    • description

      public final String description()

      The description of the batch evaluation.

      Returns:
      The description of the batch evaluation.

    • hasEvaluators

      public final boolean hasEvaluators()
      For responses, this returns true if the service returned a value for the Evaluators property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • evaluators

      public final List<Evaluator> evaluators()

      The list of evaluators applied during the batch evaluation.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEvaluators() method.

      Returns:
      The list of evaluators applied during the batch evaluation.

    • evaluationResults

      public final EvaluationJobResults evaluationResults()

      The aggregated evaluation results.

      Returns:
      The aggregated evaluation results.

    • hasErrorDetails

      public final boolean hasErrorDetails()
      For responses, this returns true if the service returned a value for the ErrorDetails property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • errorDetails

      public final List<String> errorDetails()

      The error details if the batch evaluation encountered failures.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasErrorDetails() method.

      Returns:
      The error details if the batch evaluation encountered failures.

    • updatedAt

      public final Instant updatedAt()

      The timestamp when the batch evaluation was last updated.

      Returns:
      The timestamp when the batch evaluation was last updated.

    • toBuilder

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

    • builder

      public static BatchEvaluationSummary.Builder builder()

    • serializableBuilderClass

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