software.amazon.awssdk.services.sagemaker.model

Class ProfilerConfig

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.ProfilerConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ProfilerConfig.Builder,ProfilerConfig>

@Generated(value="software.amazon.awssdk:codegen")
public final class ProfilerConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ProfilerConfig.Builder,ProfilerConfig>

Configuration information for Debugger system monitoring, framework profiling, and storage paths.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProfilerConfig.Builder

Method Summary

Modifier and Type	Method and Description
static ProfilerConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasProfilingParameters() Returns true if the ProfilingParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Long	profilingIntervalInMilliseconds() A time interval for capturing system metrics in milliseconds.
Map<String,String>	profilingParameters() Configuration information for capturing framework metrics.
String	s3OutputPath() Path to Amazon S3 storage location for system and framework metrics.
List<SdkField<?>>	sdkFields()
static Class<? extends ProfilerConfig.Builder>	serializableBuilderClass()
ProfilerConfig.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

s3OutputPath

public String s3OutputPath()

Path to Amazon S3 storage location for system and framework metrics.

Returns:

Path to Amazon S3 storage location for system and framework metrics.

profilingIntervalInMilliseconds

public 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.

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.

hasProfilingParameters

public boolean hasProfilingParameters()

Returns true if the ProfilingParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

profilingParameters

public 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasProfilingParameters() to see if a value was sent in this field.

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.

toBuilder

public ProfilerConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ProfilerConfig.Builder,ProfilerConfig>

builder

public static ProfilerConfig.Builder builder()

serializableBuilderClass

public static Class<? extends ProfilerConfig.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo