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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface MonitoringSchedule.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static MonitoringSchedule.Builder`	`builder()`
`Instant`	`creationTime()`	The time that the monitoring schedule was created.
`String`	`endpointName()`	The endpoint that hosts the model being monitored.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`failureReason()`	If the monitoring schedule failed, the reason it failed.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`Instant`	`lastModifiedTime()`	The last time the monitoring schedule was changed.
`MonitoringExecutionSummary`	`lastMonitoringExecutionSummary()`	Returns the value of the LastMonitoringExecutionSummary property for this object.
`String`	`monitoringScheduleArn()`	The Amazon Resource Name (ARN) of the monitoring schedule.
`MonitoringScheduleConfig`	`monitoringScheduleConfig()`	Returns the value of the MonitoringScheduleConfig property for this object.
`String`	`monitoringScheduleName()`	The name of the monitoring schedule.
`ScheduleStatus`	`monitoringScheduleStatus()`	The status of the monitoring schedule.
`String`	`monitoringScheduleStatusAsString()`	The status of the monitoring schedule.
`MonitoringType`	`monitoringType()`	The type of the monitoring job definition to schedule.
`String`	`monitoringTypeAsString()`	The type of the monitoring job definition to schedule.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends MonitoringSchedule.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()`	A list of the tags associated with the monitoring schedlue.
`MonitoringSchedule.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
  - 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:
    
    ScheduleStatus
  - 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:
    
    ScheduleStatus
  - 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:
    
    MonitoringType
  - 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:
    
    MonitoringType
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<MonitoringSchedule.Builder,MonitoringSchedule>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class MonitoringSchedule

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

monitoringScheduleArn

monitoringScheduleName

monitoringScheduleStatus

monitoringScheduleStatusAsString

monitoringType

monitoringTypeAsString

failureReason

creationTime

lastModifiedTime

monitoringScheduleConfig

endpointName

lastMonitoringExecutionSummary

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields