Package 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("software.amazon.awssdk:codegen") public final class MonitoringJobDefinition extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MonitoringJobDefinition.Builder,MonitoringJobDefinition>

Defines the monitoring job.

See Also:

  • Method Details

    • 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 the isEmpty() 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 the isEmpty() 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<MonitoringJobDefinition.Builder,MonitoringJobDefinition>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.