MonitoringSchedule (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MonitoringSchedule
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A schedule for a model monitoring job. For information about model monitor, see Amazon SageMaker Model Monitor.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

MonitoringSchedule()

Constructors
Constructor and Description
`MonitoringSchedule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MonitoringSchedule`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTime()` The time that the monitoring schedule was created.
`String`	`getEndpointName()` The endpoint that hosts the model being monitored.
`String`	`getFailureReason()` If the monitoring schedule failed, the reason it failed.
`Date`	`getLastModifiedTime()` The last time the monitoring schedule was changed.
`MonitoringExecutionSummary`	`getLastMonitoringExecutionSummary()`
`String`	`getMonitoringScheduleArn()` The Amazon Resource Name (ARN) of the monitoring schedule.
`MonitoringScheduleConfig`	`getMonitoringScheduleConfig()`
`String`	`getMonitoringScheduleName()` The name of the monitoring schedule.
`String`	`getMonitoringScheduleStatus()` The status of the monitoring schedule.
`String`	`getMonitoringType()` The type of the monitoring job definition to schedule.
`List<Tag>`	`getTags()` A list of the tags associated with the monitoring schedlue.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreationTime(Date creationTime)` The time that the monitoring schedule was created.
`void`	`setEndpointName(String endpointName)` The endpoint that hosts the model being monitored.
`void`	`setFailureReason(String failureReason)` If the monitoring schedule failed, the reason it failed.
`void`	`setLastModifiedTime(Date lastModifiedTime)` The last time the monitoring schedule was changed.
`void`	`setLastMonitoringExecutionSummary(MonitoringExecutionSummary lastMonitoringExecutionSummary)`
`void`	`setMonitoringScheduleArn(String monitoringScheduleArn)` The Amazon Resource Name (ARN) of the monitoring schedule.
`void`	`setMonitoringScheduleConfig(MonitoringScheduleConfig monitoringScheduleConfig)`
`void`	`setMonitoringScheduleName(String monitoringScheduleName)` The name of the monitoring schedule.
`void`	`setMonitoringScheduleStatus(String monitoringScheduleStatus)` The status of the monitoring schedule.
`void`	`setMonitoringType(String monitoringType)` The type of the monitoring job definition to schedule.
`void`	`setTags(Collection<Tag> tags)` A list of the tags associated with the monitoring schedlue.
`String`	`toString()` Returns a string representation of this object.
`MonitoringSchedule`	`withCreationTime(Date creationTime)` The time that the monitoring schedule was created.
`MonitoringSchedule`	`withEndpointName(String endpointName)` The endpoint that hosts the model being monitored.
`MonitoringSchedule`	`withFailureReason(String failureReason)` If the monitoring schedule failed, the reason it failed.
`MonitoringSchedule`	`withLastModifiedTime(Date lastModifiedTime)` The last time the monitoring schedule was changed.
`MonitoringSchedule`	`withLastMonitoringExecutionSummary(MonitoringExecutionSummary lastMonitoringExecutionSummary)`
`MonitoringSchedule`	`withMonitoringScheduleArn(String monitoringScheduleArn)` The Amazon Resource Name (ARN) of the monitoring schedule.
`MonitoringSchedule`	`withMonitoringScheduleConfig(MonitoringScheduleConfig monitoringScheduleConfig)`
`MonitoringSchedule`	`withMonitoringScheduleName(String monitoringScheduleName)` The name of the monitoring schedule.
`MonitoringSchedule`	`withMonitoringScheduleStatus(ScheduleStatus monitoringScheduleStatus)` The status of the monitoring schedule.
`MonitoringSchedule`	`withMonitoringScheduleStatus(String monitoringScheduleStatus)` The status of the monitoring schedule.
`MonitoringSchedule`	`withMonitoringType(MonitoringType monitoringType)` The type of the monitoring job definition to schedule.
`MonitoringSchedule`	`withMonitoringType(String monitoringType)` The type of the monitoring job definition to schedule.
`MonitoringSchedule`	`withTags(Collection<Tag> tags)` A list of the tags associated with the monitoring schedlue.
`MonitoringSchedule`	`withTags(Tag... tags)` A list of the tags associated with the monitoring schedlue.

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

- Constructor Detail
  - MonitoringSchedule
```
public MonitoringSchedule()
```
- Method Detail
  - setMonitoringScheduleArn
```
public void setMonitoringScheduleArn(String monitoringScheduleArn)
```
    The Amazon Resource Name (ARN) of the monitoring schedule.
    
    Parameters:
    
    monitoringScheduleArn - The Amazon Resource Name (ARN) of the monitoring schedule.
  - getMonitoringScheduleArn
```
public String getMonitoringScheduleArn()
```
    The Amazon Resource Name (ARN) of the monitoring schedule.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the monitoring schedule.
  - withMonitoringScheduleArn
```
public MonitoringSchedule withMonitoringScheduleArn(String monitoringScheduleArn)
```
    The Amazon Resource Name (ARN) of the monitoring schedule.
    
    Parameters:
    
    monitoringScheduleArn - The Amazon Resource Name (ARN) of the monitoring schedule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMonitoringScheduleName
```
public void setMonitoringScheduleName(String monitoringScheduleName)
```
    The name of the monitoring schedule.
    
    Parameters:
    
    monitoringScheduleName - The name of the monitoring schedule.
  - getMonitoringScheduleName
```
public String getMonitoringScheduleName()
```
    The name of the monitoring schedule.
    
    Returns:
    
    The name of the monitoring schedule.
  - withMonitoringScheduleName
```
public MonitoringSchedule withMonitoringScheduleName(String monitoringScheduleName)
```
    The name of the monitoring schedule.
    
    Parameters:
    
    monitoringScheduleName - The name of the monitoring schedule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMonitoringScheduleStatus
```
public void setMonitoringScheduleStatus(String 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.
    Parameters:
    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.
    See Also:
    
    ScheduleStatus
  - getMonitoringScheduleStatus
```
public String getMonitoringScheduleStatus()
```
    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.
    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
  - withMonitoringScheduleStatus
```
public MonitoringSchedule withMonitoringScheduleStatus(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ScheduleStatus
  - withMonitoringScheduleStatus
```
public MonitoringSchedule withMonitoringScheduleStatus(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ScheduleStatus
  - setMonitoringType
```
public void setMonitoringType(String monitoringType)
```
    The type of the monitoring job definition to schedule.
    
    Parameters:
    
    monitoringType - The type of the monitoring job definition to schedule.
    
    See Also:
    
    MonitoringType
  - getMonitoringType
```
public String getMonitoringType()
```
    The type of the monitoring job definition to schedule.
    
    Returns:
    
    The type of the monitoring job definition to schedule.
    
    See Also:
    
    MonitoringType
  - withMonitoringType
```
public MonitoringSchedule withMonitoringType(String monitoringType)
```
    The type of the monitoring job definition to schedule.
    
    Parameters:
    
    monitoringType - The type of the monitoring job definition to schedule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MonitoringType
  - withMonitoringType
```
public MonitoringSchedule withMonitoringType(MonitoringType monitoringType)
```
    The type of the monitoring job definition to schedule.
    
    Parameters:
    
    monitoringType - The type of the monitoring job definition to schedule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MonitoringType
  - setFailureReason
```
public void setFailureReason(String failureReason)
```
    If the monitoring schedule failed, the reason it failed.
    
    Parameters:
    
    failureReason - If the monitoring schedule failed, the reason it failed.
  - getFailureReason
```
public String getFailureReason()
```
    If the monitoring schedule failed, the reason it failed.
    
    Returns:
    
    If the monitoring schedule failed, the reason it failed.
  - withFailureReason
```
public MonitoringSchedule withFailureReason(String failureReason)
```
    If the monitoring schedule failed, the reason it failed.
    
    Parameters:
    
    failureReason - If the monitoring schedule failed, the reason it failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The time that the monitoring schedule was created.
    
    Parameters:
    
    creationTime - The time that the monitoring schedule was created.
  - getCreationTime
```
public Date getCreationTime()
```
    The time that the monitoring schedule was created.
    
    Returns:
    
    The time that the monitoring schedule was created.
  - withCreationTime
```
public MonitoringSchedule withCreationTime(Date creationTime)
```
    The time that the monitoring schedule was created.
    
    Parameters:
    
    creationTime - The time that the monitoring schedule was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedTime
```
public void setLastModifiedTime(Date lastModifiedTime)
```
    The last time the monitoring schedule was changed.
    
    Parameters:
    
    lastModifiedTime - The last time the monitoring schedule was changed.
  - getLastModifiedTime
```
public Date getLastModifiedTime()
```
    The last time the monitoring schedule was changed.
    
    Returns:
    
    The last time the monitoring schedule was changed.
  - withLastModifiedTime
```
public MonitoringSchedule withLastModifiedTime(Date lastModifiedTime)
```
    The last time the monitoring schedule was changed.
    
    Parameters:
    
    lastModifiedTime - The last time the monitoring schedule was changed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMonitoringScheduleConfig
```
public void setMonitoringScheduleConfig(MonitoringScheduleConfig monitoringScheduleConfig)
```
    Parameters:
    
    monitoringScheduleConfig -
  - getMonitoringScheduleConfig
```
public MonitoringScheduleConfig getMonitoringScheduleConfig()
```
    Returns:
  - withMonitoringScheduleConfig
```
public MonitoringSchedule withMonitoringScheduleConfig(MonitoringScheduleConfig monitoringScheduleConfig)
```
    Parameters:
    
    monitoringScheduleConfig -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpointName
```
public void setEndpointName(String endpointName)
```
    The endpoint that hosts the model being monitored.
    
    Parameters:
    
    endpointName - The endpoint that hosts the model being monitored.
  - getEndpointName
```
public String getEndpointName()
```
    The endpoint that hosts the model being monitored.
    
    Returns:
    
    The endpoint that hosts the model being monitored.
  - withEndpointName
```
public MonitoringSchedule withEndpointName(String endpointName)
```
    The endpoint that hosts the model being monitored.
    
    Parameters:
    
    endpointName - The endpoint that hosts the model being monitored.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastMonitoringExecutionSummary
```
public void setLastMonitoringExecutionSummary(MonitoringExecutionSummary lastMonitoringExecutionSummary)
```
    Parameters:
    
    lastMonitoringExecutionSummary -
  - getLastMonitoringExecutionSummary
```
public MonitoringExecutionSummary getLastMonitoringExecutionSummary()
```
    Returns:
  - withLastMonitoringExecutionSummary
```
public MonitoringSchedule withLastMonitoringExecutionSummary(MonitoringExecutionSummary lastMonitoringExecutionSummary)
```
    Parameters:
    
    lastMonitoringExecutionSummary -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    A list of the tags associated with the monitoring schedlue. For more information, see Tagging AWS resources in the AWS General Reference Guide.
    
    Returns:
    
    A list of the tags associated with the monitoring schedlue. For more information, see Tagging AWS resources in the AWS General Reference Guide.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    A list of the tags associated with the monitoring schedlue. For more information, see Tagging AWS resources in the AWS General Reference Guide.
    
    Parameters:
    
    tags - A list of the tags associated with the monitoring schedlue. For more information, see Tagging AWS resources in the AWS General Reference Guide.
  - withTags
```
public MonitoringSchedule withTags(Tag... tags)
```
    A list of the tags associated with the monitoring schedlue. For more information, see Tagging AWS resources in the AWS General Reference Guide.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - A list of the tags associated with the monitoring schedlue. For more information, see Tagging AWS resources in the AWS General Reference Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public MonitoringSchedule withTags(Collection<Tag> tags)
```
    A list of the tags associated with the monitoring schedlue. For more information, see Tagging AWS resources in the AWS General Reference Guide.
    
    Parameters:
    
    tags - A list of the tags associated with the monitoring schedlue. For more information, see Tagging AWS resources in the AWS General Reference Guide.
    
    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 MonitoringSchedule 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.

Did this page help you?

Class MonitoringSchedule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MonitoringSchedule

Method Detail

setMonitoringScheduleArn

getMonitoringScheduleArn

withMonitoringScheduleArn

setMonitoringScheduleName

getMonitoringScheduleName

withMonitoringScheduleName

setMonitoringScheduleStatus

getMonitoringScheduleStatus

withMonitoringScheduleStatus

withMonitoringScheduleStatus

setMonitoringType

getMonitoringType

withMonitoringType

withMonitoringType

setFailureReason

getFailureReason

withFailureReason

setCreationTime

getCreationTime

withCreationTime

setLastModifiedTime

getLastModifiedTime

withLastModifiedTime

setMonitoringScheduleConfig

getMonitoringScheduleConfig

withMonitoringScheduleConfig

setEndpointName

getEndpointName

withEndpointName

setLastMonitoringExecutionSummary

getLastMonitoringExecutionSummary

withLastMonitoringExecutionSummary

getTags

setTags

withTags

withTags

toString

equals

hashCode

clone

marshall