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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceEvaluationSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static EvaluationSummary.Builderbuilder()InstantcreationTime()When the model evaluation job was created.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<EvaluationTaskType>evaluationTaskTypes()What task type was used in the model evaluation job.List<String>evaluationTaskTypesAsStrings()What task type was used in the model evaluation job.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasEvaluationTaskTypes()For responses, this returns true if the service returned a value for the EvaluationTaskTypes property.inthashCode()booleanhasModelIdentifiers()For responses, this returns true if the service returned a value for the ModelIdentifiers property.StringjobArn()The Amazon Resource Name (ARN) of the model evaluation job.StringjobName()The name of the model evaluation job.EvaluationJobTypejobType()The type, either human or automatic, of model evaluation job.StringjobTypeAsString()The type, either human or automatic, of model evaluation job.List<String>modelIdentifiers()The Amazon Resource Names (ARNs) of the model(s) used in the model evaluation job.List<SdkField<?>>sdkFields()static Class<? extends EvaluationSummary.Builder>serializableBuilderClass()EvaluationJobStatusstatus()The current status of the model evaluation job.StringstatusAsString()The current status of the model evaluation job.EvaluationSummary.BuildertoBuilder()StringtoString()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 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,
statuswill returnEvaluationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The current status of the model evaluation job.
- See Also:
EvaluationJobStatus
-
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,
statuswill returnEvaluationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The current status of the model evaluation job.
- See Also:
EvaluationJobStatus
-
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,
jobTypewill returnEvaluationJobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromjobTypeAsString().- Returns:
- The type, either human or automatic, of model evaluation job.
- See Also:
EvaluationJobType
-
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,
jobTypewill returnEvaluationJobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromjobTypeAsString().- Returns:
- The type, either human or automatic, of model evaluation job.
- See Also:
EvaluationJobType
-
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 theisEmpty()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 theisEmpty()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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<EvaluationSummary.Builder,EvaluationSummary>
-
builder
public static EvaluationSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends EvaluationSummary.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-