Package 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("software.amazon.awssdk:codegen") public final class DescribeMonitoringScheduleResponse extends SageMakerResponse implements ToCopyableBuilder<DescribeMonitoringScheduleResponse.Builder,DescribeMonitoringScheduleResponse>

  • 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()

      Name of the monitoring schedule.

      Returns:
      Name of the monitoring schedule.

    • monitoringScheduleStatus

      public final 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:

    • monitoringScheduleStatusAsString

      public final 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:

    • monitoringType

      public final 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:

    • monitoringTypeAsString

      public final 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:

    • failureReason

      public final 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 final Instant creationTime()

      The time at which the monitoring job was created.

      Returns:
      The time at which the monitoring job was created.

    • lastModifiedTime

      public final 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 final 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 final String endpointName()

      The name of the endpoint for the monitoring job.

      Returns:
      The name of the endpoint for the monitoring job.

    • lastMonitoringExecutionSummary

      public final 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()
      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<DescribeMonitoringScheduleResponse.Builder,DescribeMonitoringScheduleResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeMonitoringScheduleResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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