Class TrialComponent

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

The properties of a trial component as returned by the Search API.

See Also:

  • Method Details

    • trialComponentName

      public final String trialComponentName()

      The name of the trial component.

      Returns:
      The name of the trial component.

    • displayName

      public final String displayName()

      The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.

      Returns:
      The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.

    • trialComponentArn

      public final String trialComponentArn()

      The Amazon Resource Name (ARN) of the trial component.

      Returns:
      The Amazon Resource Name (ARN) of the trial component.

    • source

      public final TrialComponentSource source()

      The Amazon Resource Name (ARN) and job type of the source of the component.

      Returns:
      The Amazon Resource Name (ARN) and job type of the source of the component.

    • status

      public final TrialComponentStatus status()
      Returns the value of the Status property for this object.
      Returns:
      The value of the Status property for this object.

    • startTime

      public final Instant startTime()

      When the component started.

      Returns:
      When the component started.

    • endTime

      public final Instant endTime()

      When the component ended.

      Returns:
      When the component ended.

    • creationTime

      public final Instant creationTime()

      When the component was created.

      Returns:
      When the component was created.

    • createdBy

      public final UserContext createdBy()

      Who created the trial component.

      Returns:
      Who created the trial component.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      When the component was last modified.

      Returns:
      When the component was last modified.

    • lastModifiedBy

      public final UserContext lastModifiedBy()
      Returns the value of the LastModifiedBy property for this object.
      Returns:
      The value of the LastModifiedBy property for this object.

    • hasParameters

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

    • parameters

      public final Map<String,TrialComponentParameterValue> parameters()

      The hyperparameters of the component.

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

      Returns:
      The hyperparameters of the component.

    • hasInputArtifacts

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

    • inputArtifacts

      public final Map<String,TrialComponentArtifact> inputArtifacts()

      The input artifacts of the component.

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

      Returns:
      The input artifacts of the component.

    • hasOutputArtifacts

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

    • outputArtifacts

      public final Map<String,TrialComponentArtifact> outputArtifacts()

      The output artifacts of the component.

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

      Returns:
      The output artifacts of the component.

    • hasMetrics

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

    • metrics

      public final List<TrialComponentMetricSummary> metrics()

      The metrics for the component.

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

      Returns:
      The metrics for the component.

    • metadataProperties

      public final MetadataProperties metadataProperties()
      Returns the value of the MetadataProperties property for this object.
      Returns:
      The value of the MetadataProperties property for this object.

    • sourceDetail

      public final TrialComponentSourceDetail sourceDetail()

      Details of the source of the component.

      Returns:
      Details of the source of the component.

    • lineageGroupArn

      public final String lineageGroupArn()

      The Amazon Resource Name (ARN) of the lineage group resource.

      Returns:
      The Amazon Resource Name (ARN) of the lineage group resource.

    • hasTags

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

    • tags

      public final List<Tag> tags()

      The list of tags that are associated with the component. You can use Search API to search on the tags.

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

      Returns:
      The list of tags that are associated with the component. You can use Search API to search on the tags.

    • hasParents

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

    • parents

      public final List<Parent> parents()

      An array of the parents of the component. A parent is a trial the component is associated with and the experiment the trial is part of. A component might not have any parents.

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

      Returns:
      An array of the parents of the component. A parent is a trial the component is associated with and the experiment the trial is part of. A component might not have any parents.

    • runName

      public final String runName()

      The name of the experiment run.

      Returns:
      The name of the experiment run.

    • toBuilder

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

    • builder

      public static TrialComponent.Builder builder()

    • serializableBuilderClass

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