Class OnlineEvaluationConfigSummary

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

The summary information about an online evaluation configuration, including basic metadata and execution status.

See Also:

  • Method Details

    • onlineEvaluationConfigArn

      public final String onlineEvaluationConfigArn()

      The Amazon Resource Name (ARN) of the online evaluation configuration.

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

    • onlineEvaluationConfigId

      public final String onlineEvaluationConfigId()

      The unique identifier of the online evaluation configuration.

      Returns:
      The unique identifier of the online evaluation configuration.

    • onlineEvaluationConfigName

      public final String onlineEvaluationConfigName()

      The name of the online evaluation configuration.

      Returns:
      The name of the online evaluation configuration.

    • description

      public final String description()

      The description of the online evaluation configuration.

      Returns:
      The description of the online evaluation configuration.

    • status

      public final OnlineEvaluationConfigStatus status()

      The status of the online evaluation configuration.

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

      Returns:
      The status of the online evaluation configuration.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the online evaluation configuration.

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

      Returns:
      The status of the online evaluation configuration.
      See Also:

    • executionStatus

      public final OnlineEvaluationExecutionStatus executionStatus()

      The execution status indicating whether the online evaluation is currently running.

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

      Returns:
      The execution status indicating whether the online evaluation is currently running.
      See Also:

    • executionStatusAsString

      public final String executionStatusAsString()

      The execution status indicating whether the online evaluation is currently running.

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

      Returns:
      The execution status indicating whether the online evaluation is currently running.
      See Also:

    • createdAt

      public final Instant createdAt()

      The timestamp when the online evaluation configuration was created.

      Returns:
      The timestamp when the online evaluation configuration was created.

    • updatedAt

      public final Instant updatedAt()

      The timestamp when the online evaluation configuration was last updated.

      Returns:
      The timestamp when the online evaluation configuration was last updated.

    • failureReason

      public final String failureReason()

      The reason for failure if the online evaluation configuration execution failed.

      Returns:
      The reason for failure if the online evaluation configuration execution failed.

    • hasInsights

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

    • insights

      public final List<Insight> insights()

      The list of insight types configured for this 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 hasInsights() method.

      Returns:
      The list of insight types configured for this evaluation.

    • clusteringConfig

      public final ClusteringConfig clusteringConfig()

      The clustering configuration for periodic batch evaluation.

      Returns:
      The clustering configuration for periodic batch evaluation.

    • toBuilder

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

    • builder

      public static OnlineEvaluationConfigSummary.Builder builder()

    • serializableBuilderClass

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