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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ModelDashboardMonitoringSchedule.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description BatchTransformInput
batchTransformInput()
Returns the value of the BatchTransformInput property for this object.static ModelDashboardMonitoringSchedule.Builder
builder()
Instant
creationTime()
A timestamp that indicates when the monitoring schedule was created.String
endpointName()
The endpoint which is monitored.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
failureReason()
If a monitoring job failed, provides the reason.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasMonitoringAlertSummaries()
For responses, this returns true if the service returned a value for the MonitoringAlertSummaries property.Instant
lastModifiedTime()
A timestamp that indicates when the monitoring schedule was last updated.MonitoringExecutionSummary
lastMonitoringExecutionSummary()
Returns the value of the LastMonitoringExecutionSummary property for this object.List<MonitoringAlertSummary>
monitoringAlertSummaries()
A JSON array where each element is a summary for a monitoring alert.String
monitoringScheduleArn()
The Amazon Resource Name (ARN) of a monitoring schedule.MonitoringScheduleConfig
monitoringScheduleConfig()
Returns the value of the MonitoringScheduleConfig property for this object.String
monitoringScheduleName()
The name of a monitoring schedule.ScheduleStatus
monitoringScheduleStatus()
The status of the monitoring schedule.String
monitoringScheduleStatusAsString()
The status of the monitoring schedule.MonitoringType
monitoringType()
The monitor type of a model monitor.String
monitoringTypeAsString()
The monitor type of a model monitor.List<SdkField<?>>
sdkFields()
static Class<? extends ModelDashboardMonitoringSchedule.Builder>
serializableBuilderClass()
ModelDashboardMonitoringSchedule.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 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 returnScheduleStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommonitoringScheduleStatusAsString()
.- Returns:
- The status of the monitoring schedule.
- See Also:
ScheduleStatus
-
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 returnScheduleStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommonitoringScheduleStatusAsString()
.- Returns:
- The status of the monitoring schedule.
- See Also:
ScheduleStatus
-
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 returnMonitoringType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommonitoringTypeAsString()
.- Returns:
- The monitor type of a model monitor.
- See Also:
MonitoringType
-
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 returnMonitoringType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommonitoringTypeAsString()
.- Returns:
- The monitor type of a model monitor.
- See Also:
MonitoringType
-
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 theisEmpty()
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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ModelDashboardMonitoringSchedule.Builder,ModelDashboardMonitoringSchedule>
-
builder
public static ModelDashboardMonitoringSchedule.Builder builder()
-
serializableBuilderClass
public static Class<? extends ModelDashboardMonitoringSchedule.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-