software.amazon.awssdk.services.sagemaker.model

Class DescribeMonitoringScheduleResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

software.amazon.awssdk.services.sagemaker.model.DescribeMonitoringScheduleResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeMonitoringScheduleResponse.Builder,DescribeMonitoringScheduleResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeMonitoringScheduleResponse
extends SageMakerResponse
implements ToCopyableBuilder<DescribeMonitoringScheduleResponse.Builder,DescribeMonitoringScheduleResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeMonitoringScheduleResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeMonitoringScheduleResponse.Builder	builder()
Instant	creationTime() The time at which the monitoring job was created.
String	endpointName() The name of the endpoint for the monitoring job.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason() A string, up to one KB in size, that contains the reason a monitoring job failed, if it failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastModifiedTime() The time at which the monitoring job was last modified.
MonitoringExecutionSummary	lastMonitoringExecutionSummary() Describes metadata on the last execution to run, if there was one.
String	monitoringScheduleArn() The Amazon Resource Name (ARN) of the monitoring schedule.
MonitoringScheduleConfig	monitoringScheduleConfig() The configuration object that specifies the monitoring schedule and defines the monitoring job.
String	monitoringScheduleName() Name of the monitoring schedule.
ScheduleStatus	monitoringScheduleStatus() The status of an monitoring job.
String	monitoringScheduleStatusAsString() The status of an monitoring job.
MonitoringType	monitoringType() The type of the monitoring job that this schedule runs.
String	monitoringTypeAsString() The type of the monitoring job that this schedule runs.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeMonitoringScheduleResponse.Builder>	serializableBuilderClass()
DescribeMonitoringScheduleResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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 String monitoringScheduleArn()

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

Returns:

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

monitoringScheduleName

public String monitoringScheduleName()

Name of the monitoring schedule.

Returns:

Name of the monitoring schedule.

monitoringScheduleStatus

public ScheduleStatus monitoringScheduleStatus()

The status of an monitoring job.

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 an monitoring job.

See Also:

ScheduleStatus

monitoringScheduleStatusAsString

public String monitoringScheduleStatusAsString()

The status of an monitoring job.

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 an monitoring job.

See Also:

ScheduleStatus

monitoringType

public MonitoringType monitoringType()

The type of the monitoring job that this schedule runs. This is one of the following values.

• DATA_QUALITY - The schedule is for a data quality monitoring job.

• MODEL_QUALITY - The schedule is for a model quality monitoring job.

• MODEL_BIAS - The schedule is for a bias monitoring job.

• MODEL_EXPLAINABILITY - The schedule is for an explainability monitoring job.

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 that this schedule runs. This is one of the following values.

• DATA_QUALITY - The schedule is for a data quality monitoring job.

• MODEL_QUALITY - The schedule is for a model quality monitoring job.

• MODEL_BIAS - The schedule is for a bias monitoring job.

• MODEL_EXPLAINABILITY - The schedule is for an explainability monitoring job.

See Also:

MonitoringType

monitoringTypeAsString

public String monitoringTypeAsString()

The type of the monitoring job that this schedule runs. This is one of the following values.

• DATA_QUALITY - The schedule is for a data quality monitoring job.

• MODEL_QUALITY - The schedule is for a model quality monitoring job.

• MODEL_BIAS - The schedule is for a bias monitoring job.

• MODEL_EXPLAINABILITY - The schedule is for an explainability monitoring job.

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 that this schedule runs. This is one of the following values.

• DATA_QUALITY - The schedule is for a data quality monitoring job.

• MODEL_QUALITY - The schedule is for a model quality monitoring job.

• MODEL_BIAS - The schedule is for a bias monitoring job.

• MODEL_EXPLAINABILITY - The schedule is for an explainability monitoring job.

See Also:

MonitoringType

failureReason

public String failureReason()

A string, up to one KB in size, that contains the reason a monitoring job failed, if it failed.

Returns:

A string, up to one KB in size, that contains the reason a monitoring job failed, if it failed.

creationTime

public Instant creationTime()

The time at which the monitoring job was created.

Returns:

The time at which the monitoring job was created.

lastModifiedTime

public Instant lastModifiedTime()

The time at which the monitoring job was last modified.

Returns:

The time at which the monitoring job was last modified.

monitoringScheduleConfig

public MonitoringScheduleConfig monitoringScheduleConfig()

The configuration object that specifies the monitoring schedule and defines the monitoring job.

Returns:

The configuration object that specifies the monitoring schedule and defines the monitoring job.

endpointName

public String endpointName()

The name of the endpoint for the monitoring job.

Returns:

The name of the endpoint for the monitoring job.

lastMonitoringExecutionSummary

public MonitoringExecutionSummary lastMonitoringExecutionSummary()

Describes metadata on the last execution to run, if there was one.

Returns:

Describes metadata on the last execution to run, if there was one.

toBuilder

public DescribeMonitoringScheduleResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeMonitoringScheduleResponse.Builder,DescribeMonitoringScheduleResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeMonitoringScheduleResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeMonitoringScheduleResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo