monitor_schema.models.TimeRangeBaseline#

class monitor_schema.models.TimeRangeBaseline[source]#

A static time range.

Instead of using a single profile or a trailing window, user can lock in a “good” period.

Show JSON schema
{
   "title": "TimeRangeBaseline",
   "description": "A static time range.\n\nInstead of using a single profile or a trailing window, user can lock in a \"good\" period.",
   "type": "object",
   "properties": {
      "datasetId": {
         "title": "DatasetId",
         "description": "The unique ID of an dataset. This is specific to WhyLabs. If the dataset ID does not exist, user will get a validation exception when saving the config with WhyLabs API",
         "maxLength": 100,
         "pattern": "[a-zA-Z0-9\\-_\\.]+",
         "type": "string"
      },
      "inheritSegment": {
         "title": "InheritSegment",
         "description": "Default to false. Whether to use the segment from the target to filter down the baseline",
         "type": "boolean"
      },
      "type": {
         "title": "Type",
         "enum": [
            "TimeRange"
         ],
         "type": "string"
      },
      "range": {
         "title": "Range",
         "description": "The range to set the time range with",
         "allOf": [
            {
               "$ref": "#/definitions/TimeRange"
            }
         ]
      }
   },
   "required": [
      "type",
      "range"
   ],
   "additionalProperties": false,
   "definitions": {
      "TimeRange": {
         "title": "TimeRange",
         "description": "Support for a specific time range.",
         "type": "object",
         "properties": {
            "start": {
               "title": "Start",
               "description": "Inclusive. Start time of a time range.",
               "type": "string",
               "format": "date-time"
            },
            "end": {
               "title": "End",
               "description": "Exclusive. End time of a time range.",
               "type": "string",
               "format": "date-time"
            }
         },
         "required": [
            "start",
            "end"
         ],
         "additionalProperties": false
      }
   }
}

Fields:
field range: TimeRange [Required]#

The range to set the time range with

field type: TimeRange: 'TimeRange'>] [Required]#