Class DebugRuleConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DebugRuleConfiguration.Builder,
DebugRuleConfiguration>
Configuration information for SageMaker Debugger rules for debugging. To learn more about how to configure the
DebugRuleConfiguration
parameter, see Use the SageMaker and
Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RuleParameters property.final ProcessingInstanceType
The instance type to deploy a custom rule for debugging a training job.final String
The instance type to deploy a custom rule for debugging a training job.final String
Path to local storage location for output of rules.final String
The name of the rule configuration.final String
The Amazon Elastic Container (ECR) Image for the managed rule evaluation.Runtime configuration for rule container.final String
Path to Amazon S3 storage location for rules.static Class
<? extends DebugRuleConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Integer
The size, in GB, of the ML storage volume attached to the processing instance.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
Path to Amazon S3 storage location for rules.
- Returns:
- Path to Amazon S3 storage location for rules.
-
ruleEvaluatorImage
The Amazon Elastic Container (ECR) Image for the managed rule evaluation.
- Returns:
- The Amazon Elastic Container (ECR) Image for the managed rule evaluation.
-
instanceType
The instance type to deploy a custom rule for debugging a training job.
If the service returns an enum value that is not available in the current SDK version,
instanceType
will returnProcessingInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- Returns:
- The instance type to deploy a custom rule for debugging a training job.
- See Also:
-
instanceTypeAsString
The instance type to deploy a custom rule for debugging a training job.
If the service returns an enum value that is not available in the current SDK version,
instanceType
will returnProcessingInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- Returns:
- The instance type to deploy a custom rule for debugging a training job.
- See Also:
-
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<DebugRuleConfiguration.Builder,
DebugRuleConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-