Class EvaluationSummary

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

A summary of the model evaluation job.

See Also:

  • Method Details

    • jobArn

      public final String jobArn()

      The Amazon Resource Name (ARN) of the model evaluation job.

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

    • jobName

      public final String jobName()

      The name of the model evaluation job.

      Returns:
      The name of the model evaluation job.

    • status

      public final EvaluationJobStatus status()

      The current status of the model evaluation job.

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

      Returns:
      The current status of the model evaluation job.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the model evaluation job.

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

      Returns:
      The current status of the model evaluation job.
      See Also:

    • creationTime

      public final Instant creationTime()

      When the model evaluation job was created.

      Returns:
      When the model evaluation job was created.

    • jobType

      public final EvaluationJobType jobType()

      The type, either human or automatic, of model evaluation job.

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

      Returns:
      The type, either human or automatic, of model evaluation job.
      See Also:

    • jobTypeAsString

      public final String jobTypeAsString()

      The type, either human or automatic, of model evaluation job.

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

      Returns:
      The type, either human or automatic, of model evaluation job.
      See Also:

    • evaluationTaskTypes

      public final List<EvaluationTaskType> evaluationTaskTypes()

      What task type was used in the model evaluation job.

      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 hasEvaluationTaskTypes() method.

      Returns:
      What task type was used in the model evaluation job.

    • hasEvaluationTaskTypes

      public final boolean hasEvaluationTaskTypes()
      For responses, this returns true if the service returned a value for the EvaluationTaskTypes 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.

    • evaluationTaskTypesAsStrings

      public final List<String> evaluationTaskTypesAsStrings()

      What task type was used in the model evaluation job.

      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 hasEvaluationTaskTypes() method.

      Returns:
      What task type was used in the model evaluation job.

    • hasModelIdentifiers

      public final boolean hasModelIdentifiers()
      For responses, this returns true if the service returned a value for the ModelIdentifiers 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.

    • modelIdentifiers

      public final List<String> modelIdentifiers()

      The Amazon Resource Names (ARNs) of the model(s) used in the model evaluation job.

      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 hasModelIdentifiers() method.

      Returns:
      The Amazon Resource Names (ARNs) of the model(s) used in the model evaluation job.

    • toBuilder

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

    • builder

      public static EvaluationSummary.Builder builder()

    • serializableBuilderClass

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