Class ModelDashboardMonitoringSchedule

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.ModelDashboardMonitoringSchedule
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ModelDashboardMonitoringSchedule.Builder,ModelDashboardMonitoringSchedule>
@Generated("software.amazon.awssdk:codegen") public final class ModelDashboardMonitoringSchedule extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ModelDashboardMonitoringSchedule.Builder,ModelDashboardMonitoringSchedule>

A monitoring schedule for a model displayed in the Amazon SageMaker Model Dashboard.

See Also:

  • Method Details

    • monitoringScheduleArn

      public final String monitoringScheduleArn()

      The Amazon Resource Name (ARN) of a monitoring schedule.

      Returns:
      The Amazon Resource Name (ARN) of a monitoring schedule.

    • monitoringScheduleName

      public final String monitoringScheduleName()

      The name of a monitoring schedule.

      Returns:
      The name of a monitoring schedule.

    • monitoringScheduleStatus

      public final ScheduleStatus monitoringScheduleStatus()

      The status of the monitoring schedule.

      If the service returns an enum value that is not available in the current SDK version, monitoringScheduleStatus will return ScheduleStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from monitoringScheduleStatusAsString().

      Returns:
      The status of the monitoring schedule.
      See Also:

    • monitoringScheduleStatusAsString

      public final String monitoringScheduleStatusAsString()

      The status of the monitoring schedule.

      If the service returns an enum value that is not available in the current SDK version, monitoringScheduleStatus will return ScheduleStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from monitoringScheduleStatusAsString().

      Returns:
      The status of the monitoring schedule.
      See Also:

    • monitoringType

      public final MonitoringType monitoringType()

      The monitor type of a model monitor.

      If the service returns an enum value that is not available in the current SDK version, monitoringType will return MonitoringType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from monitoringTypeAsString().

      Returns:
      The monitor type of a model monitor.
      See Also:

    • monitoringTypeAsString

      public final String monitoringTypeAsString()

      The monitor type of a model monitor.

      If the service returns an enum value that is not available in the current SDK version, monitoringType will return MonitoringType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from monitoringTypeAsString().

      Returns:
      The monitor type of a model monitor.
      See Also:

    • failureReason

      public final String failureReason()

      If a monitoring job failed, provides the reason.

      Returns:
      If a monitoring job failed, provides the reason.

    • creationTime

      public final Instant creationTime()

      A timestamp that indicates when the monitoring schedule was created.

      Returns:
      A timestamp that indicates when the monitoring schedule was created.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      A timestamp that indicates when the monitoring schedule was last updated.

      Returns:
      A timestamp that indicates when the monitoring schedule was last updated.

    • monitoringScheduleConfig

      public final MonitoringScheduleConfig monitoringScheduleConfig()
      Returns the value of the MonitoringScheduleConfig property for this object.
      Returns:
      The value of the MonitoringScheduleConfig property for this object.

    • endpointName

      public final String endpointName()

      The endpoint which is monitored.

      Returns:
      The endpoint which is monitored.

    • hasMonitoringAlertSummaries

      public final boolean hasMonitoringAlertSummaries()
      For responses, this returns true if the service returned a value for the MonitoringAlertSummaries 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.

    • monitoringAlertSummaries

      public final List<MonitoringAlertSummary> monitoringAlertSummaries()

      A JSON array where each element is a summary for a monitoring alert.

      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 hasMonitoringAlertSummaries() method.

      Returns:
      A JSON array where each element is a summary for a monitoring alert.

    • lastMonitoringExecutionSummary

      public final MonitoringExecutionSummary lastMonitoringExecutionSummary()
      Returns the value of the LastMonitoringExecutionSummary property for this object.
      Returns:
      The value of the LastMonitoringExecutionSummary property for this object.

    • batchTransformInput

      public final BatchTransformInput batchTransformInput()
      Returns the value of the BatchTransformInput property for this object.
      Returns:
      The value of the BatchTransformInput property for this object.

    • toBuilder

      public ModelDashboardMonitoringSchedule.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<ModelDashboardMonitoringSchedule.Builder,ModelDashboardMonitoringSchedule>
      Returns:
      a builder for type T

    • builder

      public static ModelDashboardMonitoringSchedule.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ModelDashboardMonitoringSchedule.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.