com.amazonaws.services.sagemaker.model

Class ProfilerConfigForUpdate

java.lang.Object

com.amazonaws.services.sagemaker.model.ProfilerConfigForUpdate

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ProfilerConfigForUpdate
extends Object
implements Serializable, Cloneable, StructuredPojo

Configuration information for updating the Debugger profile parameters, system and framework metrics configurations, and storage paths.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProfilerConfigForUpdate()

Method Summary

Modifier and Type	Method and Description
ProfilerConfigForUpdate	addProfilingParametersEntry(String key, String value) Add a single ProfilingParameters entry
ProfilerConfigForUpdate	clearProfilingParametersEntries() Removes all the entries added into ProfilingParameters.
ProfilerConfigForUpdate	clone()
boolean	equals(Object obj)
Boolean	getDisableProfiler() To disable Debugger monitoring and profiling, set to True.
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() To disable Debugger monitoring and profiling, set to True.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setDisableProfiler(Boolean disableProfiler) To disable Debugger monitoring and profiling, set to True.
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.
ProfilerConfigForUpdate	withDisableProfiler(Boolean disableProfiler) To disable Debugger monitoring and profiling, set to True.
ProfilerConfigForUpdate	withProfilingIntervalInMilliseconds(Long profilingIntervalInMilliseconds) A time interval for capturing system metrics in milliseconds.
ProfilerConfigForUpdate	withProfilingParameters(Map<String,String> profilingParameters) Configuration information for capturing framework metrics.
ProfilerConfigForUpdate	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

ProfilerConfigForUpdate

public ProfilerConfigForUpdate()

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 ProfilerConfigForUpdate 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 ProfilerConfigForUpdate 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 ProfilerConfigForUpdate 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 ProfilerConfigForUpdate addProfilingParametersEntry(String key,
                                                           String value)

Add a single ProfilingParameters entry

See Also:

withProfilingParameters(java.util.Map<java.lang.String, java.lang.String>)

clearProfilingParametersEntries

public ProfilerConfigForUpdate 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)

To disable Debugger monitoring and profiling, set to True.

Parameters:

disableProfiler - To disable Debugger monitoring and profiling, set to True.

getDisableProfiler

public Boolean getDisableProfiler()

To disable Debugger monitoring and profiling, set to True.

Returns:

To disable Debugger monitoring and profiling, set to True.

withDisableProfiler

public ProfilerConfigForUpdate withDisableProfiler(Boolean disableProfiler)

To disable Debugger monitoring and profiling, set to True.

Parameters:

disableProfiler - To disable Debugger monitoring and profiling, set to True.

Returns:

Returns a reference to this object so that method calls can be chained together.

isDisableProfiler

public Boolean isDisableProfiler()

To disable Debugger monitoring and profiling, set to True.

Returns:

To disable Debugger monitoring and profiling, 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 ProfilerConfigForUpdate 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.