Package software.amazon.awssdk.services.sagemaker.model

Class Trial

    • Method Detail

      • trialName

        public final String trialName()

        The name of the trial.

        Returns:
        The name of the trial.

      • trialArn

        public final String trialArn()

        The Amazon Resource Name (ARN) of the trial.

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

      • displayName

        public final String displayName()

        The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.

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

      • experimentName

        public final String experimentName()

        The name of the experiment the trial is part of.

        Returns:
        The name of the experiment the trial is part of.

      • source

        public final TrialSource source()
        Returns the value of the Source property for this object.
        Returns:
        The value of the Source property for this object.

      • creationTime

        public final Instant creationTime()

        When the trial was created.

        Returns:
        When the trial was created.

      • createdBy

        public final UserContext createdBy()

        Who created the trial.

        Returns:
        Who created the trial.

      • lastModifiedTime

        public final Instant lastModifiedTime()

        Who last modified the trial.

        Returns:
        Who last modified the trial.

      • 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.

      • 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.

      • 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 trial. 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 trial. You can use Search API to search on the tags.

      • hasTrialComponentSummaries

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

      • trialComponentSummaries

        public final List<TrialComponentSimpleSummary> trialComponentSummaries()

        A list of the components associated with the trial. For each component, a summary of the component's properties is included.

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

        Returns:
        A list of the components associated with the trial. For each component, a summary of the component's properties is included.

      • serializableBuilderClass

        public static Class<? extends Trial.Builder> serializableBuilderClass()

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

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