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

Class DescribeTrialComponentResponse

    • Method Detail

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

      • source

        public final TrialComponentSource source()

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

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

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

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

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

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

      • lineageGroupArn

        public final String lineageGroupArn()

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

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

      • hasSources

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

      • sources

        public final List<TrialComponentSource> sources()

        A list of ARNs and, if applicable, job types for multiple sources of an experiment run.

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

        Returns:
        A list of ARNs and, if applicable, job types for multiple sources of an experiment run.

      • 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