Class MonitoringSchedule

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

A schedule for a model monitoring job. For information about model monitor, see Amazon SageMaker Model Monitor.

See Also:

  • Method Details

    • monitoringScheduleArn

      public final String monitoringScheduleArn()

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

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

    • monitoringScheduleName

      public final String monitoringScheduleName()

      The name of the monitoring schedule.

      Returns:
      The name of the monitoring schedule.

    • monitoringScheduleStatus

      public final ScheduleStatus monitoringScheduleStatus()

      The status of the monitoring schedule. This can be one of the following values.

      • PENDING - The schedule is pending being created.

      • FAILED - The schedule failed.

      • SCHEDULED - The schedule was successfully created.

      • STOPPED - The schedule was stopped.

      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. This can be one of the following values.

      • PENDING - The schedule is pending being created.

      • FAILED - The schedule failed.

      • SCHEDULED - The schedule was successfully created.

      • STOPPED - The schedule was stopped.

      See Also:

    • monitoringScheduleStatusAsString

      public final String monitoringScheduleStatusAsString()

      The status of the monitoring schedule. This can be one of the following values.

      • PENDING - The schedule is pending being created.

      • FAILED - The schedule failed.

      • SCHEDULED - The schedule was successfully created.

      • STOPPED - The schedule was stopped.

      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. This can be one of the following values.

      • PENDING - The schedule is pending being created.

      • FAILED - The schedule failed.

      • SCHEDULED - The schedule was successfully created.

      • STOPPED - The schedule was stopped.

      See Also:

    • monitoringType

      public final MonitoringType monitoringType()

      The type of the monitoring job definition to schedule.

      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 type of the monitoring job definition to schedule.
      See Also:

    • monitoringTypeAsString

      public final String monitoringTypeAsString()

      The type of the monitoring job definition to schedule.

      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 type of the monitoring job definition to schedule.
      See Also:

    • failureReason

      public final String failureReason()

      If the monitoring schedule failed, the reason it failed.

      Returns:
      If the monitoring schedule failed, the reason it failed.

    • creationTime

      public final Instant creationTime()

      The time that the monitoring schedule was created.

      Returns:
      The time that the monitoring schedule was created.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The last time the monitoring schedule was changed.

      Returns:
      The last time the monitoring schedule was changed.

    • 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 that hosts the model being monitored.

      Returns:
      The endpoint that hosts the model being monitored.

    • 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.

    • hasTags

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

    • tags

      public final List<Tag> tags()

      A list of the tags associated with the monitoring schedlue. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

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

      Returns:
      A list of the tags associated with the monitoring schedlue. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

    • toBuilder

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

    • builder

      public static MonitoringSchedule.Builder builder()

    • serializableBuilderClass

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