DebugRuleConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.sagemaker.model.DebugRuleConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DebugRuleConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DebugRuleConfiguration()

Constructors
Constructor and Description
`DebugRuleConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DebugRuleConfiguration`	`addRuleParametersEntry(String key, String value)` Add a single RuleParameters entry
`DebugRuleConfiguration`	`clearRuleParametersEntries()` Removes all the entries added into RuleParameters.
`DebugRuleConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getInstanceType()` The instance type to deploy a custom rule for debugging a training job.
`String`	`getLocalPath()` Path to local storage location for output of rules.
`String`	`getRuleConfigurationName()` The name of the rule configuration.
`String`	`getRuleEvaluatorImage()` The Amazon Elastic Container (ECR) Image for the managed rule evaluation.
`Map<String,String>`	`getRuleParameters()` Runtime configuration for rule container.
`String`	`getS3OutputPath()` Path to Amazon S3 storage location for rules.
`Integer`	`getVolumeSizeInGB()` The size, in GB, of the ML storage volume attached to the processing instance.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setInstanceType(String instanceType)` The instance type to deploy a custom rule for debugging a training job.
`void`	`setLocalPath(String localPath)` Path to local storage location for output of rules.
`void`	`setRuleConfigurationName(String ruleConfigurationName)` The name of the rule configuration.
`void`	`setRuleEvaluatorImage(String ruleEvaluatorImage)` The Amazon Elastic Container (ECR) Image for the managed rule evaluation.
`void`	`setRuleParameters(Map<String,String> ruleParameters)` Runtime configuration for rule container.
`void`	`setS3OutputPath(String s3OutputPath)` Path to Amazon S3 storage location for rules.
`void`	`setVolumeSizeInGB(Integer volumeSizeInGB)` The size, in GB, of the ML storage volume attached to the processing instance.
`String`	`toString()` Returns a string representation of this object.
`DebugRuleConfiguration`	`withInstanceType(ProcessingInstanceType instanceType)` The instance type to deploy a custom rule for debugging a training job.
`DebugRuleConfiguration`	`withInstanceType(String instanceType)` The instance type to deploy a custom rule for debugging a training job.
`DebugRuleConfiguration`	`withLocalPath(String localPath)` Path to local storage location for output of rules.
`DebugRuleConfiguration`	`withRuleConfigurationName(String ruleConfigurationName)` The name of the rule configuration.
`DebugRuleConfiguration`	`withRuleEvaluatorImage(String ruleEvaluatorImage)` The Amazon Elastic Container (ECR) Image for the managed rule evaluation.
`DebugRuleConfiguration`	`withRuleParameters(Map<String,String> ruleParameters)` Runtime configuration for rule container.
`DebugRuleConfiguration`	`withS3OutputPath(String s3OutputPath)` Path to Amazon S3 storage location for rules.
`DebugRuleConfiguration`	`withVolumeSizeInGB(Integer volumeSizeInGB)` The size, in GB, of the ML storage volume attached to the processing instance.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DebugRuleConfiguration
```
public DebugRuleConfiguration()
```
- Method Detail
  - setRuleConfigurationName
```
public void setRuleConfigurationName(String ruleConfigurationName)
```
    The name of the rule configuration. It must be unique relative to other rule configuration names.
    
    Parameters:
    
    ruleConfigurationName - The name of the rule configuration. It must be unique relative to other rule configuration names.
  - getRuleConfigurationName
```
public String getRuleConfigurationName()
```
    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.
  - withRuleConfigurationName
```
public DebugRuleConfiguration withRuleConfigurationName(String ruleConfigurationName)
```
    The name of the rule configuration. It must be unique relative to other rule configuration names.
    
    Parameters:
    
    ruleConfigurationName - The name of the rule configuration. It must be unique relative to other rule configuration names.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLocalPath
```
public void setLocalPath(String localPath)
```
    Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.
    
    Parameters:
    
    localPath - Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.
  - getLocalPath
```
public String getLocalPath()
```
    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/.
  - withLocalPath
```
public DebugRuleConfiguration withLocalPath(String localPath)
```
    Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.
    
    Parameters:
    
    localPath - Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setS3OutputPath
```
public void setS3OutputPath(String s3OutputPath)
```
    Path to Amazon S3 storage location for rules.
    
    Parameters:
    
    s3OutputPath - Path to Amazon S3 storage location for rules.
  - getS3OutputPath
```
public String getS3OutputPath()
```
    Path to Amazon S3 storage location for rules.
    
    Returns:
    
    Path to Amazon S3 storage location for rules.
  - withS3OutputPath
```
public DebugRuleConfiguration withS3OutputPath(String s3OutputPath)
```
    Path to Amazon S3 storage location for rules.
    
    Parameters:
    
    s3OutputPath - Path to Amazon S3 storage location for rules.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRuleEvaluatorImage
```
public void setRuleEvaluatorImage(String ruleEvaluatorImage)
```
    The Amazon Elastic Container (ECR) Image for the managed rule evaluation.
    
    Parameters:
    
    ruleEvaluatorImage - The Amazon Elastic Container (ECR) Image for the managed rule evaluation.
  - getRuleEvaluatorImage
```
public String getRuleEvaluatorImage()
```
    The Amazon Elastic Container (ECR) Image for the managed rule evaluation.
    
    Returns:
    
    The Amazon Elastic Container (ECR) Image for the managed rule evaluation.
  - withRuleEvaluatorImage
```
public DebugRuleConfiguration withRuleEvaluatorImage(String ruleEvaluatorImage)
```
    The Amazon Elastic Container (ECR) Image for the managed rule evaluation.
    
    Parameters:
    
    ruleEvaluatorImage - The Amazon Elastic Container (ECR) Image for the managed rule evaluation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceType
```
public void setInstanceType(String instanceType)
```
    The instance type to deploy a custom rule for debugging a training job.
    
    Parameters:
    
    instanceType - The instance type to deploy a custom rule for debugging a training job.
    
    See Also:
    
    ProcessingInstanceType
  - getInstanceType
```
public String getInstanceType()
```
    The instance type to deploy a custom rule for debugging a training job.
    
    Returns:
    
    The instance type to deploy a custom rule for debugging a training job.
    
    See Also:
    
    ProcessingInstanceType
  - withInstanceType
```
public DebugRuleConfiguration withInstanceType(String instanceType)
```
    The instance type to deploy a custom rule for debugging a training job.
    
    Parameters:
    
    instanceType - The instance type to deploy a custom rule for debugging a training job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProcessingInstanceType
  - withInstanceType
```
public DebugRuleConfiguration withInstanceType(ProcessingInstanceType instanceType)
```
    The instance type to deploy a custom rule for debugging a training job.
    
    Parameters:
    
    instanceType - The instance type to deploy a custom rule for debugging a training job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProcessingInstanceType
  - setVolumeSizeInGB
```
public void setVolumeSizeInGB(Integer volumeSizeInGB)
```
    The size, in GB, of the ML storage volume attached to the processing instance.
    
    Parameters:
    
    volumeSizeInGB - The size, in GB, of the ML storage volume attached to the processing instance.
  - getVolumeSizeInGB
```
public Integer getVolumeSizeInGB()
```
    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.
  - withVolumeSizeInGB
```
public DebugRuleConfiguration withVolumeSizeInGB(Integer volumeSizeInGB)
```
    The size, in GB, of the ML storage volume attached to the processing instance.
    
    Parameters:
    
    volumeSizeInGB - The size, in GB, of the ML storage volume attached to the processing instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRuleParameters
```
public Map<String,String> getRuleParameters()
```
    Runtime configuration for rule container.
    
    Returns:
    
    Runtime configuration for rule container.
  - setRuleParameters
```
public void setRuleParameters(Map<String,String> ruleParameters)
```
    Runtime configuration for rule container.
    
    Parameters:
    
    ruleParameters - Runtime configuration for rule container.
  - withRuleParameters
```
public DebugRuleConfiguration withRuleParameters(Map<String,String> ruleParameters)
```
    Runtime configuration for rule container.
    
    Parameters:
    
    ruleParameters - Runtime configuration for rule container.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addRuleParametersEntry
```
public DebugRuleConfiguration addRuleParametersEntry(String key,
                                                     String value)
```
    Add a single RuleParameters entry
    
    See Also:
    
    withRuleParameters(java.util.Map<java.lang.String, java.lang.String>)
  - clearRuleParametersEntries
```
public DebugRuleConfiguration clearRuleParametersEntries()
```
    Removes all the entries added into RuleParameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DebugRuleConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class DebugRuleConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DebugRuleConfiguration

Method Detail

setRuleConfigurationName

getRuleConfigurationName

withRuleConfigurationName

setLocalPath

getLocalPath

withLocalPath

setS3OutputPath

getS3OutputPath

withS3OutputPath

setRuleEvaluatorImage

getRuleEvaluatorImage

withRuleEvaluatorImage

setInstanceType

getInstanceType

withInstanceType

withInstanceType

setVolumeSizeInGB

getVolumeSizeInGB

withVolumeSizeInGB

getRuleParameters

setRuleParameters

withRuleParameters

addRuleParametersEntry

clearRuleParametersEntries

toString

equals

hashCode

clone

marshall