Class TrainedModelSummary

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

Summary information about the trained model.

See Also:

  • Method Details

    • createTime

      public final Instant createTime()

      The time at which the trained model was created.

      Returns:
      The time at which the trained model was created.

    • updateTime

      public final Instant updateTime()

      The most recent time at which the trained model was updated.

      Returns:
      The most recent time at which the trained model was updated.

    • trainedModelArn

      public final String trainedModelArn()

      The Amazon Resource Name (ARN) of the trained model.

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

    • versionIdentifier

      public final String versionIdentifier()

      The version identifier of this trained model version.

      Returns:
      The version identifier of this trained model version.

    • hasIncrementalTrainingDataChannels

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

    • incrementalTrainingDataChannels

      public final List<IncrementalTrainingDataChannelOutput> incrementalTrainingDataChannels()

      Information about the incremental training data channels used to create this version of the trained model.

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

      Returns:
      Information about the incremental training data channels used to create this version of the trained model.

    • name

      public final String name()

      The name of the trained model.

      Returns:
      The name of the trained model.

    • description

      public final String description()

      The description of the trained model.

      Returns:
      The description of the trained model.

    • membershipIdentifier

      public final String membershipIdentifier()

      The membership ID of the member that created the trained model.

      Returns:
      The membership ID of the member that created the trained model.

    • collaborationIdentifier

      public final String collaborationIdentifier()

      The collaboration ID of the collaboration that contains the trained model.

      Returns:
      The collaboration ID of the collaboration that contains the trained model.

    • status

      public final TrainedModelStatus status()

      The status of the trained model.

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

      Returns:
      The status of the trained model.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the trained model.

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

      Returns:
      The status of the trained model.
      See Also:

    • configuredModelAlgorithmAssociationArn

      public final String configuredModelAlgorithmAssociationArn()

      The Amazon Resource Name (ARN) of the configured model algorithm association that was used to create this trained model.

      Returns:
      The Amazon Resource Name (ARN) of the configured model algorithm association that was used to create this trained model.

    • toBuilder

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

    • builder

      public static TrainedModelSummary.Builder builder()

    • serializableBuilderClass

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