Class MonitoringJobDefinition
- java.lang.Object
-
- software.amazon.awssdk.services.sagemaker.model.MonitoringJobDefinition
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<MonitoringJobDefinition.Builder,MonitoringJobDefinition>
@Generated("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 Description static interface
MonitoringJobDefinition.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description MonitoringBaselineConfig
baselineConfig()
Baseline configuration used to validate that the data conforms to the specified constraints and statisticsstatic 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()
For responses, this returns true if the service returned a value for the Environment property.int
hashCode()
boolean
hasMonitoringInputs()
For responses, this returns true if the service returned a value for the MonitoringInputs property.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 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()
For responses, this returns true if the service returned a value for the MonitoringInputs property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasMonitoringInputs()
method.- 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 S3.
- Returns:
- The array of outputs from the monitoring job to be uploaded to 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()
For responses, this returns true if the service returned a value for the Environment property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasEnvironment()
method.- 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 interfaceToCopyableBuilder<MonitoringJobDefinition.Builder,MonitoringJobDefinition>
-
builder
public static MonitoringJobDefinition.Builder builder()
-
serializableBuilderClass
public static Class<? extends MonitoringJobDefinition.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-