Class ProfilerRuleConfiguration

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

Configuration information for profiling rules.

See Also:

  • Method Details

    • ruleConfigurationName

      public final String ruleConfigurationName()

      The name of the rule configuration. It must be unique relative to other rule configuration names.

      Returns:
      The name of the rule configuration. It must be unique relative to other rule configuration names.

    • localPath

      public final String localPath()

      Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.

      Returns:
      Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.

    • s3OutputPath

      public final String s3OutputPath()

      Path to Amazon S3 storage location for rules.

      Returns:
      Path to Amazon S3 storage location for rules.

    • ruleEvaluatorImage

      public final String ruleEvaluatorImage()

      The Amazon Elastic Container Registry Image for the managed rule evaluation.

      Returns:
      The Amazon Elastic Container Registry Image for the managed rule evaluation.

    • instanceType

      public final ProcessingInstanceType instanceType()

      The instance type to deploy a custom rule for profiling a training job.

      If the service returns an enum value that is not available in the current SDK version, instanceType will return ProcessingInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

      Returns:
      The instance type to deploy a custom rule for profiling a training job.
      See Also:

    • instanceTypeAsString

      public final String instanceTypeAsString()

      The instance type to deploy a custom rule for profiling a training job.

      If the service returns an enum value that is not available in the current SDK version, instanceType will return ProcessingInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

      Returns:
      The instance type to deploy a custom rule for profiling a training job.
      See Also:

    • volumeSizeInGB

      public final Integer volumeSizeInGB()

      The size, in GB, of the ML storage volume attached to the processing instance.

      Returns:
      The size, in GB, of the ML storage volume attached to the processing instance.

    • hasRuleParameters

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

    • ruleParameters

      public final Map<String,String> ruleParameters()

      Runtime configuration for rule container.

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

      Returns:
      Runtime configuration for rule container.

    • toBuilder

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

    • builder

      public static ProfilerRuleConfiguration.Builder builder()

    • serializableBuilderClass

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