Class ExperimentConfig

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

Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:

See Also:

  • Method Details

    • experimentName

      public final String experimentName()

      The name of an existing experiment to associate with the trial component.

      Returns:
      The name of an existing experiment to associate with the trial component.

    • trialName

      public final String trialName()

      The name of an existing trial to associate the trial component with. If not specified, a new trial is created.

      Returns:
      The name of an existing trial to associate the trial component with. If not specified, a new trial is created.

    • trialComponentDisplayName

      public final String trialComponentDisplayName()

      The display name for the trial component. If this key isn't specified, the display name is the trial component name.

      Returns:
      The display name for the trial component. If this key isn't specified, the display name is the trial component name.

    • runName

      public final String runName()

      The name of the experiment run to associate with the trial component.

      Returns:
      The name of the experiment run to associate with the trial component.

    • toBuilder

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

    • builder

      public static ExperimentConfig.Builder builder()

    • serializableBuilderClass

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