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

Class DescribeTrialComponentResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.sagemaker.model.SageMakerResponse
software.amazon.awssdk.services.sagemaker.model.DescribeTrialComponentResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeTrialComponentResponse.Builder,DescribeTrialComponentResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeTrialComponentResponse extends SageMakerResponse implements ToCopyableBuilder<DescribeTrialComponentResponse.Builder,DescribeTrialComponentResponse>

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

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

    • toBuilder

      public DescribeTrialComponentResponse.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<DescribeTrialComponentResponse.Builder,DescribeTrialComponentResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeTrialComponentResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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