ProfilerConfig (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ProfilerConfig
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ProfilerConfig()

Constructors
Constructor and Description
`ProfilerConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProfilerConfig`	`addProfilingParametersEntry(String key, String value)` Add a single ProfilingParameters entry
`ProfilerConfig`	`clearProfilingParametersEntries()` Removes all the entries added into ProfilingParameters.
`ProfilerConfig`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getDisableProfiler()` Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality.
`Long`	`getProfilingIntervalInMilliseconds()` A time interval for capturing system metrics in milliseconds.
`Map<String,String>`	`getProfilingParameters()` Configuration information for capturing framework metrics.
`String`	`getS3OutputPath()` Path to Amazon S3 storage location for system and framework metrics.
`int`	`hashCode()`
`Boolean`	`isDisableProfiler()` Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDisableProfiler(Boolean disableProfiler)` Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality.
`void`	`setProfilingIntervalInMilliseconds(Long profilingIntervalInMilliseconds)` A time interval for capturing system metrics in milliseconds.
`void`	`setProfilingParameters(Map<String,String> profilingParameters)` Configuration information for capturing framework metrics.
`void`	`setS3OutputPath(String s3OutputPath)` Path to Amazon S3 storage location for system and framework metrics.
`String`	`toString()` Returns a string representation of this object.
`ProfilerConfig`	`withDisableProfiler(Boolean disableProfiler)` Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality.
`ProfilerConfig`	`withProfilingIntervalInMilliseconds(Long profilingIntervalInMilliseconds)` A time interval for capturing system metrics in milliseconds.
`ProfilerConfig`	`withProfilingParameters(Map<String,String> profilingParameters)` Configuration information for capturing framework metrics.
`ProfilerConfig`	`withS3OutputPath(String s3OutputPath)` Path to Amazon S3 storage location for system and framework metrics.

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

- Constructor Detail
  - ProfilerConfig
```
public ProfilerConfig()
```
- Method Detail
  - setS3OutputPath
```
public void setS3OutputPath(String s3OutputPath)
```
    Path to Amazon S3 storage location for system and framework metrics.
    
    Parameters:
    
    s3OutputPath - Path to Amazon S3 storage location for system and framework metrics.
  - getS3OutputPath
```
public String getS3OutputPath()
```
    Path to Amazon S3 storage location for system and framework metrics.
    
    Returns:
    
    Path to Amazon S3 storage location for system and framework metrics.
  - withS3OutputPath
```
public ProfilerConfig withS3OutputPath(String s3OutputPath)
```
    Path to Amazon S3 storage location for system and framework metrics.
    
    Parameters:
    
    s3OutputPath - Path to Amazon S3 storage location for system and framework metrics.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProfilingIntervalInMilliseconds
```
public void setProfilingIntervalInMilliseconds(Long profilingIntervalInMilliseconds)
```
    A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.
    
    Parameters:
    
    profilingIntervalInMilliseconds - A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.
  - getProfilingIntervalInMilliseconds
```
public Long getProfilingIntervalInMilliseconds()
```
    A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.
    
    Returns:
    
    A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.
  - withProfilingIntervalInMilliseconds
```
public ProfilerConfig withProfilingIntervalInMilliseconds(Long profilingIntervalInMilliseconds)
```
    A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.
    
    Parameters:
    
    profilingIntervalInMilliseconds - A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getProfilingParameters
```
public Map<String,String> getProfilingParameters()
```
    Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
    
    Returns:
    
    Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
  - setProfilingParameters
```
public void setProfilingParameters(Map<String,String> profilingParameters)
```
    Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
    
    Parameters:
    
    profilingParameters - Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
  - withProfilingParameters
```
public ProfilerConfig withProfilingParameters(Map<String,String> profilingParameters)
```
    Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
    
    Parameters:
    
    profilingParameters - Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addProfilingParametersEntry
```
public ProfilerConfig addProfilingParametersEntry(String key,
                                                  String value)
```
    Add a single ProfilingParameters entry
    
    See Also:
    
    withProfilingParameters(java.util.Map<java.lang.String, java.lang.String>)
  - clearProfilingParametersEntries
```
public ProfilerConfig clearProfilingParametersEntries()
```
    Removes all the entries added into ProfilingParameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDisableProfiler
```
public void setDisableProfiler(Boolean disableProfiler)
```
    Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to True.
    
    Parameters:
    
    disableProfiler - Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to True.
  - getDisableProfiler
```
public Boolean getDisableProfiler()
```
    Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to True.
    
    Returns:
    
    Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to True.
  - withDisableProfiler
```
public ProfilerConfig withDisableProfiler(Boolean disableProfiler)
```
    Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to True.
    
    Parameters:
    
    disableProfiler - Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to True.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isDisableProfiler
```
public Boolean isDisableProfiler()
```
    Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to True.
    
    Returns:
    
    Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to True.
  - 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 ProfilerConfig 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.773

Class ProfilerConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProfilerConfig

Method Detail

setS3OutputPath

getS3OutputPath

withS3OutputPath

setProfilingIntervalInMilliseconds

getProfilingIntervalInMilliseconds

withProfilingIntervalInMilliseconds

getProfilingParameters

setProfilingParameters

withProfilingParameters

addProfilingParametersEntry

clearProfilingParametersEntries

setDisableProfiler

getDisableProfiler

withDisableProfiler

isDisableProfiler

toString

equals

hashCode

clone

marshall