MonitoringJobDefinition (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Defines the monitoring job.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

MonitoringJobDefinition()

Constructors
Constructor and Description
`MonitoringJobDefinition()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MonitoringJobDefinition`	`addEnvironmentEntry(String key, String value)` Add a single Environment entry
`MonitoringJobDefinition`	`clearEnvironmentEntries()` Removes all the entries added into Environment.
`MonitoringJobDefinition`	`clone()`
`boolean`	`equals(Object obj)`
`MonitoringBaselineConfig`	`getBaselineConfig()` Baseline configuration used to validate that the data conforms to the specified constraints and statistics
`Map<String,String>`	`getEnvironment()` Sets the environment variables in the Docker container.
`MonitoringAppSpecification`	`getMonitoringAppSpecification()` Configures the monitoring job to run a specified Docker container image.
`List<MonitoringInput>`	`getMonitoringInputs()` The array of inputs for the monitoring job.
`MonitoringOutputConfig`	`getMonitoringOutputConfig()` The array of outputs from the monitoring job to be uploaded to Amazon S3.
`MonitoringResources`	`getMonitoringResources()` Identifies the resources, ML compute instances, and ML storage volumes to deploy for a monitoring job.
`NetworkConfig`	`getNetworkConfig()` Specifies networking options for an monitoring job.
`String`	`getRoleArn()` The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
`MonitoringStoppingCondition`	`getStoppingCondition()` Specifies a time limit for how long the monitoring job is allowed to run.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBaselineConfig(MonitoringBaselineConfig baselineConfig)` Baseline configuration used to validate that the data conforms to the specified constraints and statistics
`void`	`setEnvironment(Map<String,String> environment)` Sets the environment variables in the Docker container.
`void`	`setMonitoringAppSpecification(MonitoringAppSpecification monitoringAppSpecification)` Configures the monitoring job to run a specified Docker container image.
`void`	`setMonitoringInputs(Collection<MonitoringInput> monitoringInputs)` The array of inputs for the monitoring job.
`void`	`setMonitoringOutputConfig(MonitoringOutputConfig monitoringOutputConfig)` The array of outputs from the monitoring job to be uploaded to Amazon S3.
`void`	`setMonitoringResources(MonitoringResources monitoringResources)` Identifies the resources, ML compute instances, and ML storage volumes to deploy for a monitoring job.
`void`	`setNetworkConfig(NetworkConfig networkConfig)` Specifies networking options for an monitoring job.
`void`	`setRoleArn(String roleArn)` The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
`void`	`setStoppingCondition(MonitoringStoppingCondition stoppingCondition)` Specifies a time limit for how long the monitoring job is allowed to run.
`String`	`toString()` Returns a string representation of this object.
`MonitoringJobDefinition`	`withBaselineConfig(MonitoringBaselineConfig baselineConfig)` Baseline configuration used to validate that the data conforms to the specified constraints and statistics
`MonitoringJobDefinition`	`withEnvironment(Map<String,String> environment)` Sets the environment variables in the Docker container.
`MonitoringJobDefinition`	`withMonitoringAppSpecification(MonitoringAppSpecification monitoringAppSpecification)` Configures the monitoring job to run a specified Docker container image.
`MonitoringJobDefinition`	`withMonitoringInputs(Collection<MonitoringInput> monitoringInputs)` The array of inputs for the monitoring job.
`MonitoringJobDefinition`	`withMonitoringInputs(MonitoringInput... monitoringInputs)` The array of inputs for the monitoring job.
`MonitoringJobDefinition`	`withMonitoringOutputConfig(MonitoringOutputConfig monitoringOutputConfig)` The array of outputs from the monitoring job to be uploaded to Amazon S3.
`MonitoringJobDefinition`	`withMonitoringResources(MonitoringResources monitoringResources)` Identifies the resources, ML compute instances, and ML storage volumes to deploy for a monitoring job.
`MonitoringJobDefinition`	`withNetworkConfig(NetworkConfig networkConfig)` Specifies networking options for an monitoring job.
`MonitoringJobDefinition`	`withRoleArn(String roleArn)` The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
`MonitoringJobDefinition`	`withStoppingCondition(MonitoringStoppingCondition stoppingCondition)` Specifies a time limit for how long the monitoring job is allowed to run.

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

- Constructor Detail
  - MonitoringJobDefinition
```
public MonitoringJobDefinition()
```
- Method Detail
  - setBaselineConfig
```
public void setBaselineConfig(MonitoringBaselineConfig baselineConfig)
```
    Baseline configuration used to validate that the data conforms to the specified constraints and statistics
    
    Parameters:
    
    baselineConfig - Baseline configuration used to validate that the data conforms to the specified constraints and statistics
  - getBaselineConfig
```
public MonitoringBaselineConfig getBaselineConfig()
```
    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
  - withBaselineConfig
```
public MonitoringJobDefinition withBaselineConfig(MonitoringBaselineConfig baselineConfig)
```
    Baseline configuration used to validate that the data conforms to the specified constraints and statistics
    
    Parameters:
    
    baselineConfig - Baseline configuration used to validate that the data conforms to the specified constraints and statistics
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getMonitoringInputs
```
public List<MonitoringInput> getMonitoringInputs()
```
    The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker Endpoint.
    
    Returns:
    
    The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker Endpoint.
  - setMonitoringInputs
```
public void setMonitoringInputs(Collection<MonitoringInput> monitoringInputs)
```
    The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker Endpoint.
    
    Parameters:
    
    monitoringInputs - The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker Endpoint.
  - withMonitoringInputs
```
public MonitoringJobDefinition withMonitoringInputs(MonitoringInput... monitoringInputs)
```
    The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker Endpoint.
    
    NOTE: This method appends the values to the existing list (if any). Use setMonitoringInputs(java.util.Collection) or withMonitoringInputs(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    monitoringInputs - The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker Endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withMonitoringInputs
```
public MonitoringJobDefinition withMonitoringInputs(Collection<MonitoringInput> monitoringInputs)
```
    The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker Endpoint.
    
    Parameters:
    
    monitoringInputs - The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker Endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMonitoringOutputConfig
```
public void setMonitoringOutputConfig(MonitoringOutputConfig monitoringOutputConfig)
```
    The array of outputs from the monitoring job to be uploaded to Amazon S3.
    
    Parameters:
    
    monitoringOutputConfig - The array of outputs from the monitoring job to be uploaded to Amazon S3.
  - getMonitoringOutputConfig
```
public MonitoringOutputConfig getMonitoringOutputConfig()
```
    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.
  - withMonitoringOutputConfig
```
public MonitoringJobDefinition withMonitoringOutputConfig(MonitoringOutputConfig monitoringOutputConfig)
```
    The array of outputs from the monitoring job to be uploaded to Amazon S3.
    
    Parameters:
    
    monitoringOutputConfig - The array of outputs from the monitoring job to be uploaded to Amazon S3.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMonitoringResources
```
public void setMonitoringResources(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.
    
    Parameters:
    
    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.
  - getMonitoringResources
```
public MonitoringResources getMonitoringResources()
```
    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.
  - withMonitoringResources
```
public MonitoringJobDefinition withMonitoringResources(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMonitoringAppSpecification
```
public void setMonitoringAppSpecification(MonitoringAppSpecification monitoringAppSpecification)
```
    Configures the monitoring job to run a specified Docker container image.
    
    Parameters:
    
    monitoringAppSpecification - Configures the monitoring job to run a specified Docker container image.
  - getMonitoringAppSpecification
```
public MonitoringAppSpecification getMonitoringAppSpecification()
```
    Configures the monitoring job to run a specified Docker container image.
    
    Returns:
    
    Configures the monitoring job to run a specified Docker container image.
  - withMonitoringAppSpecification
```
public MonitoringJobDefinition withMonitoringAppSpecification(MonitoringAppSpecification monitoringAppSpecification)
```
    Configures the monitoring job to run a specified Docker container image.
    
    Parameters:
    
    monitoringAppSpecification - Configures the monitoring job to run a specified Docker container image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStoppingCondition
```
public void setStoppingCondition(MonitoringStoppingCondition stoppingCondition)
```
    Specifies a time limit for how long the monitoring job is allowed to run.
    
    Parameters:
    
    stoppingCondition - Specifies a time limit for how long the monitoring job is allowed to run.
  - getStoppingCondition
```
public MonitoringStoppingCondition getStoppingCondition()
```
    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.
  - withStoppingCondition
```
public MonitoringJobDefinition withStoppingCondition(MonitoringStoppingCondition stoppingCondition)
```
    Specifies a time limit for how long the monitoring job is allowed to run.
    
    Parameters:
    
    stoppingCondition - Specifies a time limit for how long the monitoring job is allowed to run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEnvironment
```
public Map<String,String> getEnvironment()
```
    Sets the environment variables in the Docker container.
    
    Returns:
    
    Sets the environment variables in the Docker container.
  - setEnvironment
```
public void setEnvironment(Map<String,String> environment)
```
    Sets the environment variables in the Docker container.
    
    Parameters:
    
    environment - Sets the environment variables in the Docker container.
  - withEnvironment
```
public MonitoringJobDefinition withEnvironment(Map<String,String> environment)
```
    Sets the environment variables in the Docker container.
    
    Parameters:
    
    environment - Sets the environment variables in the Docker container.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addEnvironmentEntry
```
public MonitoringJobDefinition addEnvironmentEntry(String key,
                                                   String value)
```
    Add a single Environment entry
    
    See Also:
    
    withEnvironment(java.util.Map<java.lang.String, java.lang.String>)
  - clearEnvironmentEntries
```
public MonitoringJobDefinition clearEnvironmentEntries()
```
    Removes all the entries added into Environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNetworkConfig
```
public void setNetworkConfig(NetworkConfig networkConfig)
```
    Specifies networking options for an monitoring job.
    
    Parameters:
    
    networkConfig - Specifies networking options for an monitoring job.
  - getNetworkConfig
```
public NetworkConfig getNetworkConfig()
```
    Specifies networking options for an monitoring job.
    
    Returns:
    
    Specifies networking options for an monitoring job.
  - withNetworkConfig
```
public MonitoringJobDefinition withNetworkConfig(NetworkConfig networkConfig)
```
    Specifies networking options for an monitoring job.
    
    Parameters:
    
    networkConfig - Specifies networking options for an monitoring job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
  - getRoleArn
```
public String getRoleArn()
```
    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.
  - withRoleArn
```
public MonitoringJobDefinition withRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 MonitoringJobDefinition 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.779

Class MonitoringJobDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MonitoringJobDefinition

Method Detail

setBaselineConfig

getBaselineConfig

withBaselineConfig

getMonitoringInputs

setMonitoringInputs

withMonitoringInputs

withMonitoringInputs

setMonitoringOutputConfig

getMonitoringOutputConfig

withMonitoringOutputConfig

setMonitoringResources

getMonitoringResources

withMonitoringResources

setMonitoringAppSpecification

getMonitoringAppSpecification

withMonitoringAppSpecification

setStoppingCondition

getStoppingCondition

withStoppingCondition

getEnvironment

setEnvironment

withEnvironment

addEnvironmentEntry

clearEnvironmentEntries

setNetworkConfig

getNetworkConfig

withNetworkConfig

setRoleArn

getRoleArn

withRoleArn

toString

equals

hashCode

clone

marshall