Class TrialComponentSummary

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

A summary of the properties of a trial component. To get all the properties, call the DescribeTrialComponent API and provide the TrialComponentName.

See Also:

  • Method Details

    • trialComponentName

      public final String trialComponentName()

      The name of the trial component.

      Returns:
      The name of the trial component.

    • trialComponentArn

      public final String trialComponentArn()

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

      Returns:
      The Amazon Resource Name (ARN) 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.

    • trialComponentSource

      public final TrialComponentSource trialComponentSource()
      Returns the value of the TrialComponentSource property for this object.
      Returns:
      The value of the TrialComponentSource property for this object.

    • status

      public final TrialComponentStatus status()

      The status of the component. States include:

      • InProgress

      • Completed

      • Failed

      Returns:
      The status of the component. States include:

      • InProgress

      • Completed

      • Failed

    • 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()

      Who last modified the component.

      Returns:
      Who last modified the component.

    • toBuilder

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

    • builder

      public static TrialComponentSummary.Builder builder()

    • serializableBuilderClass

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