software.amazon.awssdk.services.sagemaker.model

Class MonitoringJobDefinition

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.MonitoringJobDefinition

All Implemented Interfaces:

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

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

Defines the monitoring job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MonitoringJobDefinition.Builder

Method Summary

Modifier and Type	Method and Description
MonitoringBaselineConfig	baselineConfig() Baseline configuration used to validate that the data conforms to the specified constraints and statistics
static MonitoringJobDefinition.Builder	builder()
Map<String,String>	environment() Sets the environment variables in the Docker container.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEnvironment() Returns true if the Environment property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasMonitoringInputs() Returns true if the MonitoringInputs property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
MonitoringAppSpecification	monitoringAppSpecification() Configures the monitoring job to run a specified Docker container image.
List<MonitoringInput>	monitoringInputs() The array of inputs for the monitoring job.
MonitoringOutputConfig	monitoringOutputConfig() The array of outputs from the monitoring job to be uploaded to Amazon Simple Storage Service (Amazon S3).
MonitoringResources	monitoringResources() Identifies the resources, ML compute instances, and ML storage volumes to deploy for a monitoring job.
NetworkConfig	networkConfig() Specifies networking options for an monitoring job.
String	roleArn() The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
List<SdkField<?>>	sdkFields()
static Class<? extends MonitoringJobDefinition.Builder>	serializableBuilderClass()
MonitoringStoppingCondition	stoppingCondition() Specifies a time limit for how long the monitoring job is allowed to run.
MonitoringJobDefinition.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

baselineConfig

public final MonitoringBaselineConfig baselineConfig()

Baseline configuration used to validate that the data conforms to the specified constraints and statistics

Returns:

Baseline configuration used to validate that the data conforms to the specified constraints and statistics

hasMonitoringInputs

public final boolean hasMonitoringInputs()

Returns true if the MonitoringInputs 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.

monitoringInputs

public final List<MonitoringInput> monitoringInputs()

The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker Endpoint.

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

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

Returns:

The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker Endpoint.

monitoringOutputConfig

public final MonitoringOutputConfig monitoringOutputConfig()

The array of outputs from the monitoring job to be uploaded to Amazon Simple Storage Service (Amazon S3).

Returns:

The array of outputs from the monitoring job to be uploaded to Amazon Simple Storage Service (Amazon S3).

monitoringResources

public final MonitoringResources monitoringResources()

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a monitoring job. In distributed processing, you specify more than one instance.

Returns:

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a monitoring job. In distributed processing, you specify more than one instance.

monitoringAppSpecification

public final MonitoringAppSpecification monitoringAppSpecification()

Configures the monitoring job to run a specified Docker container image.

Returns:

Configures the monitoring job to run a specified Docker container image.

stoppingCondition

public final MonitoringStoppingCondition stoppingCondition()

Specifies a time limit for how long the monitoring job is allowed to run.

Returns:

Specifies a time limit for how long the monitoring job is allowed to run.

hasEnvironment

public final boolean hasEnvironment()

Returns true if the Environment 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.

environment

public final Map<String,String> environment()

Sets the environment variables in the Docker container.

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

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

Returns:

Sets the environment variables in the Docker container.

networkConfig

public final NetworkConfig networkConfig()

Specifies networking options for an monitoring job.

Returns:

Specifies networking options for an monitoring job.

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

Returns:

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

toBuilder

public MonitoringJobDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MonitoringJobDefinition.Builder,MonitoringJobDefinition>

builder

public static MonitoringJobDefinition.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo