Class DataDriftMonitoringSignal

java.lang.Object
com.azure.resourcemanager.machinelearning.models.MonitoringSignalBase
com.azure.resourcemanager.machinelearning.models.DataDriftMonitoringSignal
All Implemented Interfaces:
com.azure.json.JsonSerializable<MonitoringSignalBase>

public final class DataDriftMonitoringSignal extends MonitoringSignalBase
The DataDriftMonitoringSignal model.
  • Constructor Details

    • DataDriftMonitoringSignal

      public DataDriftMonitoringSignal()
      Creates an instance of DataDriftMonitoringSignal class.
  • Method Details

    • signalType

      public MonitoringSignalType signalType()
      Get the signalType property: [Required] Specifies the type of signal to monitor.
      Overrides:
      signalType in class MonitoringSignalBase
      Returns:
      the signalType value.
    • features

      public MonitoringFeatureFilterBase features()
      Get the features property: The feature filter which identifies which feature to calculate drift over.
      Returns:
      the features value.
    • withFeatures

      Set the features property: The feature filter which identifies which feature to calculate drift over.
      Parameters:
      features - the features value to set.
      Returns:
      the DataDriftMonitoringSignal object itself.
    • featureImportanceSettings

      public FeatureImportanceSettings featureImportanceSettings()
      Get the featureImportanceSettings property: The settings for computing feature importance.
      Returns:
      the featureImportanceSettings value.
    • withFeatureImportanceSettings

      public DataDriftMonitoringSignal withFeatureImportanceSettings(FeatureImportanceSettings featureImportanceSettings)
      Set the featureImportanceSettings property: The settings for computing feature importance.
      Parameters:
      featureImportanceSettings - the featureImportanceSettings value to set.
      Returns:
      the DataDriftMonitoringSignal object itself.
    • metricThresholds

      public List<DataDriftMetricThresholdBase> metricThresholds()
      Get the metricThresholds property: [Required] A list of metrics to calculate and their associated thresholds.
      Returns:
      the metricThresholds value.
    • withMetricThresholds

      public DataDriftMonitoringSignal withMetricThresholds(List<DataDriftMetricThresholdBase> metricThresholds)
      Set the metricThresholds property: [Required] A list of metrics to calculate and their associated thresholds.
      Parameters:
      metricThresholds - the metricThresholds value to set.
      Returns:
      the DataDriftMonitoringSignal object itself.
    • productionData

      public MonitoringInputDataBase productionData()
      Get the productionData property: [Required] The data which drift will be calculated for.
      Returns:
      the productionData value.
    • withProductionData

      public DataDriftMonitoringSignal withProductionData(MonitoringInputDataBase productionData)
      Set the productionData property: [Required] The data which drift will be calculated for.
      Parameters:
      productionData - the productionData value to set.
      Returns:
      the DataDriftMonitoringSignal object itself.
    • referenceData

      public MonitoringInputDataBase referenceData()
      Get the referenceData property: [Required] The data to calculate drift against.
      Returns:
      the referenceData value.
    • withReferenceData

      public DataDriftMonitoringSignal withReferenceData(MonitoringInputDataBase referenceData)
      Set the referenceData property: [Required] The data to calculate drift against.
      Parameters:
      referenceData - the referenceData value to set.
      Returns:
      the DataDriftMonitoringSignal object itself.
    • featureDataTypeOverride

      public Map<String,MonitoringFeatureDataType> featureDataTypeOverride()
      Get the featureDataTypeOverride property: A dictionary that maps feature names to their respective data types.
      Returns:
      the featureDataTypeOverride value.
    • withFeatureDataTypeOverride

      public DataDriftMonitoringSignal withFeatureDataTypeOverride(Map<String,MonitoringFeatureDataType> featureDataTypeOverride)
      Set the featureDataTypeOverride property: A dictionary that maps feature names to their respective data types.
      Parameters:
      featureDataTypeOverride - the featureDataTypeOverride value to set.
      Returns:
      the DataDriftMonitoringSignal object itself.
    • withNotificationTypes

      public DataDriftMonitoringSignal withNotificationTypes(List<MonitoringNotificationType> notificationTypes)
      Set the notificationTypes property: The current notification mode for this signal.
      Overrides:
      withNotificationTypes in class MonitoringSignalBase
      Parameters:
      notificationTypes - the notificationTypes value to set.
      Returns:
      the MonitoringSignalBase object itself.
    • withProperties

      public DataDriftMonitoringSignal withProperties(Map<String,String> properties)
      Set the properties property: Property dictionary. Properties can be added, but not removed or altered.
      Overrides:
      withProperties in class MonitoringSignalBase
      Parameters:
      properties - the properties value to set.
      Returns:
      the MonitoringSignalBase object itself.
    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class MonitoringSignalBase
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.
    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<MonitoringSignalBase>
      Overrides:
      toJson in class MonitoringSignalBase
      Throws:
      IOException
    • fromJson

      public static DataDriftMonitoringSignal fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of DataDriftMonitoringSignal from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of DataDriftMonitoringSignal if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the DataDriftMonitoringSignal.