kibana/api_docs/kbn_slo_schema.devdocs.json

7525 lines
No EOL
223 KiB
JSON

{
"id": "@kbn/slo-schema",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.Duration",
"type": "Class",
"tags": [],
"label": "Duration",
"description": [],
"path": "x-pack/packages/kbn-slo-schema/src/models/duration.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.Duration.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "x-pack/packages/kbn-slo-schema/src/models/duration.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.Duration.Unnamed.$1",
"type": "number",
"tags": [],
"label": "value",
"description": [],
"signature": [
"number"
],
"path": "x-pack/packages/kbn-slo-schema/src/models/duration.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.Duration.Unnamed.$2",
"type": "Enum",
"tags": [],
"label": "unit",
"description": [],
"signature": [
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.DurationUnit",
"text": "DurationUnit"
}
],
"path": "x-pack/packages/kbn-slo-schema/src/models/duration.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.Duration.add",
"type": "Function",
"tags": [],
"label": "add",
"description": [],
"signature": [
"(other: ",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
") => ",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
}
],
"path": "x-pack/packages/kbn-slo-schema/src/models/duration.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.Duration.add.$1",
"type": "Object",
"tags": [],
"label": "other",
"description": [],
"signature": [
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
}
],
"path": "x-pack/packages/kbn-slo-schema/src/models/duration.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.Duration.isShorterThan",
"type": "Function",
"tags": [],
"label": "isShorterThan",
"description": [],
"signature": [
"(other: ",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
") => boolean"
],
"path": "x-pack/packages/kbn-slo-schema/src/models/duration.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.Duration.isShorterThan.$1",
"type": "Object",
"tags": [],
"label": "other",
"description": [],
"signature": [
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
}
],
"path": "x-pack/packages/kbn-slo-schema/src/models/duration.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.Duration.isLongerOrEqualThan",
"type": "Function",
"tags": [],
"label": "isLongerOrEqualThan",
"description": [],
"signature": [
"(other: ",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
") => boolean"
],
"path": "x-pack/packages/kbn-slo-schema/src/models/duration.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.Duration.isLongerOrEqualThan.$1",
"type": "Object",
"tags": [],
"label": "other",
"description": [],
"signature": [
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
}
],
"path": "x-pack/packages/kbn-slo-schema/src/models/duration.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.Duration.isEqual",
"type": "Function",
"tags": [],
"label": "isEqual",
"description": [],
"signature": [
"(other: ",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
") => boolean"
],
"path": "x-pack/packages/kbn-slo-schema/src/models/duration.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.Duration.isEqual.$1",
"type": "Object",
"tags": [],
"label": "other",
"description": [],
"signature": [
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
}
],
"path": "x-pack/packages/kbn-slo-schema/src/models/duration.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.Duration.format",
"type": "Function",
"tags": [],
"label": "format",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/packages/kbn-slo-schema/src/models/duration.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.Duration.asSeconds",
"type": "Function",
"tags": [],
"label": "asSeconds",
"description": [],
"signature": [
"() => number"
],
"path": "x-pack/packages/kbn-slo-schema/src/models/duration.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.toDurationUnit",
"type": "Function",
"tags": [],
"label": "toDurationUnit",
"description": [],
"signature": [
"(unit: string) => ",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.DurationUnit",
"text": "DurationUnit"
}
],
"path": "x-pack/packages/kbn-slo-schema/src/models/duration.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.toDurationUnit.$1",
"type": "string",
"tags": [],
"label": "unit",
"description": [],
"signature": [
"string"
],
"path": "x-pack/packages/kbn-slo-schema/src/models/duration.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.toMomentUnitOfTime",
"type": "Function",
"tags": [],
"label": "toMomentUnitOfTime",
"description": [],
"signature": [
"(unit: ",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.DurationUnit",
"text": "DurationUnit"
},
") => moment.unitOfTime.Diff"
],
"path": "x-pack/packages/kbn-slo-schema/src/models/duration.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.toMomentUnitOfTime.$1",
"type": "Enum",
"tags": [],
"label": "unit",
"description": [],
"signature": [
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.DurationUnit",
"text": "DurationUnit"
}
],
"path": "x-pack/packages/kbn-slo-schema/src/models/duration.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.DurationUnit",
"type": "Enum",
"tags": [],
"label": "DurationUnit",
"description": [],
"path": "x-pack/packages/kbn-slo-schema/src/models/duration.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.ALL_VALUE",
"type": "string",
"tags": [],
"label": "ALL_VALUE",
"description": [],
"signature": [
"\"*\""
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/common.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.APMTransactionDurationIndicator",
"type": "Type",
"tags": [],
"label": "APMTransactionDurationIndicator",
"description": [],
"signature": [
"{ type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.APMTransactionErrorRateIndicator",
"type": "Type",
"tags": [],
"label": "APMTransactionErrorRateIndicator",
"description": [],
"signature": [
"{ type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.BudgetingMethod",
"type": "Type",
"tags": [],
"label": "BudgetingMethod",
"description": [],
"signature": [
"\"occurrences\" | \"timeslices\""
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.CreateCompositeSLOInput",
"type": "Type",
"tags": [],
"label": "CreateCompositeSLOInput",
"description": [],
"signature": [
"{ name: string; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; compositeMethod: \"weightedAverage\"; sources: { id: string; revision: number; weight: number; }[]; } & { id?: string | undefined; tags?: string[] | undefined; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/composite_slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.CreateCompositeSLOParams",
"type": "Type",
"tags": [],
"label": "CreateCompositeSLOParams",
"description": [],
"signature": [
"{ name: string; timeWindow: { duration: ",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
"; type: \"rolling\"; } | { duration: ",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
"; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: ",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
" | undefined; }; compositeMethod: \"weightedAverage\"; sources: { id: string; revision: number; weight: number; }[]; } & { id?: string | undefined; tags?: string[] | undefined; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/composite_slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.CreateCompositeSLOResponse",
"type": "Type",
"tags": [],
"label": "CreateCompositeSLOResponse",
"description": [],
"signature": [
"{ id: string; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/composite_slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.CreateSLOInput",
"type": "Type",
"tags": [],
"label": "CreateSLOInput",
"description": [],
"signature": [
"{ name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string; total: string; timestampField: string; } & { filter?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; } & { filter?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); } & { filter?: string | undefined; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; } & { id?: string | undefined; settings?: { syncDelay?: string | undefined; frequency?: string | undefined; } | undefined; tags?: string[] | undefined; groupBy?: string | undefined; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.CreateSLOParams",
"type": "Type",
"tags": [],
"label": "CreateSLOParams",
"description": [],
"signature": [
"{ name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string; total: string; timestampField: string; } & { filter?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; } & { filter?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); } & { filter?: string | undefined; }; }; timeWindow: { duration: ",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
"; type: \"rolling\"; } | { duration: ",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
"; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: ",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
" | undefined; }; } & { id?: string | undefined; settings?: { syncDelay?: ",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
" | undefined; frequency?: ",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
" | undefined; } | undefined; tags?: string[] | undefined; groupBy?: string | undefined; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.CreateSLOResponse",
"type": "Type",
"tags": [],
"label": "CreateSLOResponse",
"description": [],
"signature": [
"{ id: string; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.DeleteSLOInstancesInput",
"type": "Type",
"tags": [],
"label": "DeleteSLOInstancesInput",
"description": [],
"signature": [
"{ list: { sloId: string; instanceId: string; }[]; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.DeleteSLOInstancesParams",
"type": "Type",
"tags": [],
"label": "DeleteSLOInstancesParams",
"description": [],
"signature": [
"{ list: { sloId: string; instanceId: string; }[]; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.FetchHistoricalSummaryParams",
"type": "Type",
"tags": [],
"label": "FetchHistoricalSummaryParams",
"description": [],
"signature": [
"{ list: { sloId: string; instanceId: string; }[]; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.FetchHistoricalSummaryResponse",
"type": "Type",
"tags": [],
"label": "FetchHistoricalSummaryResponse",
"description": [],
"signature": [
"{ sloId: string; instanceId: string; data: ({ date: string; } & { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; })[]; }[]"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.FindCompositeSLOParams",
"type": "Type",
"tags": [],
"label": "FindCompositeSLOParams",
"description": [],
"signature": [
"{ name?: string | undefined; page?: string | undefined; perPage?: string | undefined; sortBy?: \"creationTime\" | undefined; sortDirection?: \"asc\" | \"desc\" | undefined; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/composite_slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.FindCompositeSLOResponse",
"type": "Type",
"tags": [],
"label": "FindCompositeSLOResponse",
"description": [],
"signature": [
"{ page: number; perPage: number; total: number; results: ({ id: string; name: string; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; compositeMethod: \"weightedAverage\"; sources: { id: string; revision: number; weight: number; }[]; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; })[]; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/composite_slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.FindSloDefinitionsResponse",
"type": "Type",
"tags": [
"private"
],
"label": "FindSloDefinitionsResponse",
"description": [
"\nThe response type for /internal/observability/slo/_definitions\n"
],
"signature": [
"({ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string; total: string; timestampField: string; } & { filter?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; } & { filter?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); } & { filter?: string | undefined; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; groupBy: string; createdAt: string; updatedAt: string; } & { instanceId?: string | undefined; })[]"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.FindSLOParams",
"type": "Type",
"tags": [],
"label": "FindSLOParams",
"description": [],
"signature": [
"{ kqlQuery?: string | undefined; page?: string | undefined; perPage?: string | undefined; sortBy?: \"status\" | \"error_budget_consumed\" | \"error_budget_remaining\" | \"sli_value\" | undefined; sortDirection?: \"asc\" | \"desc\" | undefined; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.FindSLOResponse",
"type": "Type",
"tags": [],
"label": "FindSLOResponse",
"description": [],
"signature": [
"{ page: number; perPage: number; total: number; results: ({ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string; total: string; timestampField: string; } & { filter?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; } & { filter?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); } & { filter?: string | undefined; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; groupBy: string; createdAt: string; updatedAt: string; } & { instanceId?: string | undefined; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; })[]; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.GetCompositeSLOResponse",
"type": "Type",
"tags": [],
"label": "GetCompositeSLOResponse",
"description": [],
"signature": [
"{ id: string; name: string; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; compositeMethod: \"weightedAverage\"; sources: { id: string; revision: number; weight: number; }[]; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/composite_slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.GetPreviewDataParams",
"type": "Type",
"tags": [],
"label": "GetPreviewDataParams",
"description": [],
"signature": [
"{ indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string; total: string; timestampField: string; } & { filter?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; } & { filter?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); } & { filter?: string | undefined; }; }; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.GetPreviewDataResponse",
"type": "Type",
"tags": [],
"label": "GetPreviewDataResponse",
"description": [],
"signature": [
"{ date: string; sliValue: number; }[]"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.GetSLOBurnRatesResponse",
"type": "Type",
"tags": [],
"label": "GetSLOBurnRatesResponse",
"description": [],
"signature": [
"{ burnRates: { name: string; burnRate: number; sli: number; }[]; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.GetSLOInstancesResponse",
"type": "Type",
"tags": [],
"label": "GetSLOInstancesResponse",
"description": [],
"signature": [
"{ groupBy: string; instances: string[]; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.GetSLOParams",
"type": "Type",
"tags": [],
"label": "GetSLOParams",
"description": [],
"signature": [
"{ instanceId?: string | undefined; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.GetSLOResponse",
"type": "Type",
"tags": [],
"label": "GetSLOResponse",
"description": [],
"signature": [
"{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string; total: string; timestampField: string; } & { filter?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; } & { filter?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); } & { filter?: string | undefined; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; groupBy: string; createdAt: string; updatedAt: string; } & { instanceId?: string | undefined; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.HistogramIndicator",
"type": "Type",
"tags": [],
"label": "HistogramIndicator",
"description": [],
"signature": [
"{ type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); } & { filter?: string | undefined; }; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.HistoricalSummaryResponse",
"type": "Type",
"tags": [],
"label": "HistoricalSummaryResponse",
"description": [],
"signature": [
"{ date: string; } & { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.Indicator",
"type": "Type",
"tags": [],
"label": "Indicator",
"description": [],
"signature": [
"{ type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string; total: string; timestampField: string; } & { filter?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; } & { filter?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); } & { filter?: string | undefined; }; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.IndicatorType",
"type": "Type",
"tags": [],
"label": "IndicatorType",
"description": [],
"signature": [
"\"sli.apm.transactionDuration\" | \"sli.apm.transactionErrorRate\" | \"sli.kql.custom\" | \"sli.metric.custom\" | \"sli.histogram.custom\""
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.KQLCustomIndicator",
"type": "Type",
"tags": [],
"label": "KQLCustomIndicator",
"description": [],
"signature": [
"{ type: \"sli.kql.custom\"; params: { index: string; good: string; total: string; timestampField: string; } & { filter?: string | undefined; }; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.ManageSLOParams",
"type": "Type",
"tags": [],
"label": "ManageSLOParams",
"description": [],
"signature": [
"{ id: string; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.MetricCustomIndicator",
"type": "Type",
"tags": [],
"label": "MetricCustomIndicator",
"description": [],
"signature": [
"{ type: \"sli.metric.custom\"; params: { index: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; } & { filter?: string | undefined; }; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.SLOResponse",
"type": "Type",
"tags": [],
"label": "SLOResponse",
"description": [],
"signature": [
"{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string; total: string; timestampField: string; } & { filter?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; } & { filter?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); } & { filter?: string | undefined; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; groupBy: string; createdAt: string; updatedAt: string; } & { instanceId?: string | undefined; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.SLOWithSummaryResponse",
"type": "Type",
"tags": [],
"label": "SLOWithSummaryResponse",
"description": [],
"signature": [
"{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string; total: string; timestampField: string; } & { filter?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; } & { filter?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); } & { filter?: string | undefined; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; groupBy: string; createdAt: string; updatedAt: string; } & { instanceId?: string | undefined; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.TimeWindow",
"type": "Type",
"tags": [],
"label": "TimeWindow",
"description": [],
"signature": [
"\"rolling\" | \"calendarAligned\""
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.UpdateCompositeSLOInput",
"type": "Type",
"tags": [],
"label": "UpdateCompositeSLOInput",
"description": [],
"signature": [
"{ name?: string | undefined; compositeMethod?: \"weightedAverage\" | undefined; sources?: { id: string; revision: number; weight: number; }[] | undefined; timeWindow?: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; } | undefined; budgetingMethod?: \"occurrences\" | \"timeslices\" | undefined; objective?: ({ target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }) | undefined; tags?: string[] | undefined; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/composite_slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.UpdateCompositeSLOParams",
"type": "Type",
"tags": [],
"label": "UpdateCompositeSLOParams",
"description": [],
"signature": [
"{ name?: string | undefined; compositeMethod?: \"weightedAverage\" | undefined; sources?: { id: string; revision: number; weight: number; }[] | undefined; timeWindow?: { duration: ",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
"; type: \"rolling\"; } | { duration: ",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
"; type: \"calendarAligned\"; } | undefined; budgetingMethod?: \"occurrences\" | \"timeslices\" | undefined; objective?: ({ target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: ",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
" | undefined; }) | undefined; tags?: string[] | undefined; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/composite_slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.UpdateCompositeSLOResponse",
"type": "Type",
"tags": [],
"label": "UpdateCompositeSLOResponse",
"description": [],
"signature": [
"{ id: string; name: string; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; compositeMethod: \"weightedAverage\"; sources: { id: string; revision: number; weight: number; }[]; tags: string[]; createdAt: string; updatedAt: string; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/composite_slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.UpdateSLOInput",
"type": "Type",
"tags": [],
"label": "UpdateSLOInput",
"description": [],
"signature": [
"{ name?: string | undefined; description?: string | undefined; indicator?: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string; total: string; timestampField: string; } & { filter?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; } & { filter?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); } & { filter?: string | undefined; }; } | undefined; timeWindow?: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; } | undefined; budgetingMethod?: \"occurrences\" | \"timeslices\" | undefined; objective?: ({ target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }) | undefined; settings?: { syncDelay?: string | undefined; frequency?: string | undefined; } | undefined; tags?: string[] | undefined; groupBy?: string | undefined; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.UpdateSLOParams",
"type": "Type",
"tags": [],
"label": "UpdateSLOParams",
"description": [],
"signature": [
"{ name?: string | undefined; description?: string | undefined; indicator?: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string; total: string; timestampField: string; } & { filter?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; } & { filter?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); } & { filter?: string | undefined; }; } | undefined; timeWindow?: { duration: ",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
"; type: \"rolling\"; } | { duration: ",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
"; type: \"calendarAligned\"; } | undefined; budgetingMethod?: \"occurrences\" | \"timeslices\" | undefined; objective?: ({ target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: ",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
" | undefined; }) | undefined; settings?: { syncDelay?: ",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
" | undefined; frequency?: ",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
" | undefined; } | undefined; tags?: string[] | undefined; groupBy?: string | undefined; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.UpdateSLOResponse",
"type": "Type",
"tags": [],
"label": "UpdateSLOResponse",
"description": [],
"signature": [
"{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string; total: string; timestampField: string; } & { filter?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; } & { filter?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); } & { filter?: string | undefined; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; groupBy: string; createdAt: string; updatedAt: string; } & { instanceId?: string | undefined; }"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.allOrAnyString",
"type": "Object",
"tags": [],
"label": "allOrAnyString",
"description": [],
"signature": [
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/common.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.apmTransactionDurationIndicatorSchema",
"type": "Object",
"tags": [],
"label": "apmTransactionDurationIndicatorSchema",
"description": [],
"signature": [
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.apm.transactionDuration\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ environment: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; service: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionType: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionName: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; threshold: ",
"NumberC",
"; index: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/indicators.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.apmTransactionDurationIndicatorTypeSchema",
"type": "Object",
"tags": [],
"label": "apmTransactionDurationIndicatorTypeSchema",
"description": [],
"signature": [
"LiteralC",
"<\"sli.apm.transactionDuration\">"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/indicators.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.apmTransactionErrorRateIndicatorSchema",
"type": "Object",
"tags": [],
"label": "apmTransactionErrorRateIndicatorSchema",
"description": [],
"signature": [
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.apm.transactionErrorRate\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ environment: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; service: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionType: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionName: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; index: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/indicators.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.apmTransactionErrorRateIndicatorTypeSchema",
"type": "Object",
"tags": [],
"label": "apmTransactionErrorRateIndicatorTypeSchema",
"description": [],
"signature": [
"LiteralC",
"<\"sli.apm.transactionErrorRate\">"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/indicators.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.budgetingMethodSchema",
"type": "Object",
"tags": [],
"label": "budgetingMethodSchema",
"description": [],
"signature": [
"UnionC",
"<[",
"LiteralC",
"<\"occurrences\">, ",
"LiteralC",
"<\"timeslices\">]>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.calendarAlignedTimeWindowSchema",
"type": "Object",
"tags": [],
"label": "calendarAlignedTimeWindowSchema",
"description": [],
"signature": [
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"calendarAligned\">; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/time_window.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.calendarAlignedTimeWindowTypeSchema",
"type": "Object",
"tags": [],
"label": "calendarAlignedTimeWindowTypeSchema",
"description": [],
"signature": [
"LiteralC",
"<\"calendarAligned\">"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/time_window.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.compositeSloIdSchema",
"type": "Object",
"tags": [],
"label": "compositeSloIdSchema",
"description": [],
"signature": [
"StringC"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/composite_slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.compositeSLOResponseSchema",
"type": "Object",
"tags": [],
"label": "compositeSLOResponseSchema",
"description": [],
"signature": [
"TypeC",
"<{ id: ",
"StringC",
"; name: ",
"StringC",
"; timeWindow: ",
"UnionC",
"<[",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"rolling\">; }>, ",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"calendarAligned\">; }>]>; budgetingMethod: ",
"UnionC",
"<[",
"LiteralC",
"<\"occurrences\">, ",
"LiteralC",
"<\"timeslices\">]>; objective: ",
"IntersectionC",
"<[",
"TypeC",
"<{ target: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ timesliceTarget: ",
"NumberC",
"; timesliceWindow: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>]>; compositeMethod: ",
"LiteralC",
"<\"weightedAverage\">; sources: ",
"ArrayC",
"<",
"TypeC",
"<{ id: ",
"StringC",
"; revision: ",
"NumberC",
"; weight: ",
"NumberC",
"; }>>; tags: ",
"ArrayC",
"<",
"StringC",
">; createdAt: ",
"Type",
"<Date, string, unknown>; updatedAt: ",
"Type",
"<Date, string, unknown>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/composite_slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.compositeSloSchema",
"type": "Object",
"tags": [],
"label": "compositeSloSchema",
"description": [],
"signature": [
"TypeC",
"<{ id: ",
"StringC",
"; name: ",
"StringC",
"; timeWindow: ",
"UnionC",
"<[",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"rolling\">; }>, ",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"calendarAligned\">; }>]>; budgetingMethod: ",
"UnionC",
"<[",
"LiteralC",
"<\"occurrences\">, ",
"LiteralC",
"<\"timeslices\">]>; compositeMethod: ",
"LiteralC",
"<\"weightedAverage\">; objective: ",
"IntersectionC",
"<[",
"TypeC",
"<{ target: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ timesliceTarget: ",
"NumberC",
"; timesliceWindow: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>]>; sources: ",
"ArrayC",
"<",
"TypeC",
"<{ id: ",
"StringC",
"; revision: ",
"NumberC",
"; weight: ",
"NumberC",
"; }>>; tags: ",
"ArrayC",
"<",
"StringC",
">; createdAt: ",
"Type",
"<Date, string, unknown>; updatedAt: ",
"Type",
"<Date, string, unknown>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/composite_slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.createCompositeSLOParamsSchema",
"type": "Object",
"tags": [],
"label": "createCompositeSLOParamsSchema",
"description": [],
"signature": [
"TypeC",
"<{ body: ",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; timeWindow: ",
"UnionC",
"<[",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"rolling\">; }>, ",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"calendarAligned\">; }>]>; budgetingMethod: ",
"UnionC",
"<[",
"LiteralC",
"<\"occurrences\">, ",
"LiteralC",
"<\"timeslices\">]>; objective: ",
"IntersectionC",
"<[",
"TypeC",
"<{ target: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ timesliceTarget: ",
"NumberC",
"; timesliceWindow: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>]>; compositeMethod: ",
"LiteralC",
"<\"weightedAverage\">; sources: ",
"ArrayC",
"<",
"TypeC",
"<{ id: ",
"StringC",
"; revision: ",
"NumberC",
"; weight: ",
"NumberC",
"; }>>; }>, ",
"PartialC",
"<{ id: ",
"StringC",
"; tags: ",
"ArrayC",
"<",
"StringC",
">; }>]>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/composite_slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.createSLOParamsSchema",
"type": "Object",
"tags": [],
"label": "createSLOParamsSchema",
"description": [],
"signature": [
"TypeC",
"<{ body: ",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; description: ",
"StringC",
"; indicator: ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.apm.transactionDuration\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ environment: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; service: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionType: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionName: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; threshold: ",
"NumberC",
"; index: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.apm.transactionErrorRate\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ environment: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; service: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionType: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionName: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; index: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.kql.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; good: ",
"StringC",
"; total: ",
"StringC",
"; timestampField: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.metric.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; good: ",
"TypeC",
"<{ metrics: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; aggregation: ",
"KeyofC",
"<{ sum: boolean; }>; field: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>>; equation: ",
"StringC",
"; }>; total: ",
"TypeC",
"<{ metrics: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; aggregation: ",
"KeyofC",
"<{ sum: boolean; }>; field: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>>; equation: ",
"StringC",
"; }>; timestampField: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.histogram.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; timestampField: ",
"StringC",
"; good: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"value_count\">; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"range\">; from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>]>; total: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"value_count\">; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"range\">; from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>]>; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>]>; timeWindow: ",
"UnionC",
"<[",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"rolling\">; }>, ",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"calendarAligned\">; }>]>; budgetingMethod: ",
"UnionC",
"<[",
"LiteralC",
"<\"occurrences\">, ",
"LiteralC",
"<\"timeslices\">]>; objective: ",
"IntersectionC",
"<[",
"TypeC",
"<{ target: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ timesliceTarget: ",
"NumberC",
"; timesliceWindow: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>]>; }>, ",
"PartialC",
"<{ id: ",
"StringC",
"; settings: ",
"PartialC",
"<{ syncDelay: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; frequency: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>; tags: ",
"ArrayC",
"<",
"StringC",
">; groupBy: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; }>]>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.dateRangeSchema",
"type": "Object",
"tags": [],
"label": "dateRangeSchema",
"description": [],
"signature": [
"TypeC",
"<{ from: ",
"Type",
"<Date, string, unknown>; to: ",
"Type",
"<Date, string, unknown>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/common.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.dateType",
"type": "Object",
"tags": [],
"label": "dateType",
"description": [],
"signature": [
"Type",
"<Date, string, unknown>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/common.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.deleteCompositeSLOParamsSchema",
"type": "Object",
"tags": [],
"label": "deleteCompositeSLOParamsSchema",
"description": [],
"signature": [
"TypeC",
"<{ path: ",
"TypeC",
"<{ id: ",
"StringC",
"; }>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/composite_slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.deleteSLOInstancesParamsSchema",
"type": "Object",
"tags": [],
"label": "deleteSLOInstancesParamsSchema",
"description": [],
"signature": [
"TypeC",
"<{ body: ",
"TypeC",
"<{ list: ",
"ArrayC",
"<",
"TypeC",
"<{ sloId: ",
"StringC",
"; instanceId: ",
"StringC",
"; }>>; }>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.deleteSLOParamsSchema",
"type": "Object",
"tags": [],
"label": "deleteSLOParamsSchema",
"description": [],
"signature": [
"TypeC",
"<{ path: ",
"TypeC",
"<{ id: ",
"StringC",
"; }>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.durationType",
"type": "Object",
"tags": [],
"label": "durationType",
"description": [],
"signature": [
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/duration.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.errorBudgetSchema",
"type": "Object",
"tags": [],
"label": "errorBudgetSchema",
"description": [],
"signature": [
"TypeC",
"<{ initial: ",
"NumberC",
"; consumed: ",
"NumberC",
"; remaining: ",
"NumberC",
"; isEstimated: ",
"BooleanC",
"; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/common.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.fetchHistoricalSummaryParamsSchema",
"type": "Object",
"tags": [],
"label": "fetchHistoricalSummaryParamsSchema",
"description": [],
"signature": [
"TypeC",
"<{ body: ",
"TypeC",
"<{ list: ",
"ArrayC",
"<",
"TypeC",
"<{ sloId: ",
"StringC",
"; instanceId: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; }>>; }>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.fetchHistoricalSummaryResponseSchema",
"type": "Object",
"tags": [],
"label": "fetchHistoricalSummaryResponseSchema",
"description": [],
"signature": [
"ArrayC",
"<",
"TypeC",
"<{ sloId: ",
"StringC",
"; instanceId: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; data: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ date: ",
"Type",
"<Date, string, unknown>; }>, ",
"TypeC",
"<{ status: ",
"UnionC",
"<[",
"LiteralC",
"<\"NO_DATA\">, ",
"LiteralC",
"<\"HEALTHY\">, ",
"LiteralC",
"<\"DEGRADING\">, ",
"LiteralC",
"<\"VIOLATED\">]>; sliValue: ",
"NumberC",
"; errorBudget: ",
"TypeC",
"<{ initial: ",
"NumberC",
"; consumed: ",
"NumberC",
"; remaining: ",
"NumberC",
"; isEstimated: ",
"BooleanC",
"; }>; }>]>>; }>>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.findCompositeSLOParamsSchema",
"type": "Object",
"tags": [],
"label": "findCompositeSLOParamsSchema",
"description": [],
"signature": [
"PartialC",
"<{ query: ",
"PartialC",
"<{ name: ",
"StringC",
"; page: ",
"StringC",
"; perPage: ",
"StringC",
"; sortBy: ",
"LiteralC",
"<\"creationTime\">; sortDirection: ",
"UnionC",
"<[",
"LiteralC",
"<\"asc\">, ",
"LiteralC",
"<\"desc\">]>; }>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/composite_slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.findCompositeSLOResponseSchema",
"type": "Object",
"tags": [],
"label": "findCompositeSLOResponseSchema",
"description": [],
"signature": [
"TypeC",
"<{ page: ",
"NumberC",
"; perPage: ",
"NumberC",
"; total: ",
"NumberC",
"; results: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; name: ",
"StringC",
"; timeWindow: ",
"UnionC",
"<[",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"rolling\">; }>, ",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"calendarAligned\">; }>]>; budgetingMethod: ",
"UnionC",
"<[",
"LiteralC",
"<\"occurrences\">, ",
"LiteralC",
"<\"timeslices\">]>; objective: ",
"IntersectionC",
"<[",
"TypeC",
"<{ target: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ timesliceTarget: ",
"NumberC",
"; timesliceWindow: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>]>; compositeMethod: ",
"LiteralC",
"<\"weightedAverage\">; sources: ",
"ArrayC",
"<",
"TypeC",
"<{ id: ",
"StringC",
"; revision: ",
"NumberC",
"; weight: ",
"NumberC",
"; }>>; tags: ",
"ArrayC",
"<",
"StringC",
">; createdAt: ",
"Type",
"<Date, string, unknown>; updatedAt: ",
"Type",
"<Date, string, unknown>; }>, ",
"TypeC",
"<{ summary: ",
"TypeC",
"<{ status: ",
"UnionC",
"<[",
"LiteralC",
"<\"NO_DATA\">, ",
"LiteralC",
"<\"HEALTHY\">, ",
"LiteralC",
"<\"DEGRADING\">, ",
"LiteralC",
"<\"VIOLATED\">]>; sliValue: ",
"NumberC",
"; errorBudget: ",
"TypeC",
"<{ initial: ",
"NumberC",
"; consumed: ",
"NumberC",
"; remaining: ",
"NumberC",
"; isEstimated: ",
"BooleanC",
"; }>; }>; }>]>>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/composite_slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.findSloDefinitionsParamsSchema",
"type": "Object",
"tags": [
"private"
],
"label": "findSloDefinitionsParamsSchema",
"description": [
"\nThe query params schema for /internal/observability/slo/_definitions\n"
],
"signature": [
"TypeC",
"<{ query: ",
"TypeC",
"<{ search: ",
"StringC",
"; }>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.findSloDefinitionsResponseSchema",
"type": "Object",
"tags": [
"private"
],
"label": "findSloDefinitionsResponseSchema",
"description": [
"\nThe response schema for /internal/observability/slo/_definitions\n"
],
"signature": [
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; name: ",
"StringC",
"; description: ",
"StringC",
"; indicator: ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.apm.transactionDuration\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ environment: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; service: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionType: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionName: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; threshold: ",
"NumberC",
"; index: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.apm.transactionErrorRate\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ environment: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; service: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionType: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionName: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; index: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.kql.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; good: ",
"StringC",
"; total: ",
"StringC",
"; timestampField: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.metric.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; good: ",
"TypeC",
"<{ metrics: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; aggregation: ",
"KeyofC",
"<{ sum: boolean; }>; field: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>>; equation: ",
"StringC",
"; }>; total: ",
"TypeC",
"<{ metrics: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; aggregation: ",
"KeyofC",
"<{ sum: boolean; }>; field: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>>; equation: ",
"StringC",
"; }>; timestampField: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.histogram.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; timestampField: ",
"StringC",
"; good: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"value_count\">; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"range\">; from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>]>; total: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"value_count\">; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"range\">; from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>]>; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>]>; timeWindow: ",
"UnionC",
"<[",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"rolling\">; }>, ",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"calendarAligned\">; }>]>; budgetingMethod: ",
"UnionC",
"<[",
"LiteralC",
"<\"occurrences\">, ",
"LiteralC",
"<\"timeslices\">]>; objective: ",
"IntersectionC",
"<[",
"TypeC",
"<{ target: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ timesliceTarget: ",
"NumberC",
"; timesliceWindow: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>]>; revision: ",
"NumberC",
"; settings: ",
"TypeC",
"<{ syncDelay: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; frequency: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>; enabled: ",
"BooleanC",
"; tags: ",
"ArrayC",
"<",
"StringC",
">; groupBy: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; createdAt: ",
"Type",
"<Date, string, unknown>; updatedAt: ",
"Type",
"<Date, string, unknown>; }>, ",
"PartialC",
"<{ instanceId: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; }>]>>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.findSLOParamsSchema",
"type": "Object",
"tags": [],
"label": "findSLOParamsSchema",
"description": [],
"signature": [
"PartialC",
"<{ query: ",
"PartialC",
"<{ kqlQuery: ",
"StringC",
"; page: ",
"StringC",
"; perPage: ",
"StringC",
"; sortBy: ",
"UnionC",
"<[",
"LiteralC",
"<\"error_budget_consumed\">, ",
"LiteralC",
"<\"error_budget_remaining\">, ",
"LiteralC",
"<\"sli_value\">, ",
"LiteralC",
"<\"status\">]>; sortDirection: ",
"UnionC",
"<[",
"LiteralC",
"<\"asc\">, ",
"LiteralC",
"<\"desc\">]>; }>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.findSLOResponseSchema",
"type": "Object",
"tags": [],
"label": "findSLOResponseSchema",
"description": [],
"signature": [
"TypeC",
"<{ page: ",
"NumberC",
"; perPage: ",
"NumberC",
"; total: ",
"NumberC",
"; results: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; name: ",
"StringC",
"; description: ",
"StringC",
"; indicator: ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.apm.transactionDuration\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ environment: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; service: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionType: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionName: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; threshold: ",
"NumberC",
"; index: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.apm.transactionErrorRate\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ environment: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; service: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionType: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionName: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; index: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.kql.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; good: ",
"StringC",
"; total: ",
"StringC",
"; timestampField: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.metric.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; good: ",
"TypeC",
"<{ metrics: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; aggregation: ",
"KeyofC",
"<{ sum: boolean; }>; field: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>>; equation: ",
"StringC",
"; }>; total: ",
"TypeC",
"<{ metrics: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; aggregation: ",
"KeyofC",
"<{ sum: boolean; }>; field: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>>; equation: ",
"StringC",
"; }>; timestampField: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.histogram.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; timestampField: ",
"StringC",
"; good: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"value_count\">; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"range\">; from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>]>; total: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"value_count\">; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"range\">; from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>]>; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>]>; timeWindow: ",
"UnionC",
"<[",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"rolling\">; }>, ",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"calendarAligned\">; }>]>; budgetingMethod: ",
"UnionC",
"<[",
"LiteralC",
"<\"occurrences\">, ",
"LiteralC",
"<\"timeslices\">]>; objective: ",
"IntersectionC",
"<[",
"TypeC",
"<{ target: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ timesliceTarget: ",
"NumberC",
"; timesliceWindow: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>]>; revision: ",
"NumberC",
"; settings: ",
"TypeC",
"<{ syncDelay: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; frequency: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>; enabled: ",
"BooleanC",
"; tags: ",
"ArrayC",
"<",
"StringC",
">; groupBy: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; createdAt: ",
"Type",
"<Date, string, unknown>; updatedAt: ",
"Type",
"<Date, string, unknown>; }>, ",
"PartialC",
"<{ instanceId: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; }>]>, ",
"TypeC",
"<{ summary: ",
"TypeC",
"<{ status: ",
"UnionC",
"<[",
"LiteralC",
"<\"NO_DATA\">, ",
"LiteralC",
"<\"HEALTHY\">, ",
"LiteralC",
"<\"DEGRADING\">, ",
"LiteralC",
"<\"VIOLATED\">]>; sliValue: ",
"NumberC",
"; errorBudget: ",
"TypeC",
"<{ initial: ",
"NumberC",
"; consumed: ",
"NumberC",
"; remaining: ",
"NumberC",
"; isEstimated: ",
"BooleanC",
"; }>; }>; }>]>>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.getCompositeSLOParamsSchema",
"type": "Object",
"tags": [],
"label": "getCompositeSLOParamsSchema",
"description": [],
"signature": [
"TypeC",
"<{ path: ",
"TypeC",
"<{ id: ",
"StringC",
"; }>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/composite_slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.getPreviewDataParamsSchema",
"type": "Object",
"tags": [],
"label": "getPreviewDataParamsSchema",
"description": [],
"signature": [
"TypeC",
"<{ body: ",
"TypeC",
"<{ indicator: ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.apm.transactionDuration\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ environment: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; service: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionType: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionName: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; threshold: ",
"NumberC",
"; index: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.apm.transactionErrorRate\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ environment: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; service: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionType: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionName: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; index: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.kql.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; good: ",
"StringC",
"; total: ",
"StringC",
"; timestampField: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.metric.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; good: ",
"TypeC",
"<{ metrics: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; aggregation: ",
"KeyofC",
"<{ sum: boolean; }>; field: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>>; equation: ",
"StringC",
"; }>; total: ",
"TypeC",
"<{ metrics: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; aggregation: ",
"KeyofC",
"<{ sum: boolean; }>; field: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>>; equation: ",
"StringC",
"; }>; timestampField: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.histogram.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; timestampField: ",
"StringC",
"; good: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"value_count\">; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"range\">; from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>]>; total: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"value_count\">; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"range\">; from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>]>; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>]>; }>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.getPreviewDataResponseSchema",
"type": "Object",
"tags": [],
"label": "getPreviewDataResponseSchema",
"description": [],
"signature": [
"ArrayC",
"<",
"TypeC",
"<{ date: ",
"Type",
"<Date, string, unknown>; sliValue: ",
"NumberC",
"; }>>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.getSLOBurnRatesParamsSchema",
"type": "Object",
"tags": [],
"label": "getSLOBurnRatesParamsSchema",
"description": [],
"signature": [
"TypeC",
"<{ path: ",
"TypeC",
"<{ id: ",
"StringC",
"; }>; body: ",
"TypeC",
"<{ instanceId: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; windows: ",
"ArrayC",
"<",
"TypeC",
"<{ name: ",
"StringC",
"; duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>>; }>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.getSLOBurnRatesResponseSchema",
"type": "Object",
"tags": [],
"label": "getSLOBurnRatesResponseSchema",
"description": [],
"signature": [
"TypeC",
"<{ burnRates: ",
"ArrayC",
"<",
"TypeC",
"<{ name: ",
"StringC",
"; burnRate: ",
"NumberC",
"; sli: ",
"NumberC",
"; }>>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.getSLOInstancesParamsSchema",
"type": "Object",
"tags": [],
"label": "getSLOInstancesParamsSchema",
"description": [],
"signature": [
"TypeC",
"<{ path: ",
"TypeC",
"<{ id: ",
"StringC",
"; }>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.getSLOInstancesResponseSchema",
"type": "Object",
"tags": [],
"label": "getSLOInstancesResponseSchema",
"description": [],
"signature": [
"TypeC",
"<{ groupBy: ",
"StringC",
"; instances: ",
"ArrayC",
"<",
"StringC",
">; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.getSLOParamsSchema",
"type": "Object",
"tags": [],
"label": "getSLOParamsSchema",
"description": [],
"signature": [
"IntersectionC",
"<[",
"TypeC",
"<{ path: ",
"TypeC",
"<{ id: ",
"StringC",
"; }>; }>, ",
"PartialC",
"<{ query: ",
"PartialC",
"<{ instanceId: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; }>; }>]>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.getSLOResponseSchema",
"type": "Object",
"tags": [],
"label": "getSLOResponseSchema",
"description": [],
"signature": [
"IntersectionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; name: ",
"StringC",
"; description: ",
"StringC",
"; indicator: ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.apm.transactionDuration\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ environment: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; service: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionType: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionName: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; threshold: ",
"NumberC",
"; index: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.apm.transactionErrorRate\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ environment: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; service: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionType: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionName: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; index: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.kql.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; good: ",
"StringC",
"; total: ",
"StringC",
"; timestampField: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.metric.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; good: ",
"TypeC",
"<{ metrics: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; aggregation: ",
"KeyofC",
"<{ sum: boolean; }>; field: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>>; equation: ",
"StringC",
"; }>; total: ",
"TypeC",
"<{ metrics: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; aggregation: ",
"KeyofC",
"<{ sum: boolean; }>; field: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>>; equation: ",
"StringC",
"; }>; timestampField: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.histogram.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; timestampField: ",
"StringC",
"; good: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"value_count\">; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"range\">; from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>]>; total: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"value_count\">; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"range\">; from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>]>; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>]>; timeWindow: ",
"UnionC",
"<[",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"rolling\">; }>, ",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"calendarAligned\">; }>]>; budgetingMethod: ",
"UnionC",
"<[",
"LiteralC",
"<\"occurrences\">, ",
"LiteralC",
"<\"timeslices\">]>; objective: ",
"IntersectionC",
"<[",
"TypeC",
"<{ target: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ timesliceTarget: ",
"NumberC",
"; timesliceWindow: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>]>; revision: ",
"NumberC",
"; settings: ",
"TypeC",
"<{ syncDelay: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; frequency: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>; enabled: ",
"BooleanC",
"; tags: ",
"ArrayC",
"<",
"StringC",
">; groupBy: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; createdAt: ",
"Type",
"<Date, string, unknown>; updatedAt: ",
"Type",
"<Date, string, unknown>; }>, ",
"PartialC",
"<{ instanceId: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; }>]>, ",
"TypeC",
"<{ summary: ",
"TypeC",
"<{ status: ",
"UnionC",
"<[",
"LiteralC",
"<\"NO_DATA\">, ",
"LiteralC",
"<\"HEALTHY\">, ",
"LiteralC",
"<\"DEGRADING\">, ",
"LiteralC",
"<\"VIOLATED\">]>; sliValue: ",
"NumberC",
"; errorBudget: ",
"TypeC",
"<{ initial: ",
"NumberC",
"; consumed: ",
"NumberC",
"; remaining: ",
"NumberC",
"; isEstimated: ",
"BooleanC",
"; }>; }>; }>]>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.histogramIndicatorSchema",
"type": "Object",
"tags": [],
"label": "histogramIndicatorSchema",
"description": [],
"signature": [
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.histogram.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; timestampField: ",
"StringC",
"; good: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"value_count\">; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"range\">; from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>]>; total: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"value_count\">; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"range\">; from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>]>; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/indicators.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.histogramIndicatorTypeSchema",
"type": "Object",
"tags": [],
"label": "histogramIndicatorTypeSchema",
"description": [],
"signature": [
"LiteralC",
"<\"sli.histogram.custom\">"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/indicators.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.historicalSummarySchema",
"type": "Object",
"tags": [],
"label": "historicalSummarySchema",
"description": [],
"signature": [
"IntersectionC",
"<[",
"TypeC",
"<{ date: ",
"Type",
"<Date, string, unknown>; }>, ",
"TypeC",
"<{ status: ",
"UnionC",
"<[",
"LiteralC",
"<\"NO_DATA\">, ",
"LiteralC",
"<\"HEALTHY\">, ",
"LiteralC",
"<\"DEGRADING\">, ",
"LiteralC",
"<\"VIOLATED\">]>; sliValue: ",
"NumberC",
"; errorBudget: ",
"TypeC",
"<{ initial: ",
"NumberC",
"; consumed: ",
"NumberC",
"; remaining: ",
"NumberC",
"; isEstimated: ",
"BooleanC",
"; }>; }>]>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/common.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.indicatorDataSchema",
"type": "Object",
"tags": [],
"label": "indicatorDataSchema",
"description": [],
"signature": [
"TypeC",
"<{ dateRange: ",
"TypeC",
"<{ from: ",
"Type",
"<Date, string, unknown>; to: ",
"Type",
"<Date, string, unknown>; }>; good: ",
"NumberC",
"; total: ",
"NumberC",
"; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/indicators.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.indicatorSchema",
"type": "Object",
"tags": [],
"label": "indicatorSchema",
"description": [],
"signature": [
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.apm.transactionDuration\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ environment: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; service: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionType: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionName: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; threshold: ",
"NumberC",
"; index: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.apm.transactionErrorRate\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ environment: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; service: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionType: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionName: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; index: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.kql.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; good: ",
"StringC",
"; total: ",
"StringC",
"; timestampField: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.metric.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; good: ",
"TypeC",
"<{ metrics: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; aggregation: ",
"KeyofC",
"<{ sum: boolean; }>; field: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>>; equation: ",
"StringC",
"; }>; total: ",
"TypeC",
"<{ metrics: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; aggregation: ",
"KeyofC",
"<{ sum: boolean; }>; field: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>>; equation: ",
"StringC",
"; }>; timestampField: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.histogram.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; timestampField: ",
"StringC",
"; good: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"value_count\">; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"range\">; from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>]>; total: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"value_count\">; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"range\">; from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>]>; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>]>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/indicators.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.indicatorTypesArraySchema",
"type": "Object",
"tags": [],
"label": "indicatorTypesArraySchema",
"description": [],
"signature": [
"Type",
"<string[], string, unknown>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/indicators.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.indicatorTypesSchema",
"type": "Object",
"tags": [],
"label": "indicatorTypesSchema",
"description": [],
"signature": [
"UnionC",
"<[",
"LiteralC",
"<\"sli.apm.transactionDuration\">, ",
"LiteralC",
"<\"sli.apm.transactionErrorRate\">, ",
"LiteralC",
"<\"sli.kql.custom\">, ",
"LiteralC",
"<\"sli.metric.custom\">, ",
"LiteralC",
"<\"sli.histogram.custom\">]>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/indicators.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.kqlCustomIndicatorSchema",
"type": "Object",
"tags": [],
"label": "kqlCustomIndicatorSchema",
"description": [],
"signature": [
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.kql.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; good: ",
"StringC",
"; total: ",
"StringC",
"; timestampField: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/indicators.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.kqlCustomIndicatorTypeSchema",
"type": "Object",
"tags": [],
"label": "kqlCustomIndicatorTypeSchema",
"description": [],
"signature": [
"LiteralC",
"<\"sli.kql.custom\">"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/indicators.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.manageSLOParamsSchema",
"type": "Object",
"tags": [],
"label": "manageSLOParamsSchema",
"description": [],
"signature": [
"TypeC",
"<{ path: ",
"TypeC",
"<{ id: ",
"StringC",
"; }>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.metricCustomIndicatorSchema",
"type": "Object",
"tags": [],
"label": "metricCustomIndicatorSchema",
"description": [],
"signature": [
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.metric.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; good: ",
"TypeC",
"<{ metrics: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; aggregation: ",
"KeyofC",
"<{ sum: boolean; }>; field: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>>; equation: ",
"StringC",
"; }>; total: ",
"TypeC",
"<{ metrics: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; aggregation: ",
"KeyofC",
"<{ sum: boolean; }>; field: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>>; equation: ",
"StringC",
"; }>; timestampField: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/indicators.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.metricCustomIndicatorTypeSchema",
"type": "Object",
"tags": [],
"label": "metricCustomIndicatorTypeSchema",
"description": [],
"signature": [
"LiteralC",
"<\"sli.metric.custom\">"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/indicators.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.objectiveSchema",
"type": "Object",
"tags": [],
"label": "objectiveSchema",
"description": [],
"signature": [
"IntersectionC",
"<[",
"TypeC",
"<{ target: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ timesliceTarget: ",
"NumberC",
"; timesliceWindow: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>]>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.occurrencesBudgetingMethodSchema",
"type": "Object",
"tags": [],
"label": "occurrencesBudgetingMethodSchema",
"description": [],
"signature": [
"LiteralC",
"<\"occurrences\">"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.optionalSettingsSchema",
"type": "Object",
"tags": [],
"label": "optionalSettingsSchema",
"description": [],
"signature": [
"PartialC",
"<{ syncDelay: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; frequency: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.previewDataSchema",
"type": "Object",
"tags": [],
"label": "previewDataSchema",
"description": [],
"signature": [
"TypeC",
"<{ date: ",
"Type",
"<Date, string, unknown>; sliValue: ",
"NumberC",
"; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/common.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.rollingTimeWindowSchema",
"type": "Object",
"tags": [],
"label": "rollingTimeWindowSchema",
"description": [],
"signature": [
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"rolling\">; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/time_window.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.rollingTimeWindowTypeSchema",
"type": "Object",
"tags": [],
"label": "rollingTimeWindowTypeSchema",
"description": [],
"signature": [
"LiteralC",
"<\"rolling\">"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/time_window.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.settingsSchema",
"type": "Object",
"tags": [],
"label": "settingsSchema",
"description": [],
"signature": [
"TypeC",
"<{ syncDelay: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; frequency: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.sloIdSchema",
"type": "Object",
"tags": [],
"label": "sloIdSchema",
"description": [],
"signature": [
"StringC"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.sloResponseSchema",
"type": "Object",
"tags": [],
"label": "sloResponseSchema",
"description": [],
"signature": [
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; name: ",
"StringC",
"; description: ",
"StringC",
"; indicator: ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.apm.transactionDuration\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ environment: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; service: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionType: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionName: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; threshold: ",
"NumberC",
"; index: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.apm.transactionErrorRate\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ environment: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; service: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionType: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionName: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; index: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.kql.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; good: ",
"StringC",
"; total: ",
"StringC",
"; timestampField: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.metric.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; good: ",
"TypeC",
"<{ metrics: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; aggregation: ",
"KeyofC",
"<{ sum: boolean; }>; field: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>>; equation: ",
"StringC",
"; }>; total: ",
"TypeC",
"<{ metrics: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; aggregation: ",
"KeyofC",
"<{ sum: boolean; }>; field: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>>; equation: ",
"StringC",
"; }>; timestampField: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.histogram.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; timestampField: ",
"StringC",
"; good: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"value_count\">; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"range\">; from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>]>; total: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"value_count\">; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"range\">; from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>]>; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>]>; timeWindow: ",
"UnionC",
"<[",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"rolling\">; }>, ",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"calendarAligned\">; }>]>; budgetingMethod: ",
"UnionC",
"<[",
"LiteralC",
"<\"occurrences\">, ",
"LiteralC",
"<\"timeslices\">]>; objective: ",
"IntersectionC",
"<[",
"TypeC",
"<{ target: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ timesliceTarget: ",
"NumberC",
"; timesliceWindow: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>]>; revision: ",
"NumberC",
"; settings: ",
"TypeC",
"<{ syncDelay: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; frequency: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>; enabled: ",
"BooleanC",
"; tags: ",
"ArrayC",
"<",
"StringC",
">; groupBy: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; createdAt: ",
"Type",
"<Date, string, unknown>; updatedAt: ",
"Type",
"<Date, string, unknown>; }>, ",
"PartialC",
"<{ instanceId: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; }>]>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.sloSchema",
"type": "Object",
"tags": [],
"label": "sloSchema",
"description": [],
"signature": [
"TypeC",
"<{ id: ",
"StringC",
"; name: ",
"StringC",
"; description: ",
"StringC",
"; indicator: ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.apm.transactionDuration\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ environment: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; service: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionType: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionName: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; threshold: ",
"NumberC",
"; index: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.apm.transactionErrorRate\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ environment: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; service: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionType: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionName: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; index: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.kql.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; good: ",
"StringC",
"; total: ",
"StringC",
"; timestampField: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.metric.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; good: ",
"TypeC",
"<{ metrics: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; aggregation: ",
"KeyofC",
"<{ sum: boolean; }>; field: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>>; equation: ",
"StringC",
"; }>; total: ",
"TypeC",
"<{ metrics: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; aggregation: ",
"KeyofC",
"<{ sum: boolean; }>; field: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>>; equation: ",
"StringC",
"; }>; timestampField: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.histogram.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; timestampField: ",
"StringC",
"; good: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"value_count\">; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"range\">; from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>]>; total: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"value_count\">; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"range\">; from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>]>; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>]>; timeWindow: ",
"UnionC",
"<[",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"rolling\">; }>, ",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"calendarAligned\">; }>]>; budgetingMethod: ",
"UnionC",
"<[",
"LiteralC",
"<\"occurrences\">, ",
"LiteralC",
"<\"timeslices\">]>; objective: ",
"IntersectionC",
"<[",
"TypeC",
"<{ target: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ timesliceTarget: ",
"NumberC",
"; timesliceWindow: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>]>; settings: ",
"TypeC",
"<{ syncDelay: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; frequency: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>; revision: ",
"NumberC",
"; enabled: ",
"BooleanC",
"; tags: ",
"ArrayC",
"<",
"StringC",
">; createdAt: ",
"Type",
"<Date, string, unknown>; updatedAt: ",
"Type",
"<Date, string, unknown>; groupBy: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.sloWithSummaryResponseSchema",
"type": "Object",
"tags": [],
"label": "sloWithSummaryResponseSchema",
"description": [],
"signature": [
"IntersectionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; name: ",
"StringC",
"; description: ",
"StringC",
"; indicator: ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.apm.transactionDuration\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ environment: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; service: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionType: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionName: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; threshold: ",
"NumberC",
"; index: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.apm.transactionErrorRate\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ environment: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; service: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionType: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionName: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; index: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.kql.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; good: ",
"StringC",
"; total: ",
"StringC",
"; timestampField: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.metric.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; good: ",
"TypeC",
"<{ metrics: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; aggregation: ",
"KeyofC",
"<{ sum: boolean; }>; field: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>>; equation: ",
"StringC",
"; }>; total: ",
"TypeC",
"<{ metrics: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; aggregation: ",
"KeyofC",
"<{ sum: boolean; }>; field: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>>; equation: ",
"StringC",
"; }>; timestampField: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.histogram.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; timestampField: ",
"StringC",
"; good: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"value_count\">; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"range\">; from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>]>; total: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"value_count\">; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"range\">; from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>]>; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>]>; timeWindow: ",
"UnionC",
"<[",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"rolling\">; }>, ",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"calendarAligned\">; }>]>; budgetingMethod: ",
"UnionC",
"<[",
"LiteralC",
"<\"occurrences\">, ",
"LiteralC",
"<\"timeslices\">]>; objective: ",
"IntersectionC",
"<[",
"TypeC",
"<{ target: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ timesliceTarget: ",
"NumberC",
"; timesliceWindow: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>]>; revision: ",
"NumberC",
"; settings: ",
"TypeC",
"<{ syncDelay: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; frequency: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>; enabled: ",
"BooleanC",
"; tags: ",
"ArrayC",
"<",
"StringC",
">; groupBy: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; createdAt: ",
"Type",
"<Date, string, unknown>; updatedAt: ",
"Type",
"<Date, string, unknown>; }>, ",
"PartialC",
"<{ instanceId: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; }>]>, ",
"TypeC",
"<{ summary: ",
"TypeC",
"<{ status: ",
"UnionC",
"<[",
"LiteralC",
"<\"NO_DATA\">, ",
"LiteralC",
"<\"HEALTHY\">, ",
"LiteralC",
"<\"DEGRADING\">, ",
"LiteralC",
"<\"VIOLATED\">]>; sliValue: ",
"NumberC",
"; errorBudget: ",
"TypeC",
"<{ initial: ",
"NumberC",
"; consumed: ",
"NumberC",
"; remaining: ",
"NumberC",
"; isEstimated: ",
"BooleanC",
"; }>; }>; }>]>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.sloWithSummarySchema",
"type": "Object",
"tags": [],
"label": "sloWithSummarySchema",
"description": [],
"signature": [
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; name: ",
"StringC",
"; description: ",
"StringC",
"; indicator: ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.apm.transactionDuration\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ environment: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; service: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionType: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionName: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; threshold: ",
"NumberC",
"; index: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.apm.transactionErrorRate\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ environment: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; service: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionType: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionName: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; index: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.kql.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; good: ",
"StringC",
"; total: ",
"StringC",
"; timestampField: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.metric.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; good: ",
"TypeC",
"<{ metrics: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; aggregation: ",
"KeyofC",
"<{ sum: boolean; }>; field: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>>; equation: ",
"StringC",
"; }>; total: ",
"TypeC",
"<{ metrics: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; aggregation: ",
"KeyofC",
"<{ sum: boolean; }>; field: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>>; equation: ",
"StringC",
"; }>; timestampField: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.histogram.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; timestampField: ",
"StringC",
"; good: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"value_count\">; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"range\">; from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>]>; total: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"value_count\">; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"range\">; from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>]>; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>]>; timeWindow: ",
"UnionC",
"<[",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"rolling\">; }>, ",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"calendarAligned\">; }>]>; budgetingMethod: ",
"UnionC",
"<[",
"LiteralC",
"<\"occurrences\">, ",
"LiteralC",
"<\"timeslices\">]>; objective: ",
"IntersectionC",
"<[",
"TypeC",
"<{ target: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ timesliceTarget: ",
"NumberC",
"; timesliceWindow: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>]>; settings: ",
"TypeC",
"<{ syncDelay: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; frequency: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>; revision: ",
"NumberC",
"; enabled: ",
"BooleanC",
"; tags: ",
"ArrayC",
"<",
"StringC",
">; createdAt: ",
"Type",
"<Date, string, unknown>; updatedAt: ",
"Type",
"<Date, string, unknown>; groupBy: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; }>, ",
"TypeC",
"<{ summary: ",
"TypeC",
"<{ status: ",
"UnionC",
"<[",
"LiteralC",
"<\"NO_DATA\">, ",
"LiteralC",
"<\"HEALTHY\">, ",
"LiteralC",
"<\"DEGRADING\">, ",
"LiteralC",
"<\"VIOLATED\">]>; sliValue: ",
"NumberC",
"; errorBudget: ",
"TypeC",
"<{ initial: ",
"NumberC",
"; consumed: ",
"NumberC",
"; remaining: ",
"NumberC",
"; isEstimated: ",
"BooleanC",
"; }>; }>; }>]>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.statusSchema",
"type": "Object",
"tags": [],
"label": "statusSchema",
"description": [],
"signature": [
"UnionC",
"<[",
"LiteralC",
"<\"NO_DATA\">, ",
"LiteralC",
"<\"HEALTHY\">, ",
"LiteralC",
"<\"DEGRADING\">, ",
"LiteralC",
"<\"VIOLATED\">]>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/common.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.summarySchema",
"type": "Object",
"tags": [],
"label": "summarySchema",
"description": [],
"signature": [
"TypeC",
"<{ status: ",
"UnionC",
"<[",
"LiteralC",
"<\"NO_DATA\">, ",
"LiteralC",
"<\"HEALTHY\">, ",
"LiteralC",
"<\"DEGRADING\">, ",
"LiteralC",
"<\"VIOLATED\">]>; sliValue: ",
"NumberC",
"; errorBudget: ",
"TypeC",
"<{ initial: ",
"NumberC",
"; consumed: ",
"NumberC",
"; remaining: ",
"NumberC",
"; isEstimated: ",
"BooleanC",
"; }>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/common.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.tagsSchema",
"type": "Object",
"tags": [],
"label": "tagsSchema",
"description": [],
"signature": [
"ArrayC",
"<",
"StringC",
">"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.targetSchema",
"type": "Object",
"tags": [],
"label": "targetSchema",
"description": [],
"signature": [
"TypeC",
"<{ target: ",
"NumberC",
"; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.timeslicesBudgetingMethodSchema",
"type": "Object",
"tags": [],
"label": "timeslicesBudgetingMethodSchema",
"description": [],
"signature": [
"LiteralC",
"<\"timeslices\">"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.timeWindowSchema",
"type": "Object",
"tags": [],
"label": "timeWindowSchema",
"description": [],
"signature": [
"UnionC",
"<[",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"rolling\">; }>, ",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"calendarAligned\">; }>]>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/time_window.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.timeWindowTypeSchema",
"type": "Object",
"tags": [],
"label": "timeWindowTypeSchema",
"description": [],
"signature": [
"UnionC",
"<[",
"LiteralC",
"<\"rolling\">, ",
"LiteralC",
"<\"calendarAligned\">]>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/time_window.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.updateCompositeSLOParamsSchema",
"type": "Object",
"tags": [],
"label": "updateCompositeSLOParamsSchema",
"description": [],
"signature": [
"TypeC",
"<{ path: ",
"TypeC",
"<{ id: ",
"StringC",
"; }>; body: ",
"PartialC",
"<{ name: ",
"StringC",
"; compositeMethod: ",
"LiteralC",
"<\"weightedAverage\">; sources: ",
"ArrayC",
"<",
"TypeC",
"<{ id: ",
"StringC",
"; revision: ",
"NumberC",
"; weight: ",
"NumberC",
"; }>>; timeWindow: ",
"UnionC",
"<[",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"rolling\">; }>, ",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"calendarAligned\">; }>]>; budgetingMethod: ",
"UnionC",
"<[",
"LiteralC",
"<\"occurrences\">, ",
"LiteralC",
"<\"timeslices\">]>; objective: ",
"IntersectionC",
"<[",
"TypeC",
"<{ target: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ timesliceTarget: ",
"NumberC",
"; timesliceWindow: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>]>; tags: ",
"ArrayC",
"<",
"StringC",
">; }>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/composite_slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.updateCompositeSLOResponseSchema",
"type": "Object",
"tags": [],
"label": "updateCompositeSLOResponseSchema",
"description": [],
"signature": [
"TypeC",
"<{ id: ",
"StringC",
"; name: ",
"StringC",
"; timeWindow: ",
"UnionC",
"<[",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"rolling\">; }>, ",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"calendarAligned\">; }>]>; budgetingMethod: ",
"UnionC",
"<[",
"LiteralC",
"<\"occurrences\">, ",
"LiteralC",
"<\"timeslices\">]>; objective: ",
"IntersectionC",
"<[",
"TypeC",
"<{ target: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ timesliceTarget: ",
"NumberC",
"; timesliceWindow: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>]>; compositeMethod: ",
"LiteralC",
"<\"weightedAverage\">; sources: ",
"ArrayC",
"<",
"TypeC",
"<{ id: ",
"StringC",
"; revision: ",
"NumberC",
"; weight: ",
"NumberC",
"; }>>; tags: ",
"ArrayC",
"<",
"StringC",
">; createdAt: ",
"Type",
"<Date, string, unknown>; updatedAt: ",
"Type",
"<Date, string, unknown>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/composite_slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.updateSLOParamsSchema",
"type": "Object",
"tags": [],
"label": "updateSLOParamsSchema",
"description": [],
"signature": [
"TypeC",
"<{ path: ",
"TypeC",
"<{ id: ",
"StringC",
"; }>; body: ",
"PartialC",
"<{ name: ",
"StringC",
"; description: ",
"StringC",
"; indicator: ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.apm.transactionDuration\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ environment: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; service: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionType: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionName: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; threshold: ",
"NumberC",
"; index: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.apm.transactionErrorRate\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ environment: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; service: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionType: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionName: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; index: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.kql.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; good: ",
"StringC",
"; total: ",
"StringC",
"; timestampField: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.metric.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; good: ",
"TypeC",
"<{ metrics: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; aggregation: ",
"KeyofC",
"<{ sum: boolean; }>; field: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>>; equation: ",
"StringC",
"; }>; total: ",
"TypeC",
"<{ metrics: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; aggregation: ",
"KeyofC",
"<{ sum: boolean; }>; field: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>>; equation: ",
"StringC",
"; }>; timestampField: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.histogram.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; timestampField: ",
"StringC",
"; good: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"value_count\">; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"range\">; from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>]>; total: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"value_count\">; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"range\">; from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>]>; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>]>; timeWindow: ",
"UnionC",
"<[",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"rolling\">; }>, ",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"calendarAligned\">; }>]>; budgetingMethod: ",
"UnionC",
"<[",
"LiteralC",
"<\"occurrences\">, ",
"LiteralC",
"<\"timeslices\">]>; objective: ",
"IntersectionC",
"<[",
"TypeC",
"<{ target: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ timesliceTarget: ",
"NumberC",
"; timesliceWindow: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>]>; settings: ",
"PartialC",
"<{ syncDelay: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; frequency: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>; tags: ",
"ArrayC",
"<",
"StringC",
">; groupBy: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; }>; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.updateSLOResponseSchema",
"type": "Object",
"tags": [],
"label": "updateSLOResponseSchema",
"description": [],
"signature": [
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; name: ",
"StringC",
"; description: ",
"StringC",
"; indicator: ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.apm.transactionDuration\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ environment: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; service: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionType: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionName: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; threshold: ",
"NumberC",
"; index: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.apm.transactionErrorRate\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ environment: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; service: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionType: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; transactionName: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; index: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.kql.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; good: ",
"StringC",
"; total: ",
"StringC",
"; timestampField: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.metric.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; good: ",
"TypeC",
"<{ metrics: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; aggregation: ",
"KeyofC",
"<{ sum: boolean; }>; field: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>>; equation: ",
"StringC",
"; }>; total: ",
"TypeC",
"<{ metrics: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ name: ",
"StringC",
"; aggregation: ",
"KeyofC",
"<{ sum: boolean; }>; field: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>>; equation: ",
"StringC",
"; }>; timestampField: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"sli.histogram.custom\">; params: ",
"IntersectionC",
"<[",
"TypeC",
"<{ index: ",
"StringC",
"; timestampField: ",
"StringC",
"; good: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"value_count\">; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"range\">; from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>]>; total: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"value_count\">; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ field: ",
"StringC",
"; aggregation: ",
"LiteralC",
"<\"range\">; from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>]>; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; }>]>; }>]>; timeWindow: ",
"UnionC",
"<[",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"rolling\">; }>, ",
"TypeC",
"<{ duration: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; type: ",
"LiteralC",
"<\"calendarAligned\">; }>]>; budgetingMethod: ",
"UnionC",
"<[",
"LiteralC",
"<\"occurrences\">, ",
"LiteralC",
"<\"timeslices\">]>; objective: ",
"IntersectionC",
"<[",
"TypeC",
"<{ target: ",
"NumberC",
"; }>, ",
"PartialC",
"<{ timesliceTarget: ",
"NumberC",
"; timesliceWindow: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>]>; revision: ",
"NumberC",
"; settings: ",
"TypeC",
"<{ syncDelay: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; frequency: ",
"Type",
"<",
{
"pluginId": "@kbn/slo-schema",
"scope": "common",
"docId": "kibKbnSloSchemaPluginApi",
"section": "def-common.Duration",
"text": "Duration"
},
", string, unknown>; }>; enabled: ",
"BooleanC",
"; tags: ",
"ArrayC",
"<",
"StringC",
">; groupBy: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; createdAt: ",
"Type",
"<Date, string, unknown>; updatedAt: ",
"Type",
"<Date, string, unknown>; }>, ",
"PartialC",
"<{ instanceId: ",
"UnionC",
"<[",
"LiteralC",
"<\"*\">, ",
"StringC",
"]>; }>]>"
],
"path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.weightedAverageCompositeMethodSchema",
"type": "Object",
"tags": [],
"label": "weightedAverageCompositeMethodSchema",
"description": [],
"signature": [
"LiteralC",
"<\"weightedAverage\">"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/composite_slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/slo-schema",
"id": "def-common.weightedAverageSourceSchema",
"type": "Object",
"tags": [],
"label": "weightedAverageSourceSchema",
"description": [],
"signature": [
"TypeC",
"<{ id: ",
"StringC",
"; revision: ",
"NumberC",
"; weight: ",
"NumberC",
"; }>"
],
"path": "x-pack/packages/kbn-slo-schema/src/schema/composite_slo.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
]
}
}