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>

Summary information of an evaluation job.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface EvaluationSummary.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ApplicationType`	`applicationType()`	Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
`String`	`applicationTypeAsString()`	Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
`static EvaluationSummary.Builder`	`builder()`
`Instant`	`creationTime()`	The time the evaluation job was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<EvaluationTaskType>`	`evaluationTaskTypes()`	The type of task for model evaluation.
`List<String>`	`evaluationTaskTypesAsStrings()`	The type of task for model evaluation.
`List<String>`	`evaluatorModelIdentifiers()`	The Amazon Resource Names (ARNs) of the models used to compute the metrics for a knowledge base evaluation job.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasEvaluationTaskTypes()`	For responses, this returns true if the service returned a value for the EvaluationTaskTypes property.
`boolean`	`hasEvaluatorModelIdentifiers()`	For responses, this returns true if the service returned a value for the EvaluatorModelIdentifiers property.
`int`	`hashCode()`
`boolean`	`hasModelIdentifiers()`	For responses, this returns true if the service returned a value for the ModelIdentifiers property.
`boolean`	`hasRagIdentifiers()`	For responses, this returns true if the service returned a value for the RagIdentifiers property.
`String`	`jobArn()`	The Amazon Resource Name (ARN) of the evaluation job.
`String`	`jobName()`	The name for the evaluation job.
`EvaluationJobType`	`jobType()`	Specifies whether the evaluation job is automated or human-based.
`String`	`jobTypeAsString()`	Specifies whether the evaluation job is automated or human-based.
`List<String>`	`modelIdentifiers()`	The Amazon Resource Names (ARNs) of the model(s) used for the evaluation job.
`List<String>`	`ragIdentifiers()`	The Amazon Resource Names (ARNs) of the knowledge base resources used for a knowledge base evaluation job.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends EvaluationSummary.Builder>`	`serializableBuilderClass()`
`EvaluationJobStatus`	`status()`	The current status of the evaluation job.
`String`	`statusAsString()`	The current status of the evaluation job.
`EvaluationSummary.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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
  - jobArn
```
public final String jobArn()
```
    The Amazon Resource Name (ARN) of the evaluation job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the evaluation job.
  - jobName
```
public final String jobName()
```
    The name for the evaluation job.
    
    Returns:
    
    The name for the evaluation job.
  - status
```
public final EvaluationJobStatus status()
```
    The current status of the 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 evaluation job.
    
    See Also:
    
    EvaluationJobStatus
  - statusAsString
```
public final String statusAsString()
```
    The current status of the 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 evaluation job.
    
    See Also:
    
    EvaluationJobStatus
  - creationTime
```
public final Instant creationTime()
```
    The time the evaluation job was created.
    
    Returns:
    
    The time the evaluation job was created.
  - jobType
```
public final EvaluationJobType jobType()
```
    Specifies whether the evaluation job is automated or human-based.
    
    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:
    
    Specifies whether the evaluation job is automated or human-based.
    
    See Also:
    
    EvaluationJobType
  - jobTypeAsString
```
public final String jobTypeAsString()
```
    Specifies whether the evaluation job is automated or human-based.
    
    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:
    
    Specifies whether the evaluation job is automated or human-based.
    
    See Also:
    
    EvaluationJobType
  - evaluationTaskTypes
```
public final List<EvaluationTaskType> evaluationTaskTypes()
```
    The type of task for model 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 hasEvaluationTaskTypes() method.
    
    Returns:
    
    The type of task for model evaluation.
  - 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()
```
    The type of task for model 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 hasEvaluationTaskTypes() method.
    
    Returns:
    
    The type of task for model evaluation.
  - 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 for the 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 for the evaluation job.
  - hasRagIdentifiers
```
public final boolean hasRagIdentifiers()
```
    For responses, this returns true if the service returned a value for the RagIdentifiers 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.
  - ragIdentifiers
```
public final List<String> ragIdentifiers()
```
    The Amazon Resource Names (ARNs) of the knowledge base resources used for a knowledge base 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 hasRagIdentifiers() method.
    
    Returns:
    
    The Amazon Resource Names (ARNs) of the knowledge base resources used for a knowledge base evaluation job.
  - hasEvaluatorModelIdentifiers
```
public final boolean hasEvaluatorModelIdentifiers()
```
    For responses, this returns true if the service returned a value for the EvaluatorModelIdentifiers 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.
  - evaluatorModelIdentifiers
```
public final List<String> evaluatorModelIdentifiers()
```
    The Amazon Resource Names (ARNs) of the models used to compute the metrics for a knowledge base 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 hasEvaluatorModelIdentifiers() method.
    
    Returns:
    
    The Amazon Resource Names (ARNs) of the models used to compute the metrics for a knowledge base evaluation job.
  - applicationType
```
public final ApplicationType applicationType()
```
    Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
    
    If the service returns an enum value that is not available in the current SDK version, applicationType will return ApplicationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from applicationTypeAsString().
    
    Returns:
    
    Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
    
    See Also:
    
    ApplicationType
  - applicationTypeAsString
```
public final String applicationTypeAsString()
```
    Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
    
    If the service returns an enum value that is not available in the current SDK version, applicationType will return ApplicationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from applicationTypeAsString().
    
    Returns:
    
    Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
    
    See Also:
    
    ApplicationType
  - toBuilder
```
public EvaluationSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<EvaluationSummary.Builder,EvaluationSummary>
  - 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)
```
    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

Class EvaluationSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

jobArn

jobName

status

statusAsString

creationTime

jobType

jobTypeAsString

evaluationTaskTypes

hasEvaluationTaskTypes

evaluationTaskTypesAsStrings

hasModelIdentifiers

modelIdentifiers

hasRagIdentifiers

ragIdentifiers

hasEvaluatorModelIdentifiers

evaluatorModelIdentifiers

applicationType

applicationTypeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField