{ "id": "@kbn/entities-schema", "client": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "server": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "common": { "classes": [], "functions": [ { "parentPluginId": "@kbn/entities-schema", "id": "def-common.durationSchemaWithMinimum", "type": "Function", "tags": [], "label": "durationSchemaWithMinimum", "description": [], "signature": [ "(minimumMinutes: number) => Zod.ZodEffects" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/common.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/entities-schema", "id": "def-common.durationSchemaWithMinimum.$1", "type": "number", "tags": [], "label": "minimumMinutes", "description": [], "signature": [ "number" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/common.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.entitiesAliasPattern", "type": "Function", "tags": [], "label": "entitiesAliasPattern", "description": [], "signature": [ "({\n type,\n dataset,\n}: AliasPatternOptions) => `entities-${string}-${TDataset}`" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/patterns.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/entities-schema", "id": "def-common.entitiesAliasPattern.$1", "type": "Object", "tags": [], "label": "{\n type,\n dataset,\n}", "description": [], "signature": [ "AliasPatternOptions" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/patterns.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.entitiesIndexPattern", "type": "Function", "tags": [], "label": "entitiesIndexPattern", "description": [], "signature": [ "({\n schemaVersion,\n dataset,\n definitionId,\n}: IndexPatternOptions) => `.entities.v${number}.${TDataset}.${string}`" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/patterns.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/entities-schema", "id": "def-common.entitiesIndexPattern.$1", "type": "Object", "tags": [], "label": "{\n schemaVersion,\n dataset,\n definitionId,\n}", "description": [], "signature": [ "IndexPatternOptions" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/patterns.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "@kbn/entities-schema", "id": "def-common.EntityV2", "type": "Interface", "tags": [], "label": "EntityV2", "description": [], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/entity.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/entities-schema", "id": "def-common.EntityV2.entity.id", "type": "string", "tags": [], "label": "'entity.id'", "description": [], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/entity.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.EntityV2.entity.type", "type": "string", "tags": [], "label": "'entity.type'", "description": [], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/entity.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.EntityV2.entity.display_name", "type": "string", "tags": [], "label": "'entity.display_name'", "description": [], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/entity.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.EntityV2.entity.last_seen_timestamp", "type": "string", "tags": [], "label": "'entity.last_seen_timestamp'", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/entity.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.EntityV2.Unnamed", "type": "IndexSignature", "tags": [], "label": "[metadata: string]: any", "description": [], "signature": [ "[metadata: string]: any" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/entity.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.MetadataRecord", "type": "Interface", "tags": [], "label": "MetadataRecord", "description": [], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/entity.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/entities-schema", "id": "def-common.MetadataRecord.Unnamed", "type": "IndexSignature", "tags": [], "label": "[key: string]: string | string[] | MetadataRecord", "description": [], "signature": [ "[key: string]: string | string[] | ", { "pluginId": "@kbn/entities-schema", "scope": "common", "docId": "kibKbnEntitiesSchemaPluginApi", "section": "def-common.MetadataRecord", "text": "MetadataRecord" } ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/entity.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [ { "parentPluginId": "@kbn/entities-schema", "id": "def-common.BasicAggregations", "type": "Enum", "tags": [], "label": "BasicAggregations", "description": [], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "misc": [ { "parentPluginId": "@kbn/entities-schema", "id": "def-common.ENTITY_BASE_PREFIX", "type": "string", "tags": [], "label": "ENTITY_BASE_PREFIX", "description": [], "signature": [ "\"entities\"" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/patterns.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.ENTITY_HISTORY", "type": "string", "tags": [], "label": "ENTITY_HISTORY", "description": [], "signature": [ "\"history\"" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/patterns.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.ENTITY_LATEST", "type": "string", "tags": [], "label": "ENTITY_LATEST", "description": [], "signature": [ "\"latest\"" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/patterns.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.ENTITY_SCHEMA_VERSION_V1", "type": "string", "tags": [], "label": "ENTITY_SCHEMA_VERSION_V1", "description": [], "signature": [ "\"v1\"" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/patterns.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.EntityDefinition", "type": "Type", "tags": [], "label": "EntityDefinition", "description": [], "signature": [ "{ id: string; type: string; version: string; name: string; managed: boolean; indexPatterns: string[]; identityFields: ({ field: string; optional: false; } | { field: string; optional: boolean; })[]; displayNameTemplate: string; latest: { lookbackPeriod: string; timestampField: string; settings?: { frequency?: string | undefined; timeout?: string | undefined; syncField?: string | undefined; syncDelay?: string | undefined; docsPerSecond?: number | undefined; } | undefined; }; filter?: string | undefined; description?: string | undefined; metrics?: { name: string; metrics: ({ name: string; field: string; aggregation: ", { "pluginId": "@kbn/entities-schema", "scope": "common", "docId": "kibKbnEntitiesSchemaPluginApi", "section": "def-common.BasicAggregations", "text": "BasicAggregations" }, "; filter?: string | undefined; } | { name: string; aggregation: \"doc_count\"; filter?: string | undefined; } | { name: string; field: string; percentile: number; aggregation: \"percentile\"; filter?: string | undefined; })[]; equation: string; }[] | undefined; metadata?: ({ destination: string; source: string; aggregation: { type: \"terms\"; limit: number; lookbackPeriod?: string | undefined; } | { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; }; } | { destination: string; source: string; aggregation: { type: \"terms\"; limit: number; lookbackPeriod: undefined; }; })[] | undefined; staticFields?: Record | undefined; installStatus?: \"failed\" | \"installing\" | \"upgrading\" | \"installed\" | undefined; installStartedAt?: string | undefined; installedComponents?: { id: string; type: \"transform\" | \"template\" | \"ingest_pipeline\"; }[] | undefined; }" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/entity_definition.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.EntityDefinitionUpdate", "type": "Type", "tags": [], "label": "EntityDefinitionUpdate", "description": [], "signature": [ "{ version: string; type?: string | undefined; filter?: string | undefined; name?: string | undefined; description?: string | undefined; metrics?: { name: string; metrics: ({ name: string; field: string; aggregation: ", { "pluginId": "@kbn/entities-schema", "scope": "common", "docId": "kibKbnEntitiesSchemaPluginApi", "section": "def-common.BasicAggregations", "text": "BasicAggregations" }, "; filter?: string | undefined; } | { name: string; aggregation: \"doc_count\"; filter?: string | undefined; } | { name: string; field: string; percentile: number; aggregation: \"percentile\"; filter?: string | undefined; })[]; equation: string; }[] | undefined; indexPatterns?: string[] | undefined; metadata?: ({ destination: string; source: string; aggregation: { type: \"terms\"; limit: number; lookbackPeriod?: string | undefined; } | { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; }; } | { destination: string; source: string; aggregation: { type: \"terms\"; limit: number; lookbackPeriod: undefined; }; })[] | undefined; identityFields?: ({ field: string; optional: false; } | { field: string; optional: boolean; })[] | undefined; displayNameTemplate?: string | undefined; staticFields?: Record | undefined; latest?: { settings?: { frequency?: string | undefined; timeout?: string | undefined; syncField?: string | undefined; syncDelay?: string | undefined; docsPerSecond?: number | undefined; } | undefined; lookbackPeriod?: string | undefined; timestampField?: string | undefined; } | undefined; installedComponents?: { id: string; type: \"transform\" | \"template\" | \"ingest_pipeline\"; }[] | undefined; }" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/entity_definition.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.EntityInstance", "type": "Type", "tags": [], "label": "EntityInstance", "description": [], "signature": [ "{ entity: { id: string; type: string; schema_version: string; identity_fields: string | string[]; display_name: string; definition_id: string; definition_version: string; last_seen_timestamp: string; metrics?: Record | undefined; }; } & Metadata" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/entity.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.EntityMetadata", "type": "Type", "tags": [], "label": "EntityMetadata", "description": [], "signature": [ "Metadata" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/entity.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.GetEntityDefinitionQuerySchema", "type": "Type", "tags": [], "label": "GetEntityDefinitionQuerySchema", "description": [], "signature": [ "{ page?: number | undefined; perPage?: number | undefined; includeState?: any; }" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/rest_spec/get.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.KeyMetric", "type": "Type", "tags": [], "label": "KeyMetric", "description": [], "signature": [ "{ name: string; metrics: ({ name: string; field: string; aggregation: ", { "pluginId": "@kbn/entities-schema", "scope": "common", "docId": "kibKbnEntitiesSchemaPluginApi", "section": "def-common.BasicAggregations", "text": "BasicAggregations" }, "; filter?: string | undefined; } | { name: string; aggregation: \"doc_count\"; filter?: string | undefined; } | { name: string; field: string; percentile: number; aggregation: \"percentile\"; filter?: string | undefined; })[]; equation: string; }" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.MetadataField", "type": "Type", "tags": [], "label": "MetadataField", "description": [], "signature": [ "{ destination: string; source: string; aggregation: { type: \"terms\"; limit: number; lookbackPeriod?: string | undefined; } | { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; }; } | { destination: string; source: string; aggregation: { type: \"terms\"; limit: number; lookbackPeriod: undefined; }; }" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.Metric", "type": "Type", "tags": [], "label": "Metric", "description": [], "signature": [ "{ name: string; field: string; aggregation: ", { "pluginId": "@kbn/entities-schema", "scope": "common", "docId": "kibKbnEntitiesSchemaPluginApi", "section": "def-common.BasicAggregations", "text": "BasicAggregations" }, "; filter?: string | undefined; } | { name: string; aggregation: \"doc_count\"; filter?: string | undefined; } | { name: string; field: string; percentile: number; aggregation: \"percentile\"; filter?: string | undefined; }" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [ { "parentPluginId": "@kbn/entities-schema", "id": "def-common.arrayOfStringsSchema", "type": "Object", "tags": [], "label": "arrayOfStringsSchema", "description": [], "signature": [ "Zod.ZodArray" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.basicAggregationsSchema", "type": "Object", "tags": [], "label": "basicAggregationsSchema", "description": [], "signature": [ "Zod.ZodNativeEnum" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.basicMetricWithFieldSchema", "type": "Object", "tags": [], "label": "basicMetricWithFieldSchema", "description": [], "signature": [ "Zod.ZodObject<{ name: Zod.ZodString; aggregation: Zod.ZodNativeEnum; field: Zod.ZodString; filter: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { name: string; field: string; aggregation: ", { "pluginId": "@kbn/entities-schema", "scope": "common", "docId": "kibKbnEntitiesSchemaPluginApi", "section": "def-common.BasicAggregations", "text": "BasicAggregations" }, "; filter?: string | undefined; }, { name: string; field: string; aggregation: ", { "pluginId": "@kbn/entities-schema", "scope": "common", "docId": "kibKbnEntitiesSchemaPluginApi", "section": "def-common.BasicAggregations", "text": "BasicAggregations" }, "; filter?: string | undefined; }>" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.createEntityDefinitionQuerySchema", "type": "Object", "tags": [], "label": "createEntityDefinitionQuerySchema", "description": [], "signature": [ "Zod.ZodObject<{ installOnly: Zod.ZodDefault>; }, \"strip\", Zod.ZodTypeAny, { installOnly?: any; }, { installOnly?: any; }>" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/rest_spec/create.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.deleteEntityDefinitionParamsSchema", "type": "Object", "tags": [], "label": "deleteEntityDefinitionParamsSchema", "description": [], "signature": [ "Zod.ZodObject<{ id: Zod.ZodString; }, \"strip\", Zod.ZodTypeAny, { id: string; }, { id: string; }>" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/rest_spec/delete.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.deleteEntityDefinitionQuerySchema", "type": "Object", "tags": [], "label": "deleteEntityDefinitionQuerySchema", "description": [], "signature": [ "Zod.ZodObject<{ deleteData: Zod.ZodDefault>; }, \"strip\", Zod.ZodTypeAny, { deleteData?: any; }, { deleteData?: any; }>" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/rest_spec/delete.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.docCountMetricSchema", "type": "Object", "tags": [], "label": "docCountMetricSchema", "description": [], "signature": [ "Zod.ZodObject<{ name: Zod.ZodString; aggregation: Zod.ZodLiteral<\"doc_count\">; filter: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { name: string; aggregation: \"doc_count\"; filter?: string | undefined; }, { name: string; aggregation: \"doc_count\"; filter?: string | undefined; }>" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.durationSchema", "type": "Object", "tags": [], "label": "durationSchema", "description": [], "signature": [ "Zod.ZodString" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.entityBaseSchema", "type": "Object", "tags": [], "label": "entityBaseSchema", "description": [], "signature": [ "Zod.ZodObject<{ id: Zod.ZodString; type: Zod.ZodString; identity_fields: Zod.ZodUnion<[Zod.ZodArray, Zod.ZodString]>; display_name: Zod.ZodString; metrics: Zod.ZodOptional>; definition_version: Zod.ZodString; schema_version: Zod.ZodString; definition_id: Zod.ZodString; }, \"strip\", Zod.ZodTypeAny, { id: string; type: string; schema_version: string; identity_fields: string | string[]; display_name: string; definition_id: string; definition_version: string; metrics?: Record | undefined; }, { id: string; type: string; schema_version: string; identity_fields: string | string[]; display_name: string; definition_id: string; definition_version: string; metrics?: Record | undefined; }>" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/entity.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.entityDefinitionSchema", "type": "Object", "tags": [], "label": "entityDefinitionSchema", "description": [], "signature": [ "Zod.ZodObject<{ id: Zod.ZodString; version: Zod.ZodEffects; name: Zod.ZodString; description: Zod.ZodOptional; type: Zod.ZodString; filter: Zod.ZodOptional; indexPatterns: Zod.ZodArray; identityFields: Zod.ZodArray; }, \"strip\", Zod.ZodTypeAny, { field: string; optional: false; }, { field: string; optional: false; }>, Zod.ZodEffects]>, \"many\">; displayNameTemplate: Zod.ZodString; metadata: Zod.ZodOptional; aggregation: Zod.ZodDefault; limit: Zod.ZodDefault; lookbackPeriod: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { type: \"terms\"; limit: number; lookbackPeriod?: string | undefined; }, { type: \"terms\"; limit?: number | undefined; lookbackPeriod?: string | undefined; }>, Zod.ZodObject<{ type: Zod.ZodLiteral<\"top_value\">; sort: Zod.ZodRecord, Zod.ZodLiteral<\"desc\">]>>; lookbackPeriod: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; }, { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; }>]>>>; }, \"strip\", Zod.ZodTypeAny, { source: string; aggregation: { type: \"terms\"; limit: number; lookbackPeriod?: string | undefined; } | { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; }; destination?: string | undefined; }, { source: string; destination?: string | undefined; aggregation?: { type: \"terms\"; limit?: number | undefined; lookbackPeriod?: string | undefined; } | { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; } | undefined; }>, Zod.ZodEffects]>, { destination: string; source: string; aggregation: { type: \"terms\"; limit: number; lookbackPeriod?: string | undefined; } | { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; }; } | { destination: string; source: string; aggregation: { type: \"terms\"; limit: number; lookbackPeriod: undefined; }; }, string | { source: string; destination?: string | undefined; aggregation?: { type: \"terms\"; limit?: number | undefined; lookbackPeriod?: string | undefined; } | { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; } | undefined; }>, { destination: string; source: string; aggregation: { type: \"terms\"; limit: number; lookbackPeriod?: string | undefined; } | { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; }; } | { destination: string; source: string; aggregation: { type: \"terms\"; limit: number; lookbackPeriod: undefined; }; }, string | { source: string; destination?: string | undefined; aggregation?: { type: \"terms\"; limit?: number | undefined; lookbackPeriod?: string | undefined; } | { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; } | undefined; }>, \"many\">>; metrics: Zod.ZodOptional; field: Zod.ZodString; filter: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { name: string; field: string; aggregation: ", { "pluginId": "@kbn/entities-schema", "scope": "common", "docId": "kibKbnEntitiesSchemaPluginApi", "section": "def-common.BasicAggregations", "text": "BasicAggregations" }, "; filter?: string | undefined; }, { name: string; field: string; aggregation: ", { "pluginId": "@kbn/entities-schema", "scope": "common", "docId": "kibKbnEntitiesSchemaPluginApi", "section": "def-common.BasicAggregations", "text": "BasicAggregations" }, "; filter?: string | undefined; }>, Zod.ZodObject<{ name: Zod.ZodString; aggregation: Zod.ZodLiteral<\"doc_count\">; filter: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { name: string; aggregation: \"doc_count\"; filter?: string | undefined; }, { name: string; aggregation: \"doc_count\"; filter?: string | undefined; }>, Zod.ZodObject<{ name: Zod.ZodString; aggregation: Zod.ZodLiteral<\"percentile\">; field: Zod.ZodString; percentile: Zod.ZodNumber; filter: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { name: string; field: string; percentile: number; aggregation: \"percentile\"; filter?: string | undefined; }, { name: string; field: string; percentile: number; aggregation: \"percentile\"; filter?: string | undefined; }>]>, \"many\">; equation: Zod.ZodString; }, \"strip\", Zod.ZodTypeAny, { name: string; metrics: ({ name: string; field: string; aggregation: ", { "pluginId": "@kbn/entities-schema", "scope": "common", "docId": "kibKbnEntitiesSchemaPluginApi", "section": "def-common.BasicAggregations", "text": "BasicAggregations" }, "; filter?: string | undefined; } | { name: string; aggregation: \"doc_count\"; filter?: string | undefined; } | { name: string; field: string; percentile: number; aggregation: \"percentile\"; filter?: string | undefined; })[]; equation: string; }, { name: string; metrics: ({ name: string; field: string; aggregation: ", { "pluginId": "@kbn/entities-schema", "scope": "common", "docId": "kibKbnEntitiesSchemaPluginApi", "section": "def-common.BasicAggregations", "text": "BasicAggregations" }, "; filter?: string | undefined; } | { name: string; aggregation: \"doc_count\"; filter?: string | undefined; } | { name: string; field: string; percentile: number; aggregation: \"percentile\"; filter?: string | undefined; })[]; equation: string; }>, \"many\">>; staticFields: Zod.ZodOptional>; managed: Zod.ZodDefault>; latest: Zod.ZodObject<{ timestampField: Zod.ZodString; lookbackPeriod: Zod.ZodDefault>; settings: Zod.ZodOptional; syncDelay: Zod.ZodOptional; frequency: Zod.ZodOptional; timeout: Zod.ZodOptional; docsPerSecond: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { frequency?: string | undefined; timeout?: string | undefined; syncField?: string | undefined; syncDelay?: string | undefined; docsPerSecond?: number | undefined; }, { frequency?: string | undefined; timeout?: string | undefined; syncField?: string | undefined; syncDelay?: string | undefined; docsPerSecond?: number | undefined; }>>; }, \"strip\", Zod.ZodTypeAny, { lookbackPeriod: string; timestampField: string; settings?: { frequency?: string | undefined; timeout?: string | undefined; syncField?: string | undefined; syncDelay?: string | undefined; docsPerSecond?: number | undefined; } | undefined; }, { timestampField: string; settings?: { frequency?: string | undefined; timeout?: string | undefined; syncField?: string | undefined; syncDelay?: string | undefined; docsPerSecond?: number | undefined; } | undefined; lookbackPeriod?: string | undefined; }>; installStatus: Zod.ZodOptional, Zod.ZodLiteral<\"upgrading\">, Zod.ZodLiteral<\"installed\">, Zod.ZodLiteral<\"failed\">]>>; installStartedAt: Zod.ZodOptional; installedComponents: Zod.ZodOptional, Zod.ZodLiteral<\"ingest_pipeline\">, Zod.ZodLiteral<\"template\">]>; id: Zod.ZodString; }, \"strip\", Zod.ZodTypeAny, { id: string; type: \"transform\" | \"template\" | \"ingest_pipeline\"; }, { id: string; type: \"transform\" | \"template\" | \"ingest_pipeline\"; }>, \"many\">>; }, \"strip\", Zod.ZodTypeAny, { id: string; type: string; version: string; name: string; managed: boolean; indexPatterns: string[]; identityFields: ({ field: string; optional: false; } | { field: string; optional: boolean; })[]; displayNameTemplate: string; latest: { lookbackPeriod: string; timestampField: string; settings?: { frequency?: string | undefined; timeout?: string | undefined; syncField?: string | undefined; syncDelay?: string | undefined; docsPerSecond?: number | undefined; } | undefined; }; filter?: string | undefined; description?: string | undefined; metrics?: { name: string; metrics: ({ name: string; field: string; aggregation: ", { "pluginId": "@kbn/entities-schema", "scope": "common", "docId": "kibKbnEntitiesSchemaPluginApi", "section": "def-common.BasicAggregations", "text": "BasicAggregations" }, "; filter?: string | undefined; } | { name: string; aggregation: \"doc_count\"; filter?: string | undefined; } | { name: string; field: string; percentile: number; aggregation: \"percentile\"; filter?: string | undefined; })[]; equation: string; }[] | undefined; metadata?: ({ destination: string; source: string; aggregation: { type: \"terms\"; limit: number; lookbackPeriod?: string | undefined; } | { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; }; } | { destination: string; source: string; aggregation: { type: \"terms\"; limit: number; lookbackPeriod: undefined; }; })[] | undefined; staticFields?: Record | undefined; installStatus?: \"failed\" | \"installing\" | \"upgrading\" | \"installed\" | undefined; installStartedAt?: string | undefined; installedComponents?: { id: string; type: \"transform\" | \"template\" | \"ingest_pipeline\"; }[] | undefined; }, { id: string; type: string; version: string; name: string; indexPatterns: string[]; identityFields: (string | { field: string; optional: false; })[]; displayNameTemplate: string; latest: { timestampField: string; settings?: { frequency?: string | undefined; timeout?: string | undefined; syncField?: string | undefined; syncDelay?: string | undefined; docsPerSecond?: number | undefined; } | undefined; lookbackPeriod?: string | undefined; }; filter?: string | undefined; description?: string | undefined; metrics?: { name: string; metrics: ({ name: string; field: string; aggregation: ", { "pluginId": "@kbn/entities-schema", "scope": "common", "docId": "kibKbnEntitiesSchemaPluginApi", "section": "def-common.BasicAggregations", "text": "BasicAggregations" }, "; filter?: string | undefined; } | { name: string; aggregation: \"doc_count\"; filter?: string | undefined; } | { name: string; field: string; percentile: number; aggregation: \"percentile\"; filter?: string | undefined; })[]; equation: string; }[] | undefined; managed?: boolean | undefined; metadata?: (string | { source: string; destination?: string | undefined; aggregation?: { type: \"terms\"; limit?: number | undefined; lookbackPeriod?: string | undefined; } | { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; } | undefined; })[] | undefined; staticFields?: Record | undefined; installStatus?: \"failed\" | \"installing\" | \"upgrading\" | \"installed\" | undefined; installStartedAt?: string | undefined; installedComponents?: { id: string; type: \"transform\" | \"template\" | \"ingest_pipeline\"; }[] | undefined; }>" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/entity_definition.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.entityDefinitionUpdateSchema", "type": "Object", "tags": [], "label": "entityDefinitionUpdateSchema", "description": [], "signature": [ "Zod.ZodObject; filter: Zod.ZodOptional>; version: Zod.ZodOptional>; name: Zod.ZodOptional; description: Zod.ZodOptional>; metrics: Zod.ZodOptional; field: Zod.ZodString; filter: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { name: string; field: string; aggregation: ", { "pluginId": "@kbn/entities-schema", "scope": "common", "docId": "kibKbnEntitiesSchemaPluginApi", "section": "def-common.BasicAggregations", "text": "BasicAggregations" }, "; filter?: string | undefined; }, { name: string; field: string; aggregation: ", { "pluginId": "@kbn/entities-schema", "scope": "common", "docId": "kibKbnEntitiesSchemaPluginApi", "section": "def-common.BasicAggregations", "text": "BasicAggregations" }, "; filter?: string | undefined; }>, Zod.ZodObject<{ name: Zod.ZodString; aggregation: Zod.ZodLiteral<\"doc_count\">; filter: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { name: string; aggregation: \"doc_count\"; filter?: string | undefined; }, { name: string; aggregation: \"doc_count\"; filter?: string | undefined; }>, Zod.ZodObject<{ name: Zod.ZodString; aggregation: Zod.ZodLiteral<\"percentile\">; field: Zod.ZodString; percentile: Zod.ZodNumber; filter: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { name: string; field: string; percentile: number; aggregation: \"percentile\"; filter?: string | undefined; }, { name: string; field: string; percentile: number; aggregation: \"percentile\"; filter?: string | undefined; }>]>, \"many\">; equation: Zod.ZodString; }, \"strip\", Zod.ZodTypeAny, { name: string; metrics: ({ name: string; field: string; aggregation: ", { "pluginId": "@kbn/entities-schema", "scope": "common", "docId": "kibKbnEntitiesSchemaPluginApi", "section": "def-common.BasicAggregations", "text": "BasicAggregations" }, "; filter?: string | undefined; } | { name: string; aggregation: \"doc_count\"; filter?: string | undefined; } | { name: string; field: string; percentile: number; aggregation: \"percentile\"; filter?: string | undefined; })[]; equation: string; }, { name: string; metrics: ({ name: string; field: string; aggregation: ", { "pluginId": "@kbn/entities-schema", "scope": "common", "docId": "kibKbnEntitiesSchemaPluginApi", "section": "def-common.BasicAggregations", "text": "BasicAggregations" }, "; filter?: string | undefined; } | { name: string; aggregation: \"doc_count\"; filter?: string | undefined; } | { name: string; field: string; percentile: number; aggregation: \"percentile\"; filter?: string | undefined; })[]; equation: string; }>, \"many\">>>; indexPatterns: Zod.ZodOptional>; metadata: Zod.ZodOptional; aggregation: Zod.ZodDefault; limit: Zod.ZodDefault; lookbackPeriod: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { type: \"terms\"; limit: number; lookbackPeriod?: string | undefined; }, { type: \"terms\"; limit?: number | undefined; lookbackPeriod?: string | undefined; }>, Zod.ZodObject<{ type: Zod.ZodLiteral<\"top_value\">; sort: Zod.ZodRecord, Zod.ZodLiteral<\"desc\">]>>; lookbackPeriod: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; }, { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; }>]>>>; }, \"strip\", Zod.ZodTypeAny, { source: string; aggregation: { type: \"terms\"; limit: number; lookbackPeriod?: string | undefined; } | { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; }; destination?: string | undefined; }, { source: string; destination?: string | undefined; aggregation?: { type: \"terms\"; limit?: number | undefined; lookbackPeriod?: string | undefined; } | { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; } | undefined; }>, Zod.ZodEffects]>, { destination: string; source: string; aggregation: { type: \"terms\"; limit: number; lookbackPeriod?: string | undefined; } | { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; }; } | { destination: string; source: string; aggregation: { type: \"terms\"; limit: number; lookbackPeriod: undefined; }; }, string | { source: string; destination?: string | undefined; aggregation?: { type: \"terms\"; limit?: number | undefined; lookbackPeriod?: string | undefined; } | { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; } | undefined; }>, { destination: string; source: string; aggregation: { type: \"terms\"; limit: number; lookbackPeriod?: string | undefined; } | { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; }; } | { destination: string; source: string; aggregation: { type: \"terms\"; limit: number; lookbackPeriod: undefined; }; }, string | { source: string; destination?: string | undefined; aggregation?: { type: \"terms\"; limit?: number | undefined; lookbackPeriod?: string | undefined; } | { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; } | undefined; }>, \"many\">>>; identityFields: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { field: string; optional: false; }, { field: string; optional: false; }>, Zod.ZodEffects]>, \"many\">>; displayNameTemplate: Zod.ZodOptional; staticFields: Zod.ZodOptional>>; latest: Zod.ZodOptional>; settings: Zod.ZodOptional; syncDelay: Zod.ZodOptional; frequency: Zod.ZodOptional; timeout: Zod.ZodOptional; docsPerSecond: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { frequency?: string | undefined; timeout?: string | undefined; syncField?: string | undefined; syncDelay?: string | undefined; docsPerSecond?: number | undefined; }, { frequency?: string | undefined; timeout?: string | undefined; syncField?: string | undefined; syncDelay?: string | undefined; docsPerSecond?: number | undefined; }>>; }, \"strip\", Zod.ZodTypeAny, { lookbackPeriod: string; timestampField: string; settings?: { frequency?: string | undefined; timeout?: string | undefined; syncField?: string | undefined; syncDelay?: string | undefined; docsPerSecond?: number | undefined; } | undefined; }, { timestampField: string; settings?: { frequency?: string | undefined; timeout?: string | undefined; syncField?: string | undefined; syncDelay?: string | undefined; docsPerSecond?: number | undefined; } | undefined; lookbackPeriod?: string | undefined; }>>; installedComponents: Zod.ZodOptional, Zod.ZodLiteral<\"ingest_pipeline\">, Zod.ZodLiteral<\"template\">]>; id: Zod.ZodString; }, \"strip\", Zod.ZodTypeAny, { id: string; type: \"transform\" | \"template\" | \"ingest_pipeline\"; }, { id: string; type: \"transform\" | \"template\" | \"ingest_pipeline\"; }>, \"many\">>>; }, { latest: Zod.ZodOptional; lookbackPeriod: Zod.ZodOptional>>; settings: Zod.ZodOptional; syncDelay: Zod.ZodOptional; frequency: Zod.ZodOptional; timeout: Zod.ZodOptional; docsPerSecond: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { frequency?: string | undefined; timeout?: string | undefined; syncField?: string | undefined; syncDelay?: string | undefined; docsPerSecond?: number | undefined; }, { frequency?: string | undefined; timeout?: string | undefined; syncField?: string | undefined; syncDelay?: string | undefined; docsPerSecond?: number | undefined; }>>>; }, \"strip\", Zod.ZodTypeAny, { settings?: { frequency?: string | undefined; timeout?: string | undefined; syncField?: string | undefined; syncDelay?: string | undefined; docsPerSecond?: number | undefined; } | undefined; lookbackPeriod?: string | undefined; timestampField?: string | undefined; }, { settings?: { frequency?: string | undefined; timeout?: string | undefined; syncField?: string | undefined; syncDelay?: string | undefined; docsPerSecond?: number | undefined; } | undefined; lookbackPeriod?: string | undefined; timestampField?: string | undefined; }>>; version: Zod.ZodEffects; }>, \"strip\", Zod.ZodTypeAny, { version: string; type?: string | undefined; filter?: string | undefined; name?: string | undefined; description?: string | undefined; metrics?: { name: string; metrics: ({ name: string; field: string; aggregation: ", { "pluginId": "@kbn/entities-schema", "scope": "common", "docId": "kibKbnEntitiesSchemaPluginApi", "section": "def-common.BasicAggregations", "text": "BasicAggregations" }, "; filter?: string | undefined; } | { name: string; aggregation: \"doc_count\"; filter?: string | undefined; } | { name: string; field: string; percentile: number; aggregation: \"percentile\"; filter?: string | undefined; })[]; equation: string; }[] | undefined; indexPatterns?: string[] | undefined; metadata?: ({ destination: string; source: string; aggregation: { type: \"terms\"; limit: number; lookbackPeriod?: string | undefined; } | { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; }; } | { destination: string; source: string; aggregation: { type: \"terms\"; limit: number; lookbackPeriod: undefined; }; })[] | undefined; identityFields?: ({ field: string; optional: false; } | { field: string; optional: boolean; })[] | undefined; displayNameTemplate?: string | undefined; staticFields?: Record | undefined; latest?: { settings?: { frequency?: string | undefined; timeout?: string | undefined; syncField?: string | undefined; syncDelay?: string | undefined; docsPerSecond?: number | undefined; } | undefined; lookbackPeriod?: string | undefined; timestampField?: string | undefined; } | undefined; installedComponents?: { id: string; type: \"transform\" | \"template\" | \"ingest_pipeline\"; }[] | undefined; }, { version: string; type?: string | undefined; filter?: string | undefined; name?: string | undefined; description?: string | undefined; metrics?: { name: string; metrics: ({ name: string; field: string; aggregation: ", { "pluginId": "@kbn/entities-schema", "scope": "common", "docId": "kibKbnEntitiesSchemaPluginApi", "section": "def-common.BasicAggregations", "text": "BasicAggregations" }, "; filter?: string | undefined; } | { name: string; aggregation: \"doc_count\"; filter?: string | undefined; } | { name: string; field: string; percentile: number; aggregation: \"percentile\"; filter?: string | undefined; })[]; equation: string; }[] | undefined; indexPatterns?: string[] | undefined; metadata?: (string | { source: string; destination?: string | undefined; aggregation?: { type: \"terms\"; limit?: number | undefined; lookbackPeriod?: string | undefined; } | { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; } | undefined; })[] | undefined; identityFields?: (string | { field: string; optional: false; })[] | undefined; displayNameTemplate?: string | undefined; staticFields?: Record | undefined; latest?: { settings?: { frequency?: string | undefined; timeout?: string | undefined; syncField?: string | undefined; syncDelay?: string | undefined; docsPerSecond?: number | undefined; } | undefined; lookbackPeriod?: string | undefined; timestampField?: string | undefined; } | undefined; installedComponents?: { id: string; type: \"transform\" | \"template\" | \"ingest_pipeline\"; }[] | undefined; }>" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/entity_definition.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.entityLatestSchema", "type": "Object", "tags": [], "label": "entityLatestSchema", "description": [], "signature": [ "Zod.ZodIntersection, Zod.ZodString]>; display_name: Zod.ZodString; metrics: Zod.ZodOptional>; definition_version: Zod.ZodString; schema_version: Zod.ZodString; definition_id: Zod.ZodString; }, { last_seen_timestamp: Zod.ZodString; }>, \"strip\", Zod.ZodTypeAny, { id: string; type: string; schema_version: string; identity_fields: string | string[]; display_name: string; definition_id: string; definition_version: string; last_seen_timestamp: string; metrics?: Record | undefined; }, { id: string; type: string; schema_version: string; identity_fields: string | string[]; display_name: string; definition_id: string; definition_version: string; last_seen_timestamp: string; metrics?: Record | undefined; }>; }, \"strip\", Zod.ZodTypeAny, { entity: { id: string; type: string; schema_version: string; identity_fields: string | string[]; display_name: string; definition_id: string; definition_version: string; last_seen_timestamp: string; metrics?: Record | undefined; }; }, { entity: { id: string; type: string; schema_version: string; identity_fields: string | string[]; display_name: string; definition_id: string; definition_version: string; last_seen_timestamp: string; metrics?: Record | undefined; }; }>, Zod.ZodType>" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/entity.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.entityMetadataSchema", "type": "Object", "tags": [], "label": "entityMetadataSchema", "description": [], "signature": [ "Zod.ZodType" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/entity.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.filterSchema", "type": "Object", "tags": [], "label": "filterSchema", "description": [], "signature": [ "Zod.ZodOptional" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.getEntityDefinitionQuerySchema", "type": "Object", "tags": [], "label": "getEntityDefinitionQuerySchema", "description": [], "signature": [ "Zod.ZodObject<{ page: Zod.ZodOptional; perPage: Zod.ZodOptional; includeState: Zod.ZodDefault>; }, \"strip\", Zod.ZodTypeAny, { page?: number | undefined; perPage?: number | undefined; includeState?: any; }, { page?: number | undefined; perPage?: number | undefined; includeState?: any; }>" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/rest_spec/get.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.historySettingsSchema", "type": "Object", "tags": [], "label": "historySettingsSchema", "description": [], "signature": [ "Zod.ZodEffects; syncDelay: Zod.ZodOptional; lookbackPeriod: Zod.ZodDefault>; frequency: Zod.ZodOptional; backfillSyncDelay: Zod.ZodOptional; backfillLookbackPeriod: Zod.ZodOptional; backfillFrequency: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { lookbackPeriod: string; frequency?: string | undefined; syncField?: string | undefined; syncDelay?: string | undefined; backfillSyncDelay?: string | undefined; backfillLookbackPeriod?: string | undefined; backfillFrequency?: string | undefined; }, { frequency?: string | undefined; lookbackPeriod?: string | undefined; syncField?: string | undefined; syncDelay?: string | undefined; backfillSyncDelay?: string | undefined; backfillLookbackPeriod?: string | undefined; backfillFrequency?: string | undefined; }>>, { lookbackPeriod: string; frequency?: string | undefined; syncField?: string | undefined; syncDelay?: string | undefined; backfillSyncDelay?: string | undefined; backfillLookbackPeriod?: string | undefined; backfillFrequency?: string | undefined; }, { frequency?: string | undefined; lookbackPeriod?: string | undefined; syncField?: string | undefined; syncDelay?: string | undefined; backfillSyncDelay?: string | undefined; backfillLookbackPeriod?: string | undefined; backfillFrequency?: string | undefined; } | undefined>" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.identityFieldsSchema", "type": "Object", "tags": [], "label": "identityFieldsSchema", "description": [], "signature": [ "Zod.ZodUnion<[Zod.ZodObject<{ field: Zod.ZodString; optional: Zod.ZodLiteral; }, \"strip\", Zod.ZodTypeAny, { field: string; optional: false; }, { field: string; optional: false; }>, Zod.ZodEffects]>" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.keyMetricSchema", "type": "Object", "tags": [], "label": "keyMetricSchema", "description": [], "signature": [ "Zod.ZodObject<{ name: Zod.ZodString; metrics: Zod.ZodArray; field: Zod.ZodString; filter: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { name: string; field: string; aggregation: ", { "pluginId": "@kbn/entities-schema", "scope": "common", "docId": "kibKbnEntitiesSchemaPluginApi", "section": "def-common.BasicAggregations", "text": "BasicAggregations" }, "; filter?: string | undefined; }, { name: string; field: string; aggregation: ", { "pluginId": "@kbn/entities-schema", "scope": "common", "docId": "kibKbnEntitiesSchemaPluginApi", "section": "def-common.BasicAggregations", "text": "BasicAggregations" }, "; filter?: string | undefined; }>, Zod.ZodObject<{ name: Zod.ZodString; aggregation: Zod.ZodLiteral<\"doc_count\">; filter: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { name: string; aggregation: \"doc_count\"; filter?: string | undefined; }, { name: string; aggregation: \"doc_count\"; filter?: string | undefined; }>, Zod.ZodObject<{ name: Zod.ZodString; aggregation: Zod.ZodLiteral<\"percentile\">; field: Zod.ZodString; percentile: Zod.ZodNumber; filter: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { name: string; field: string; percentile: number; aggregation: \"percentile\"; filter?: string | undefined; }, { name: string; field: string; percentile: number; aggregation: \"percentile\"; filter?: string | undefined; }>]>, \"many\">; equation: Zod.ZodString; }, \"strip\", Zod.ZodTypeAny, { name: string; metrics: ({ name: string; field: string; aggregation: ", { "pluginId": "@kbn/entities-schema", "scope": "common", "docId": "kibKbnEntitiesSchemaPluginApi", "section": "def-common.BasicAggregations", "text": "BasicAggregations" }, "; filter?: string | undefined; } | { name: string; aggregation: \"doc_count\"; filter?: string | undefined; } | { name: string; field: string; percentile: number; aggregation: \"percentile\"; filter?: string | undefined; })[]; equation: string; }, { name: string; metrics: ({ name: string; field: string; aggregation: ", { "pluginId": "@kbn/entities-schema", "scope": "common", "docId": "kibKbnEntitiesSchemaPluginApi", "section": "def-common.BasicAggregations", "text": "BasicAggregations" }, "; filter?: string | undefined; } | { name: string; aggregation: \"doc_count\"; filter?: string | undefined; } | { name: string; field: string; percentile: number; aggregation: \"percentile\"; filter?: string | undefined; })[]; equation: string; }>" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.metadataAggregation", "type": "Object", "tags": [], "label": "metadataAggregation", "description": [], "signature": [ "Zod.ZodUnion<[Zod.ZodObject<{ type: Zod.ZodLiteral<\"terms\">; limit: Zod.ZodDefault; lookbackPeriod: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { type: \"terms\"; limit: number; lookbackPeriod?: string | undefined; }, { type: \"terms\"; limit?: number | undefined; lookbackPeriod?: string | undefined; }>, Zod.ZodObject<{ type: Zod.ZodLiteral<\"top_value\">; sort: Zod.ZodRecord, Zod.ZodLiteral<\"desc\">]>>; lookbackPeriod: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; }, { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; }>]>" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.metadataSchema", "type": "Object", "tags": [], "label": "metadataSchema", "description": [], "signature": [ "Zod.ZodEffects; aggregation: Zod.ZodDefault; limit: Zod.ZodDefault; lookbackPeriod: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { type: \"terms\"; limit: number; lookbackPeriod?: string | undefined; }, { type: \"terms\"; limit?: number | undefined; lookbackPeriod?: string | undefined; }>, Zod.ZodObject<{ type: Zod.ZodLiteral<\"top_value\">; sort: Zod.ZodRecord, Zod.ZodLiteral<\"desc\">]>>; lookbackPeriod: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; }, { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; }>]>>>; }, \"strip\", Zod.ZodTypeAny, { source: string; aggregation: { type: \"terms\"; limit: number; lookbackPeriod?: string | undefined; } | { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; }; destination?: string | undefined; }, { source: string; destination?: string | undefined; aggregation?: { type: \"terms\"; limit?: number | undefined; lookbackPeriod?: string | undefined; } | { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; } | undefined; }>, Zod.ZodEffects]>, { destination: string; source: string; aggregation: { type: \"terms\"; limit: number; lookbackPeriod?: string | undefined; } | { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; }; } | { destination: string; source: string; aggregation: { type: \"terms\"; limit: number; lookbackPeriod: undefined; }; }, string | { source: string; destination?: string | undefined; aggregation?: { type: \"terms\"; limit?: number | undefined; lookbackPeriod?: string | undefined; } | { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; } | undefined; }>, { destination: string; source: string; aggregation: { type: \"terms\"; limit: number; lookbackPeriod?: string | undefined; } | { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; }; } | { destination: string; source: string; aggregation: { type: \"terms\"; limit: number; lookbackPeriod: undefined; }; }, string | { source: string; destination?: string | undefined; aggregation?: { type: \"terms\"; limit?: number | undefined; lookbackPeriod?: string | undefined; } | { type: \"top_value\"; sort: Record; lookbackPeriod?: string | undefined; } | undefined; }>" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.metricSchema", "type": "Object", "tags": [], "label": "metricSchema", "description": [], "signature": [ "Zod.ZodDiscriminatedUnion<\"aggregation\", [Zod.ZodObject<{ name: Zod.ZodString; aggregation: Zod.ZodNativeEnum; field: Zod.ZodString; filter: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { name: string; field: string; aggregation: ", { "pluginId": "@kbn/entities-schema", "scope": "common", "docId": "kibKbnEntitiesSchemaPluginApi", "section": "def-common.BasicAggregations", "text": "BasicAggregations" }, "; filter?: string | undefined; }, { name: string; field: string; aggregation: ", { "pluginId": "@kbn/entities-schema", "scope": "common", "docId": "kibKbnEntitiesSchemaPluginApi", "section": "def-common.BasicAggregations", "text": "BasicAggregations" }, "; filter?: string | undefined; }>, Zod.ZodObject<{ name: Zod.ZodString; aggregation: Zod.ZodLiteral<\"doc_count\">; filter: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { name: string; aggregation: \"doc_count\"; filter?: string | undefined; }, { name: string; aggregation: \"doc_count\"; filter?: string | undefined; }>, Zod.ZodObject<{ name: Zod.ZodString; aggregation: Zod.ZodLiteral<\"percentile\">; field: Zod.ZodString; percentile: Zod.ZodNumber; filter: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { name: string; field: string; percentile: number; aggregation: \"percentile\"; filter?: string | undefined; }, { name: string; field: string; percentile: number; aggregation: \"percentile\"; filter?: string | undefined; }>]>" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.percentileMetricSchema", "type": "Object", "tags": [], "label": "percentileMetricSchema", "description": [], "signature": [ "Zod.ZodObject<{ name: Zod.ZodString; aggregation: Zod.ZodLiteral<\"percentile\">; field: Zod.ZodString; percentile: Zod.ZodNumber; filter: Zod.ZodOptional; }, \"strip\", Zod.ZodTypeAny, { name: string; field: string; percentile: number; aggregation: \"percentile\"; filter?: string | undefined; }, { name: string; field: string; percentile: number; aggregation: \"percentile\"; filter?: string | undefined; }>" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.resetEntityDefinitionParamsSchema", "type": "Object", "tags": [], "label": "resetEntityDefinitionParamsSchema", "description": [], "signature": [ "Zod.ZodObject<{ id: Zod.ZodString; }, \"strip\", Zod.ZodTypeAny, { id: string; }, { id: string; }>" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/rest_spec/reset.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/entities-schema", "id": "def-common.semVerSchema", "type": "Object", "tags": [], "label": "semVerSchema", "description": [], "signature": [ "Zod.ZodEffects" ], "path": "x-pack/platform/packages/shared/kbn-entities-schema/src/schema/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ] } }