mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
8115 lines
No EOL
374 KiB
JSON
8115 lines
No EOL
374 KiB
JSON
{
|
|
"id": "@kbn/ftr-common-functional-services",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.DeploymentService",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "DeploymentService",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.DeploymentService",
|
|
"text": "DeploymentService"
|
|
},
|
|
" extends ",
|
|
"FtrService"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/deployment.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.DeploymentService.getHostPort",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getHostPort",
|
|
"description": [
|
|
"\nReturns Kibana host URL"
|
|
],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/deployment.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.DeploymentService.getEsHostPort",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getEsHostPort",
|
|
"description": [
|
|
"\nReturns ES host URL"
|
|
],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/deployment.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.DeploymentService.isCloud",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isCloud",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<boolean>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/deployment.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.IndexPatternsService",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "IndexPatternsService",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
},
|
|
" extends ",
|
|
"FtrService"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/index_patterns.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.IndexPatternsService.create",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "create",
|
|
"description": [
|
|
"\nCreate a new index pattern"
|
|
],
|
|
"signature": [
|
|
"(indexPattern: { title: string; timeFieldName?: string | undefined; }, { override }?: { override: boolean; }, spaceId?: string) => Promise<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataViewSpec",
|
|
"text": "DataViewSpec"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/index_patterns.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.IndexPatternsService.create.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "indexPattern",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/index_patterns.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.IndexPatternsService.create.$1.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/index_patterns.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.IndexPatternsService.create.$1.timeFieldName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "timeFieldName",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/index_patterns.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.IndexPatternsService.create.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ override }",
|
|
"description": [],
|
|
"signature": [
|
|
"{ override: boolean; }"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/index_patterns.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.IndexPatternsService.create.$3",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "spaceId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/index_patterns.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RandomnessService",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "RandomnessService",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RandomnessService",
|
|
"text": "RandomnessService"
|
|
},
|
|
" extends ",
|
|
"FtrService"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/randomness.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RandomnessService.naturalNumber",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "naturalNumber",
|
|
"description": [
|
|
"\nGenerate a random natural number\n\n range: 0 to 9007199254740991\n"
|
|
],
|
|
"signature": [
|
|
"(options?: NumberOptions | undefined) => number"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/randomness.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RandomnessService.naturalNumber.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"NumberOptions | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/randomness.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RandomnessService.integer",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "integer",
|
|
"description": [
|
|
"\nGenerate a random integer"
|
|
],
|
|
"signature": [
|
|
"(options?: NumberOptions | undefined) => number"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/randomness.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RandomnessService.integer.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"NumberOptions | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/randomness.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RandomnessService.word",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "word",
|
|
"description": [
|
|
"\nGenerate a random number, defaults to at least 4 and no more than 8 syllables"
|
|
],
|
|
"signature": [
|
|
"(options?: { syllables?: number | undefined; }) => string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/randomness.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RandomnessService.word.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/randomness.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RandomnessService.word.$1.syllables",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "syllables",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/randomness.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RandomnessService.string",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "string",
|
|
"description": [
|
|
"\nGenerate a random string, defaults to at least 8 and no more than 15 alpha-numeric characters"
|
|
],
|
|
"signature": [
|
|
"(options?: StringOptions) => string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/randomness.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RandomnessService.string.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"StringOptions"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/randomness.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RetryService",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "RetryService",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RetryService",
|
|
"text": "RetryService"
|
|
},
|
|
" extends ",
|
|
"FtrService"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RetryService.tryForTime",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "tryForTime",
|
|
"description": [
|
|
"\nUse to retry block within {timeout} period and return block result."
|
|
],
|
|
"signature": [
|
|
"<T>(timeout: number, block: () => Promise<T>, onFailureBlock?: (() => Promise<T>) | undefined, retryDelay?: number | undefined) => Promise<T>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RetryService.tryForTime.$1",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "timeout",
|
|
"description": [
|
|
"retrying timeout"
|
|
],
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RetryService.tryForTime.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "block",
|
|
"description": [
|
|
"retriable action"
|
|
],
|
|
"signature": [
|
|
"() => Promise<T>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RetryService.tryForTime.$3",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onFailureBlock",
|
|
"description": [
|
|
"optional action to run before the new retriable action attempt"
|
|
],
|
|
"signature": [
|
|
"(() => Promise<T>) | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RetryService.tryForTime.$4",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "retryDelay",
|
|
"description": [
|
|
"optional delay before the new attempt"
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"result from retriable action"
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RetryService.try",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "try",
|
|
"description": [],
|
|
"signature": [
|
|
"<T>(block: () => Promise<T>, onFailureBlock?: (() => Promise<T>) | undefined, retryDelay?: number | undefined) => Promise<T>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RetryService.try.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "block",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<T>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RetryService.try.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onFailureBlock",
|
|
"description": [],
|
|
"signature": [
|
|
"(() => Promise<T>) | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RetryService.try.$3",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "retryDelay",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RetryService.waitForWithTimeout",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "waitForWithTimeout",
|
|
"description": [
|
|
"\nUse to wait for block condition to be true"
|
|
],
|
|
"signature": [
|
|
"(description: string, timeout: number, block: () => Promise<boolean>, onFailureBlock?: (() => Promise<any>) | undefined) => Promise<void>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RetryService.waitForWithTimeout.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [
|
|
"description for retriable action"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RetryService.waitForWithTimeout.$2",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "timeout",
|
|
"description": [
|
|
"retrying timeout"
|
|
],
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RetryService.waitForWithTimeout.$3",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "block",
|
|
"description": [
|
|
"retriable action"
|
|
],
|
|
"signature": [
|
|
"() => Promise<boolean>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RetryService.waitForWithTimeout.$4",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onFailureBlock",
|
|
"description": [
|
|
"optional action to run before the new retriable action attempt"
|
|
],
|
|
"signature": [
|
|
"(() => Promise<any>) | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RetryService.waitFor",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "waitFor",
|
|
"description": [],
|
|
"signature": [
|
|
"(description: string, block: () => Promise<boolean>, onFailureBlock?: (() => Promise<any>) | undefined) => Promise<void>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RetryService.waitFor.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RetryService.waitFor.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "block",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<boolean>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RetryService.waitFor.$3",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onFailureBlock",
|
|
"description": [],
|
|
"signature": [
|
|
"(() => Promise<any>) | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RetryService.tryWithRetries",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "tryWithRetries",
|
|
"description": [
|
|
"\nUse to retry block {options.retryCount} times within {options.timeout} period and return block result"
|
|
],
|
|
"signature": [
|
|
"<T>(description: string, block: () => Promise<T>, options: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.TryWithRetriesOptions",
|
|
"text": "TryWithRetriesOptions"
|
|
},
|
|
", onFailureBlock?: (() => Promise<T>) | undefined) => Promise<T>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RetryService.tryWithRetries.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [
|
|
"description for retriable action"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RetryService.tryWithRetries.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "block",
|
|
"description": [
|
|
"retriable action"
|
|
],
|
|
"signature": [
|
|
"() => Promise<T>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RetryService.tryWithRetries.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [
|
|
"options.retryCount for how many attempts to retry"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.TryWithRetriesOptions",
|
|
"text": "TryWithRetriesOptions"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RetryService.tryWithRetries.$4",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onFailureBlock",
|
|
"description": [
|
|
"optional action to run before the new retriable action attempt"
|
|
],
|
|
"signature": [
|
|
"(() => Promise<T>) | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"result from retriable action"
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.SavedObjectInfoService",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "SavedObjectInfoService",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SavedObjectInfoService",
|
|
"text": "SavedObjectInfoService"
|
|
},
|
|
" extends ",
|
|
"FtrService"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/saved_object_info/saved_object_info.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.SavedObjectInfoService.logSoTypes",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "logSoTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"(log: ",
|
|
{
|
|
"pluginId": "@kbn/tooling-log",
|
|
"scope": "common",
|
|
"docId": "kibKbnToolingLogPluginApi",
|
|
"section": "def-common.ToolingLog",
|
|
"text": "ToolingLog"
|
|
},
|
|
", msg?: string | null) => Promise<void>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/saved_object_info/saved_object_info.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.SavedObjectInfoService.logSoTypes.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "log",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/tooling-log",
|
|
"scope": "common",
|
|
"docId": "kibKbnToolingLogPluginApi",
|
|
"section": "def-common.ToolingLog",
|
|
"text": "ToolingLog"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/saved_object_info/saved_object_info.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.SavedObjectInfoService.logSoTypes.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "msg",
|
|
"description": [],
|
|
"signature": [
|
|
"string | null"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/saved_object_info/saved_object_info.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.SearchService",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "SearchService",
|
|
"description": [
|
|
"\nSearch Service that can reduce flake on the CI systems when they are under\npressure and search returns an async search response or a sync response.\n"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SearchService",
|
|
"text": "SearchService"
|
|
},
|
|
" extends ",
|
|
"FtrService"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/search.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.SearchService.send",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "send",
|
|
"description": [
|
|
"Send method to send in your supertest, url, options, and strategy name"
|
|
],
|
|
"signature": [
|
|
"<T extends ",
|
|
{
|
|
"pluginId": "@kbn/search-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnSearchTypesPluginApi",
|
|
"section": "def-common.IEsSearchResponse",
|
|
"text": "IEsSearchResponse"
|
|
},
|
|
"<any>>({ supertest, options, strategy, space }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SendOptions",
|
|
"text": "SendOptions"
|
|
},
|
|
") => Promise<any>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/search.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.SearchService.send.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ supertest, options, strategy, space }",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SendOptions",
|
|
"text": "SendOptions"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/search.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.SecurityService",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "SecurityService",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/security/security.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.SecurityService.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/security/security.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.SecurityService.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "roleMappings",
|
|
"description": [],
|
|
"signature": [
|
|
"RoleMappings"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/security/security.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.SecurityService.Unnamed.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "testUser",
|
|
"description": [],
|
|
"signature": [
|
|
"TestUser"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/security/security.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.SecurityService.Unnamed.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "role",
|
|
"description": [],
|
|
"signature": [
|
|
"Role"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/security/security.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.SecurityService.Unnamed.$4",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "user",
|
|
"description": [],
|
|
"signature": [
|
|
"User"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/security/security.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.SecurityService.Unnamed.$5",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "testUserSupertest",
|
|
"description": [],
|
|
"signature": [
|
|
"node_modules/@types/supertest/lib/agent",
|
|
"<",
|
|
"SuperTestStatic",
|
|
".Test>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/security/security.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.ElasticsearchSupertestProvider",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "ElasticsearchSupertestProvider",
|
|
"description": [],
|
|
"signature": [
|
|
"({\n getService,\n}: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/supertest.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.ElasticsearchSupertestProvider.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n getService,\n}",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/supertest.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.EsProvider",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "EsProvider",
|
|
"description": [],
|
|
"signature": [
|
|
"({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"default"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/es.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.EsProvider.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ getService }",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/es.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.KibanaServerProvider",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "KibanaServerProvider",
|
|
"description": [],
|
|
"signature": [
|
|
"({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.KbnClient",
|
|
"text": "KbnClient"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/kibana_server/kibana_server.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.KibanaServerProvider.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ getService }",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/kibana_server/kibana_server.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.KibanaSupertestProvider",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "KibanaSupertestProvider",
|
|
"description": [],
|
|
"signature": [
|
|
"({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/supertest.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.KibanaSupertestProvider.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ getService }",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/supertest.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.retryForSuccess",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "retryForSuccess",
|
|
"description": [],
|
|
"signature": [
|
|
"(log: ",
|
|
{
|
|
"pluginId": "@kbn/tooling-log",
|
|
"scope": "common",
|
|
"docId": "kibKbnToolingLogPluginApi",
|
|
"section": "def-common.ToolingLog",
|
|
"text": "ToolingLog"
|
|
},
|
|
", options: Options<T>) => Promise<T>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry_for_success.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.retryForSuccess.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "log",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/tooling-log",
|
|
"scope": "common",
|
|
"docId": "kibKbnToolingLogPluginApi",
|
|
"section": "def-common.ToolingLog",
|
|
"text": "ToolingLog"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry_for_success.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.retryForSuccess.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"Options<T>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry_for_success.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.runSavedObjInfoSvc",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "runSavedObjInfoSvc",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<void | undefined>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/saved_object_info/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.CookieCredentials",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CookieCredentials",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/saml_auth/saml_auth_provider.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.CookieCredentials.Cookie",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "Cookie",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/saml_auth/saml_auth_provider.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.CookieCredentials.Unnamed",
|
|
"type": "IndexSignature",
|
|
"tags": [],
|
|
"label": "[header: string]: string",
|
|
"description": [],
|
|
"signature": [
|
|
"[header: string]: string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/saml_auth/saml_auth_provider.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.KibanaRoleDescriptors",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "KibanaRoleDescriptors",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/saml_auth/saml_auth_provider.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.KibanaRoleDescriptors.kibana",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "kibana",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/saml_auth/saml_auth_provider.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.KibanaRoleDescriptors.elasticsearch",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "elasticsearch",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/saml_auth/saml_auth_provider.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RoleCredentials",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RoleCredentials",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/saml_auth/saml_auth_provider.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RoleCredentials.apiKey",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "apiKey",
|
|
"description": [],
|
|
"signature": [
|
|
"{ id: string; name: string; }"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/saml_auth/saml_auth_provider.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.RoleCredentials.apiKeyHeader",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "apiKeyHeader",
|
|
"description": [],
|
|
"signature": [
|
|
"{ Authorization: string; }"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/saml_auth/saml_auth_provider.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.SendOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SendOptions",
|
|
"description": [
|
|
"\nOptions for the send method"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/search.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.SendOptions.supertest",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "supertest",
|
|
"description": [],
|
|
"signature": [
|
|
"Agent"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/search.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.SendOptions.options",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"object"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/search.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.SendOptions.strategy",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "strategy",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/search.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.SendOptions.space",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "space",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/search.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.TryWithRetriesOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "TryWithRetriesOptions",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.TryWithRetriesOptions.initialDelay",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "initialDelay",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.TryWithRetriesOptions.retryCount",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "retryCount",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.TryWithRetriesOptions.retryDelay",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "retryDelay",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.TryWithRetriesOptions.timeout",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "timeout",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/retry/retry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.Es",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "Es",
|
|
"description": [],
|
|
"signature": [
|
|
"default"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.EsArchiver",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EsArchiver",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.FtrProviderContext",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "FtrProviderContext",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GenericFtrProviderContext",
|
|
"text": "GenericFtrProviderContext"
|
|
},
|
|
"<{ es: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"default",
|
|
"; kibanaServer: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.KbnClient",
|
|
"text": "KbnClient"
|
|
},
|
|
"; esArchiver: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/es-archiver",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsArchiverPluginApi",
|
|
"section": "def-common.EsArchiver",
|
|
"text": "EsArchiver"
|
|
},
|
|
"; retry: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RetryService",
|
|
"text": "RetryService"
|
|
},
|
|
"; search: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SearchService",
|
|
"text": "SearchService"
|
|
},
|
|
"; console: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { createIndex: (indexName: string) => Promise<void>; createAlias: (indexName: string, aliasName: string) => Promise<void>; createLegacyTemplate: (templateName: string) => Promise<void>; createIndexTemplate: (templateName: string, indexPatterns: string[], composedOf: string[]) => Promise<void>; createComponentTemplate: (templateName: string) => Promise<void>; createDataStream: (dataStream: string) => Promise<void>; deleteIndex: (indexName: string) => Promise<void>; deleteAlias: (indexName: string, aliasName: string) => Promise<void>; deleteLegacyTemplate: (templateName: string) => Promise<void>; deleteIndexTemplate: (templateName: string) => Promise<void>; deleteComponentTemplate: (templateName: string) => Promise<void>; deleteDataStream: (dataStream: string) => Promise<void>; }; deployment: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.DeploymentService",
|
|
"text": "DeploymentService"
|
|
},
|
|
"; esDeleteAllIndices: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => (patterns: string | string[], remote?: boolean) => Promise<void>; indexPatterns: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
},
|
|
"; savedObjectInfo: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SavedObjectInfoService",
|
|
"text": "SavedObjectInfoService"
|
|
},
|
|
"; randomness: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RandomnessService",
|
|
"text": "RandomnessService"
|
|
},
|
|
"; samlAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { getInteractiveUserSessionCookieWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<string>; getM2MApiCookieCredentialsWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getM2MApiCookieCredentialsWithCustomRoleScope(options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getEmail(role: string): Promise<string>; getUserData(role: string): Promise<",
|
|
"UserProfile",
|
|
">; checkRoleIsSupported(role: string): void; createM2mApiKeyWithDefaultRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithRoleScope(role: string): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithCustomRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; invalidateM2mApiKeyWithRoleScope(roleCredentials: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
"): Promise<void>; setCustomRole(descriptors: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.KibanaRoleDescriptors",
|
|
"text": "KibanaRoleDescriptors"
|
|
},
|
|
"): Promise<void>; deleteCustomRole(): Promise<void>; getCommonRequestHeader(): { 'kbn-xsrf': string; }; getInternalRequestHeader(): ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.InternalRequestHeader",
|
|
"text": "InternalRequestHeader"
|
|
},
|
|
"; DEFAULT_ROLE: string; CUSTOM_ROLE: string; }; supertest: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; esSupertest: ({ getService, }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; supertestWithoutAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"node_modules/@types/supertest/lib/agent",
|
|
"<",
|
|
"SuperTestStatic",
|
|
".Test>; security: (ctx: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SecurityService",
|
|
"text": "SecurityService"
|
|
},
|
|
">; }, {}, ProvidedTypeMap<{ es: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"default",
|
|
"; kibanaServer: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.KbnClient",
|
|
"text": "KbnClient"
|
|
},
|
|
"; esArchiver: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/es-archiver",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsArchiverPluginApi",
|
|
"section": "def-common.EsArchiver",
|
|
"text": "EsArchiver"
|
|
},
|
|
"; retry: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RetryService",
|
|
"text": "RetryService"
|
|
},
|
|
"; search: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SearchService",
|
|
"text": "SearchService"
|
|
},
|
|
"; console: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { createIndex: (indexName: string) => Promise<void>; createAlias: (indexName: string, aliasName: string) => Promise<void>; createLegacyTemplate: (templateName: string) => Promise<void>; createIndexTemplate: (templateName: string, indexPatterns: string[], composedOf: string[]) => Promise<void>; createComponentTemplate: (templateName: string) => Promise<void>; createDataStream: (dataStream: string) => Promise<void>; deleteIndex: (indexName: string) => Promise<void>; deleteAlias: (indexName: string, aliasName: string) => Promise<void>; deleteLegacyTemplate: (templateName: string) => Promise<void>; deleteIndexTemplate: (templateName: string) => Promise<void>; deleteComponentTemplate: (templateName: string) => Promise<void>; deleteDataStream: (dataStream: string) => Promise<void>; }; deployment: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.DeploymentService",
|
|
"text": "DeploymentService"
|
|
},
|
|
"; esDeleteAllIndices: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => (patterns: string | string[], remote?: boolean) => Promise<void>; indexPatterns: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
},
|
|
"; savedObjectInfo: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SavedObjectInfoService",
|
|
"text": "SavedObjectInfoService"
|
|
},
|
|
"; randomness: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RandomnessService",
|
|
"text": "RandomnessService"
|
|
},
|
|
"; samlAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { getInteractiveUserSessionCookieWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<string>; getM2MApiCookieCredentialsWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getM2MApiCookieCredentialsWithCustomRoleScope(options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getEmail(role: string): Promise<string>; getUserData(role: string): Promise<",
|
|
"UserProfile",
|
|
">; checkRoleIsSupported(role: string): void; createM2mApiKeyWithDefaultRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithRoleScope(role: string): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithCustomRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; invalidateM2mApiKeyWithRoleScope(roleCredentials: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
"): Promise<void>; setCustomRole(descriptors: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.KibanaRoleDescriptors",
|
|
"text": "KibanaRoleDescriptors"
|
|
},
|
|
"): Promise<void>; deleteCustomRole(): Promise<void>; getCommonRequestHeader(): { 'kbn-xsrf': string; }; getInternalRequestHeader(): ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.InternalRequestHeader",
|
|
"text": "InternalRequestHeader"
|
|
},
|
|
"; DEFAULT_ROLE: string; CUSTOM_ROLE: string; }; supertest: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; esSupertest: ({ getService, }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; supertestWithoutAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"node_modules/@types/supertest/lib/agent",
|
|
"<",
|
|
"SuperTestStatic",
|
|
".Test>; security: (ctx: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SecurityService",
|
|
"text": "SecurityService"
|
|
},
|
|
">; }>, ProvidedTypeMap<{}>>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/ftr_provider_context.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.InternalRequestHeader",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "InternalRequestHeader",
|
|
"description": [],
|
|
"signature": [
|
|
"{ 'x-elastic-internal-origin': string; 'kbn-xsrf': string; } | { 'x-elastic-internal-origin': string; 'kbn-xsrf': string; }"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/saml_auth/default_request_headers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.KibanaServer",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "KibanaServer",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.KbnClient",
|
|
"text": "KbnClient"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.SamlAuthProviderType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SamlAuthProviderType",
|
|
"description": [],
|
|
"signature": [
|
|
"{ getInteractiveUserSessionCookieWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<string>; getM2MApiCookieCredentialsWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getM2MApiCookieCredentialsWithCustomRoleScope(options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getEmail(role: string): Promise<string>; getUserData(role: string): Promise<",
|
|
"UserProfile",
|
|
">; checkRoleIsSupported(role: string): void; createM2mApiKeyWithDefaultRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithRoleScope(role: string): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithCustomRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; invalidateM2mApiKeyWithRoleScope(roleCredentials: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
"): Promise<void>; setCustomRole(descriptors: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.KibanaRoleDescriptors",
|
|
"text": "KibanaRoleDescriptors"
|
|
},
|
|
"): Promise<void>; deleteCustomRole(): Promise<void>; getCommonRequestHeader(): { 'kbn-xsrf': string; }; getInternalRequestHeader(): ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.InternalRequestHeader",
|
|
"text": "InternalRequestHeader"
|
|
},
|
|
"; DEFAULT_ROLE: string; CUSTOM_ROLE: string; }"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.SupertestWithoutAuthProviderType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SupertestWithoutAuthProviderType",
|
|
"description": [],
|
|
"signature": [
|
|
"node_modules/@types/supertest/lib/agent",
|
|
"<",
|
|
"SuperTestStatic",
|
|
".Test>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.services",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "services",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/all.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.services.es",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "es",
|
|
"description": [],
|
|
"signature": [
|
|
"({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"default"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/all.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.services.es.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "__0",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GenericFtrProviderContext",
|
|
"text": "GenericFtrProviderContext"
|
|
},
|
|
"<{ es: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"default",
|
|
"; kibanaServer: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.KbnClient",
|
|
"text": "KbnClient"
|
|
},
|
|
"; esArchiver: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/es-archiver",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsArchiverPluginApi",
|
|
"section": "def-common.EsArchiver",
|
|
"text": "EsArchiver"
|
|
},
|
|
"; retry: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RetryService",
|
|
"text": "RetryService"
|
|
},
|
|
"; search: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SearchService",
|
|
"text": "SearchService"
|
|
},
|
|
"; console: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { createIndex: (indexName: string) => Promise<void>; createAlias: (indexName: string, aliasName: string) => Promise<void>; createLegacyTemplate: (templateName: string) => Promise<void>; createIndexTemplate: (templateName: string, indexPatterns: string[], composedOf: string[]) => Promise<void>; createComponentTemplate: (templateName: string) => Promise<void>; createDataStream: (dataStream: string) => Promise<void>; deleteIndex: (indexName: string) => Promise<void>; deleteAlias: (indexName: string, aliasName: string) => Promise<void>; deleteLegacyTemplate: (templateName: string) => Promise<void>; deleteIndexTemplate: (templateName: string) => Promise<void>; deleteComponentTemplate: (templateName: string) => Promise<void>; deleteDataStream: (dataStream: string) => Promise<void>; }; deployment: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.DeploymentService",
|
|
"text": "DeploymentService"
|
|
},
|
|
"; esDeleteAllIndices: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => (patterns: string | string[], remote?: boolean) => Promise<void>; indexPatterns: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
},
|
|
"; savedObjectInfo: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SavedObjectInfoService",
|
|
"text": "SavedObjectInfoService"
|
|
},
|
|
"; randomness: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RandomnessService",
|
|
"text": "RandomnessService"
|
|
},
|
|
"; samlAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { getInteractiveUserSessionCookieWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<string>; getM2MApiCookieCredentialsWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getM2MApiCookieCredentialsWithCustomRoleScope(options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getEmail(role: string): Promise<string>; getUserData(role: string): Promise<",
|
|
"UserProfile",
|
|
">; checkRoleIsSupported(role: string): void; createM2mApiKeyWithDefaultRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithRoleScope(role: string): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithCustomRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; invalidateM2mApiKeyWithRoleScope(roleCredentials: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
"): Promise<void>; setCustomRole(descriptors: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.KibanaRoleDescriptors",
|
|
"text": "KibanaRoleDescriptors"
|
|
},
|
|
"): Promise<void>; deleteCustomRole(): Promise<void>; getCommonRequestHeader(): { 'kbn-xsrf': string; }; getInternalRequestHeader(): ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.InternalRequestHeader",
|
|
"text": "InternalRequestHeader"
|
|
},
|
|
"; DEFAULT_ROLE: string; CUSTOM_ROLE: string; }; supertest: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; esSupertest: ({ getService, }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; supertestWithoutAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"node_modules/@types/supertest/lib/agent",
|
|
"<",
|
|
"SuperTestStatic",
|
|
".Test>; security: (ctx: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SecurityService",
|
|
"text": "SecurityService"
|
|
},
|
|
">; }, {}, ProvidedTypeMap<{ es: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"default",
|
|
"; kibanaServer: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.KbnClient",
|
|
"text": "KbnClient"
|
|
},
|
|
"; esArchiver: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/es-archiver",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsArchiverPluginApi",
|
|
"section": "def-common.EsArchiver",
|
|
"text": "EsArchiver"
|
|
},
|
|
"; retry: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RetryService",
|
|
"text": "RetryService"
|
|
},
|
|
"; search: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SearchService",
|
|
"text": "SearchService"
|
|
},
|
|
"; console: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { createIndex: (indexName: string) => Promise<void>; createAlias: (indexName: string, aliasName: string) => Promise<void>; createLegacyTemplate: (templateName: string) => Promise<void>; createIndexTemplate: (templateName: string, indexPatterns: string[], composedOf: string[]) => Promise<void>; createComponentTemplate: (templateName: string) => Promise<void>; createDataStream: (dataStream: string) => Promise<void>; deleteIndex: (indexName: string) => Promise<void>; deleteAlias: (indexName: string, aliasName: string) => Promise<void>; deleteLegacyTemplate: (templateName: string) => Promise<void>; deleteIndexTemplate: (templateName: string) => Promise<void>; deleteComponentTemplate: (templateName: string) => Promise<void>; deleteDataStream: (dataStream: string) => Promise<void>; }; deployment: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.DeploymentService",
|
|
"text": "DeploymentService"
|
|
},
|
|
"; esDeleteAllIndices: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => (patterns: string | string[], remote?: boolean) => Promise<void>; indexPatterns: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
},
|
|
"; savedObjectInfo: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SavedObjectInfoService",
|
|
"text": "SavedObjectInfoService"
|
|
},
|
|
"; randomness: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RandomnessService",
|
|
"text": "RandomnessService"
|
|
},
|
|
"; samlAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { getInteractiveUserSessionCookieWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<string>; getM2MApiCookieCredentialsWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getM2MApiCookieCredentialsWithCustomRoleScope(options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getEmail(role: string): Promise<string>; getUserData(role: string): Promise<",
|
|
"UserProfile",
|
|
">; checkRoleIsSupported(role: string): void; createM2mApiKeyWithDefaultRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithRoleScope(role: string): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithCustomRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; invalidateM2mApiKeyWithRoleScope(roleCredentials: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
"): Promise<void>; setCustomRole(descriptors: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.KibanaRoleDescriptors",
|
|
"text": "KibanaRoleDescriptors"
|
|
},
|
|
"): Promise<void>; deleteCustomRole(): Promise<void>; getCommonRequestHeader(): { 'kbn-xsrf': string; }; getInternalRequestHeader(): ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.InternalRequestHeader",
|
|
"text": "InternalRequestHeader"
|
|
},
|
|
"; DEFAULT_ROLE: string; CUSTOM_ROLE: string; }; supertest: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; esSupertest: ({ getService, }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; supertestWithoutAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"node_modules/@types/supertest/lib/agent",
|
|
"<",
|
|
"SuperTestStatic",
|
|
".Test>; security: (ctx: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SecurityService",
|
|
"text": "SecurityService"
|
|
},
|
|
">; }>, ProvidedTypeMap<{}>>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/es.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.services.kibanaServer",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "kibanaServer",
|
|
"description": [],
|
|
"signature": [
|
|
"({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.KbnClient",
|
|
"text": "KbnClient"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/all.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.services.kibanaServer.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "__0",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GenericFtrProviderContext",
|
|
"text": "GenericFtrProviderContext"
|
|
},
|
|
"<{ es: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"default",
|
|
"; kibanaServer: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.KbnClient",
|
|
"text": "KbnClient"
|
|
},
|
|
"; esArchiver: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/es-archiver",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsArchiverPluginApi",
|
|
"section": "def-common.EsArchiver",
|
|
"text": "EsArchiver"
|
|
},
|
|
"; retry: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RetryService",
|
|
"text": "RetryService"
|
|
},
|
|
"; search: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SearchService",
|
|
"text": "SearchService"
|
|
},
|
|
"; console: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { createIndex: (indexName: string) => Promise<void>; createAlias: (indexName: string, aliasName: string) => Promise<void>; createLegacyTemplate: (templateName: string) => Promise<void>; createIndexTemplate: (templateName: string, indexPatterns: string[], composedOf: string[]) => Promise<void>; createComponentTemplate: (templateName: string) => Promise<void>; createDataStream: (dataStream: string) => Promise<void>; deleteIndex: (indexName: string) => Promise<void>; deleteAlias: (indexName: string, aliasName: string) => Promise<void>; deleteLegacyTemplate: (templateName: string) => Promise<void>; deleteIndexTemplate: (templateName: string) => Promise<void>; deleteComponentTemplate: (templateName: string) => Promise<void>; deleteDataStream: (dataStream: string) => Promise<void>; }; deployment: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.DeploymentService",
|
|
"text": "DeploymentService"
|
|
},
|
|
"; esDeleteAllIndices: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => (patterns: string | string[], remote?: boolean) => Promise<void>; indexPatterns: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
},
|
|
"; savedObjectInfo: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SavedObjectInfoService",
|
|
"text": "SavedObjectInfoService"
|
|
},
|
|
"; randomness: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RandomnessService",
|
|
"text": "RandomnessService"
|
|
},
|
|
"; samlAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { getInteractiveUserSessionCookieWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<string>; getM2MApiCookieCredentialsWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getM2MApiCookieCredentialsWithCustomRoleScope(options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getEmail(role: string): Promise<string>; getUserData(role: string): Promise<",
|
|
"UserProfile",
|
|
">; checkRoleIsSupported(role: string): void; createM2mApiKeyWithDefaultRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithRoleScope(role: string): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithCustomRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; invalidateM2mApiKeyWithRoleScope(roleCredentials: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
"): Promise<void>; setCustomRole(descriptors: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.KibanaRoleDescriptors",
|
|
"text": "KibanaRoleDescriptors"
|
|
},
|
|
"): Promise<void>; deleteCustomRole(): Promise<void>; getCommonRequestHeader(): { 'kbn-xsrf': string; }; getInternalRequestHeader(): ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.InternalRequestHeader",
|
|
"text": "InternalRequestHeader"
|
|
},
|
|
"; DEFAULT_ROLE: string; CUSTOM_ROLE: string; }; supertest: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; esSupertest: ({ getService, }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; supertestWithoutAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"node_modules/@types/supertest/lib/agent",
|
|
"<",
|
|
"SuperTestStatic",
|
|
".Test>; security: (ctx: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SecurityService",
|
|
"text": "SecurityService"
|
|
},
|
|
">; }, {}, ProvidedTypeMap<{ es: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"default",
|
|
"; kibanaServer: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.KbnClient",
|
|
"text": "KbnClient"
|
|
},
|
|
"; esArchiver: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/es-archiver",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsArchiverPluginApi",
|
|
"section": "def-common.EsArchiver",
|
|
"text": "EsArchiver"
|
|
},
|
|
"; retry: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RetryService",
|
|
"text": "RetryService"
|
|
},
|
|
"; search: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SearchService",
|
|
"text": "SearchService"
|
|
},
|
|
"; console: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { createIndex: (indexName: string) => Promise<void>; createAlias: (indexName: string, aliasName: string) => Promise<void>; createLegacyTemplate: (templateName: string) => Promise<void>; createIndexTemplate: (templateName: string, indexPatterns: string[], composedOf: string[]) => Promise<void>; createComponentTemplate: (templateName: string) => Promise<void>; createDataStream: (dataStream: string) => Promise<void>; deleteIndex: (indexName: string) => Promise<void>; deleteAlias: (indexName: string, aliasName: string) => Promise<void>; deleteLegacyTemplate: (templateName: string) => Promise<void>; deleteIndexTemplate: (templateName: string) => Promise<void>; deleteComponentTemplate: (templateName: string) => Promise<void>; deleteDataStream: (dataStream: string) => Promise<void>; }; deployment: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.DeploymentService",
|
|
"text": "DeploymentService"
|
|
},
|
|
"; esDeleteAllIndices: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => (patterns: string | string[], remote?: boolean) => Promise<void>; indexPatterns: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
},
|
|
"; savedObjectInfo: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SavedObjectInfoService",
|
|
"text": "SavedObjectInfoService"
|
|
},
|
|
"; randomness: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RandomnessService",
|
|
"text": "RandomnessService"
|
|
},
|
|
"; samlAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { getInteractiveUserSessionCookieWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<string>; getM2MApiCookieCredentialsWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getM2MApiCookieCredentialsWithCustomRoleScope(options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getEmail(role: string): Promise<string>; getUserData(role: string): Promise<",
|
|
"UserProfile",
|
|
">; checkRoleIsSupported(role: string): void; createM2mApiKeyWithDefaultRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithRoleScope(role: string): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithCustomRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; invalidateM2mApiKeyWithRoleScope(roleCredentials: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
"): Promise<void>; setCustomRole(descriptors: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.KibanaRoleDescriptors",
|
|
"text": "KibanaRoleDescriptors"
|
|
},
|
|
"): Promise<void>; deleteCustomRole(): Promise<void>; getCommonRequestHeader(): { 'kbn-xsrf': string; }; getInternalRequestHeader(): ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.InternalRequestHeader",
|
|
"text": "InternalRequestHeader"
|
|
},
|
|
"; DEFAULT_ROLE: string; CUSTOM_ROLE: string; }; supertest: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; esSupertest: ({ getService, }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; supertestWithoutAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"node_modules/@types/supertest/lib/agent",
|
|
"<",
|
|
"SuperTestStatic",
|
|
".Test>; security: (ctx: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SecurityService",
|
|
"text": "SecurityService"
|
|
},
|
|
">; }>, ProvidedTypeMap<{}>>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/kibana_server/kibana_server.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.services.esArchiver",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "esArchiver",
|
|
"description": [],
|
|
"signature": [
|
|
"({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/es-archiver",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsArchiverPluginApi",
|
|
"section": "def-common.EsArchiver",
|
|
"text": "EsArchiver"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/all.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.services.esArchiver.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "__0",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GenericFtrProviderContext",
|
|
"text": "GenericFtrProviderContext"
|
|
},
|
|
"<{ es: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"default",
|
|
"; kibanaServer: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.KbnClient",
|
|
"text": "KbnClient"
|
|
},
|
|
"; esArchiver: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/es-archiver",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsArchiverPluginApi",
|
|
"section": "def-common.EsArchiver",
|
|
"text": "EsArchiver"
|
|
},
|
|
"; retry: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RetryService",
|
|
"text": "RetryService"
|
|
},
|
|
"; search: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SearchService",
|
|
"text": "SearchService"
|
|
},
|
|
"; console: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { createIndex: (indexName: string) => Promise<void>; createAlias: (indexName: string, aliasName: string) => Promise<void>; createLegacyTemplate: (templateName: string) => Promise<void>; createIndexTemplate: (templateName: string, indexPatterns: string[], composedOf: string[]) => Promise<void>; createComponentTemplate: (templateName: string) => Promise<void>; createDataStream: (dataStream: string) => Promise<void>; deleteIndex: (indexName: string) => Promise<void>; deleteAlias: (indexName: string, aliasName: string) => Promise<void>; deleteLegacyTemplate: (templateName: string) => Promise<void>; deleteIndexTemplate: (templateName: string) => Promise<void>; deleteComponentTemplate: (templateName: string) => Promise<void>; deleteDataStream: (dataStream: string) => Promise<void>; }; deployment: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.DeploymentService",
|
|
"text": "DeploymentService"
|
|
},
|
|
"; esDeleteAllIndices: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => (patterns: string | string[], remote?: boolean) => Promise<void>; indexPatterns: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
},
|
|
"; savedObjectInfo: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SavedObjectInfoService",
|
|
"text": "SavedObjectInfoService"
|
|
},
|
|
"; randomness: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RandomnessService",
|
|
"text": "RandomnessService"
|
|
},
|
|
"; samlAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { getInteractiveUserSessionCookieWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<string>; getM2MApiCookieCredentialsWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getM2MApiCookieCredentialsWithCustomRoleScope(options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getEmail(role: string): Promise<string>; getUserData(role: string): Promise<",
|
|
"UserProfile",
|
|
">; checkRoleIsSupported(role: string): void; createM2mApiKeyWithDefaultRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithRoleScope(role: string): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithCustomRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; invalidateM2mApiKeyWithRoleScope(roleCredentials: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
"): Promise<void>; setCustomRole(descriptors: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.KibanaRoleDescriptors",
|
|
"text": "KibanaRoleDescriptors"
|
|
},
|
|
"): Promise<void>; deleteCustomRole(): Promise<void>; getCommonRequestHeader(): { 'kbn-xsrf': string; }; getInternalRequestHeader(): ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.InternalRequestHeader",
|
|
"text": "InternalRequestHeader"
|
|
},
|
|
"; DEFAULT_ROLE: string; CUSTOM_ROLE: string; }; supertest: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; esSupertest: ({ getService, }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; supertestWithoutAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"node_modules/@types/supertest/lib/agent",
|
|
"<",
|
|
"SuperTestStatic",
|
|
".Test>; security: (ctx: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SecurityService",
|
|
"text": "SecurityService"
|
|
},
|
|
">; }, {}, ProvidedTypeMap<{ es: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"default",
|
|
"; kibanaServer: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.KbnClient",
|
|
"text": "KbnClient"
|
|
},
|
|
"; esArchiver: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/es-archiver",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsArchiverPluginApi",
|
|
"section": "def-common.EsArchiver",
|
|
"text": "EsArchiver"
|
|
},
|
|
"; retry: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RetryService",
|
|
"text": "RetryService"
|
|
},
|
|
"; search: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SearchService",
|
|
"text": "SearchService"
|
|
},
|
|
"; console: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { createIndex: (indexName: string) => Promise<void>; createAlias: (indexName: string, aliasName: string) => Promise<void>; createLegacyTemplate: (templateName: string) => Promise<void>; createIndexTemplate: (templateName: string, indexPatterns: string[], composedOf: string[]) => Promise<void>; createComponentTemplate: (templateName: string) => Promise<void>; createDataStream: (dataStream: string) => Promise<void>; deleteIndex: (indexName: string) => Promise<void>; deleteAlias: (indexName: string, aliasName: string) => Promise<void>; deleteLegacyTemplate: (templateName: string) => Promise<void>; deleteIndexTemplate: (templateName: string) => Promise<void>; deleteComponentTemplate: (templateName: string) => Promise<void>; deleteDataStream: (dataStream: string) => Promise<void>; }; deployment: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.DeploymentService",
|
|
"text": "DeploymentService"
|
|
},
|
|
"; esDeleteAllIndices: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => (patterns: string | string[], remote?: boolean) => Promise<void>; indexPatterns: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
},
|
|
"; savedObjectInfo: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SavedObjectInfoService",
|
|
"text": "SavedObjectInfoService"
|
|
},
|
|
"; randomness: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RandomnessService",
|
|
"text": "RandomnessService"
|
|
},
|
|
"; samlAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { getInteractiveUserSessionCookieWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<string>; getM2MApiCookieCredentialsWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getM2MApiCookieCredentialsWithCustomRoleScope(options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getEmail(role: string): Promise<string>; getUserData(role: string): Promise<",
|
|
"UserProfile",
|
|
">; checkRoleIsSupported(role: string): void; createM2mApiKeyWithDefaultRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithRoleScope(role: string): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithCustomRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; invalidateM2mApiKeyWithRoleScope(roleCredentials: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
"): Promise<void>; setCustomRole(descriptors: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.KibanaRoleDescriptors",
|
|
"text": "KibanaRoleDescriptors"
|
|
},
|
|
"): Promise<void>; deleteCustomRole(): Promise<void>; getCommonRequestHeader(): { 'kbn-xsrf': string; }; getInternalRequestHeader(): ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.InternalRequestHeader",
|
|
"text": "InternalRequestHeader"
|
|
},
|
|
"; DEFAULT_ROLE: string; CUSTOM_ROLE: string; }; supertest: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; esSupertest: ({ getService, }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; supertestWithoutAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"node_modules/@types/supertest/lib/agent",
|
|
"<",
|
|
"SuperTestStatic",
|
|
".Test>; security: (ctx: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SecurityService",
|
|
"text": "SecurityService"
|
|
},
|
|
">; }>, ProvidedTypeMap<{}>>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/es_archiver.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.services.retry",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "retry",
|
|
"description": [],
|
|
"signature": [
|
|
"typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RetryService",
|
|
"text": "RetryService"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/all.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.services.search",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "search",
|
|
"description": [],
|
|
"signature": [
|
|
"typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SearchService",
|
|
"text": "SearchService"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/all.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.services.console",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "console",
|
|
"description": [],
|
|
"signature": [
|
|
"({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { createIndex: (indexName: string) => Promise<void>; createAlias: (indexName: string, aliasName: string) => Promise<void>; createLegacyTemplate: (templateName: string) => Promise<void>; createIndexTemplate: (templateName: string, indexPatterns: string[], composedOf: string[]) => Promise<void>; createComponentTemplate: (templateName: string) => Promise<void>; createDataStream: (dataStream: string) => Promise<void>; deleteIndex: (indexName: string) => Promise<void>; deleteAlias: (indexName: string, aliasName: string) => Promise<void>; deleteLegacyTemplate: (templateName: string) => Promise<void>; deleteIndexTemplate: (templateName: string) => Promise<void>; deleteComponentTemplate: (templateName: string) => Promise<void>; deleteDataStream: (dataStream: string) => Promise<void>; }"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/all.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.services.console.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "__0",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GenericFtrProviderContext",
|
|
"text": "GenericFtrProviderContext"
|
|
},
|
|
"<{ es: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"default",
|
|
"; kibanaServer: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.KbnClient",
|
|
"text": "KbnClient"
|
|
},
|
|
"; esArchiver: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/es-archiver",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsArchiverPluginApi",
|
|
"section": "def-common.EsArchiver",
|
|
"text": "EsArchiver"
|
|
},
|
|
"; retry: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RetryService",
|
|
"text": "RetryService"
|
|
},
|
|
"; search: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SearchService",
|
|
"text": "SearchService"
|
|
},
|
|
"; console: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { createIndex: (indexName: string) => Promise<void>; createAlias: (indexName: string, aliasName: string) => Promise<void>; createLegacyTemplate: (templateName: string) => Promise<void>; createIndexTemplate: (templateName: string, indexPatterns: string[], composedOf: string[]) => Promise<void>; createComponentTemplate: (templateName: string) => Promise<void>; createDataStream: (dataStream: string) => Promise<void>; deleteIndex: (indexName: string) => Promise<void>; deleteAlias: (indexName: string, aliasName: string) => Promise<void>; deleteLegacyTemplate: (templateName: string) => Promise<void>; deleteIndexTemplate: (templateName: string) => Promise<void>; deleteComponentTemplate: (templateName: string) => Promise<void>; deleteDataStream: (dataStream: string) => Promise<void>; }; deployment: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.DeploymentService",
|
|
"text": "DeploymentService"
|
|
},
|
|
"; esDeleteAllIndices: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => (patterns: string | string[], remote?: boolean) => Promise<void>; indexPatterns: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
},
|
|
"; savedObjectInfo: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SavedObjectInfoService",
|
|
"text": "SavedObjectInfoService"
|
|
},
|
|
"; randomness: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RandomnessService",
|
|
"text": "RandomnessService"
|
|
},
|
|
"; samlAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { getInteractiveUserSessionCookieWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<string>; getM2MApiCookieCredentialsWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getM2MApiCookieCredentialsWithCustomRoleScope(options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getEmail(role: string): Promise<string>; getUserData(role: string): Promise<",
|
|
"UserProfile",
|
|
">; checkRoleIsSupported(role: string): void; createM2mApiKeyWithDefaultRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithRoleScope(role: string): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithCustomRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; invalidateM2mApiKeyWithRoleScope(roleCredentials: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
"): Promise<void>; setCustomRole(descriptors: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.KibanaRoleDescriptors",
|
|
"text": "KibanaRoleDescriptors"
|
|
},
|
|
"): Promise<void>; deleteCustomRole(): Promise<void>; getCommonRequestHeader(): { 'kbn-xsrf': string; }; getInternalRequestHeader(): ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.InternalRequestHeader",
|
|
"text": "InternalRequestHeader"
|
|
},
|
|
"; DEFAULT_ROLE: string; CUSTOM_ROLE: string; }; supertest: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; esSupertest: ({ getService, }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; supertestWithoutAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"node_modules/@types/supertest/lib/agent",
|
|
"<",
|
|
"SuperTestStatic",
|
|
".Test>; security: (ctx: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SecurityService",
|
|
"text": "SecurityService"
|
|
},
|
|
">; }, {}, ProvidedTypeMap<{ es: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"default",
|
|
"; kibanaServer: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.KbnClient",
|
|
"text": "KbnClient"
|
|
},
|
|
"; esArchiver: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/es-archiver",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsArchiverPluginApi",
|
|
"section": "def-common.EsArchiver",
|
|
"text": "EsArchiver"
|
|
},
|
|
"; retry: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RetryService",
|
|
"text": "RetryService"
|
|
},
|
|
"; search: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SearchService",
|
|
"text": "SearchService"
|
|
},
|
|
"; console: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { createIndex: (indexName: string) => Promise<void>; createAlias: (indexName: string, aliasName: string) => Promise<void>; createLegacyTemplate: (templateName: string) => Promise<void>; createIndexTemplate: (templateName: string, indexPatterns: string[], composedOf: string[]) => Promise<void>; createComponentTemplate: (templateName: string) => Promise<void>; createDataStream: (dataStream: string) => Promise<void>; deleteIndex: (indexName: string) => Promise<void>; deleteAlias: (indexName: string, aliasName: string) => Promise<void>; deleteLegacyTemplate: (templateName: string) => Promise<void>; deleteIndexTemplate: (templateName: string) => Promise<void>; deleteComponentTemplate: (templateName: string) => Promise<void>; deleteDataStream: (dataStream: string) => Promise<void>; }; deployment: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.DeploymentService",
|
|
"text": "DeploymentService"
|
|
},
|
|
"; esDeleteAllIndices: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => (patterns: string | string[], remote?: boolean) => Promise<void>; indexPatterns: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
},
|
|
"; savedObjectInfo: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SavedObjectInfoService",
|
|
"text": "SavedObjectInfoService"
|
|
},
|
|
"; randomness: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RandomnessService",
|
|
"text": "RandomnessService"
|
|
},
|
|
"; samlAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { getInteractiveUserSessionCookieWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<string>; getM2MApiCookieCredentialsWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getM2MApiCookieCredentialsWithCustomRoleScope(options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getEmail(role: string): Promise<string>; getUserData(role: string): Promise<",
|
|
"UserProfile",
|
|
">; checkRoleIsSupported(role: string): void; createM2mApiKeyWithDefaultRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithRoleScope(role: string): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithCustomRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; invalidateM2mApiKeyWithRoleScope(roleCredentials: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
"): Promise<void>; setCustomRole(descriptors: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.KibanaRoleDescriptors",
|
|
"text": "KibanaRoleDescriptors"
|
|
},
|
|
"): Promise<void>; deleteCustomRole(): Promise<void>; getCommonRequestHeader(): { 'kbn-xsrf': string; }; getInternalRequestHeader(): ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.InternalRequestHeader",
|
|
"text": "InternalRequestHeader"
|
|
},
|
|
"; DEFAULT_ROLE: string; CUSTOM_ROLE: string; }; supertest: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; esSupertest: ({ getService, }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; supertestWithoutAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"node_modules/@types/supertest/lib/agent",
|
|
"<",
|
|
"SuperTestStatic",
|
|
".Test>; security: (ctx: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SecurityService",
|
|
"text": "SecurityService"
|
|
},
|
|
">; }>, ProvidedTypeMap<{}>>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/console.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.services.deployment",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "deployment",
|
|
"description": [],
|
|
"signature": [
|
|
"typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.DeploymentService",
|
|
"text": "DeploymentService"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/all.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.services.esDeleteAllIndices",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "esDeleteAllIndices",
|
|
"description": [],
|
|
"signature": [
|
|
"({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => (patterns: string | string[], remote?: boolean) => Promise<void>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/all.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.services.esDeleteAllIndices.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "__0",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GenericFtrProviderContext",
|
|
"text": "GenericFtrProviderContext"
|
|
},
|
|
"<{ es: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"default",
|
|
"; kibanaServer: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.KbnClient",
|
|
"text": "KbnClient"
|
|
},
|
|
"; esArchiver: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/es-archiver",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsArchiverPluginApi",
|
|
"section": "def-common.EsArchiver",
|
|
"text": "EsArchiver"
|
|
},
|
|
"; retry: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RetryService",
|
|
"text": "RetryService"
|
|
},
|
|
"; search: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SearchService",
|
|
"text": "SearchService"
|
|
},
|
|
"; console: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { createIndex: (indexName: string) => Promise<void>; createAlias: (indexName: string, aliasName: string) => Promise<void>; createLegacyTemplate: (templateName: string) => Promise<void>; createIndexTemplate: (templateName: string, indexPatterns: string[], composedOf: string[]) => Promise<void>; createComponentTemplate: (templateName: string) => Promise<void>; createDataStream: (dataStream: string) => Promise<void>; deleteIndex: (indexName: string) => Promise<void>; deleteAlias: (indexName: string, aliasName: string) => Promise<void>; deleteLegacyTemplate: (templateName: string) => Promise<void>; deleteIndexTemplate: (templateName: string) => Promise<void>; deleteComponentTemplate: (templateName: string) => Promise<void>; deleteDataStream: (dataStream: string) => Promise<void>; }; deployment: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.DeploymentService",
|
|
"text": "DeploymentService"
|
|
},
|
|
"; esDeleteAllIndices: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => (patterns: string | string[], remote?: boolean) => Promise<void>; indexPatterns: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
},
|
|
"; savedObjectInfo: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SavedObjectInfoService",
|
|
"text": "SavedObjectInfoService"
|
|
},
|
|
"; randomness: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RandomnessService",
|
|
"text": "RandomnessService"
|
|
},
|
|
"; samlAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { getInteractiveUserSessionCookieWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<string>; getM2MApiCookieCredentialsWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getM2MApiCookieCredentialsWithCustomRoleScope(options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getEmail(role: string): Promise<string>; getUserData(role: string): Promise<",
|
|
"UserProfile",
|
|
">; checkRoleIsSupported(role: string): void; createM2mApiKeyWithDefaultRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithRoleScope(role: string): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithCustomRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; invalidateM2mApiKeyWithRoleScope(roleCredentials: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
"): Promise<void>; setCustomRole(descriptors: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.KibanaRoleDescriptors",
|
|
"text": "KibanaRoleDescriptors"
|
|
},
|
|
"): Promise<void>; deleteCustomRole(): Promise<void>; getCommonRequestHeader(): { 'kbn-xsrf': string; }; getInternalRequestHeader(): ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.InternalRequestHeader",
|
|
"text": "InternalRequestHeader"
|
|
},
|
|
"; DEFAULT_ROLE: string; CUSTOM_ROLE: string; }; supertest: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; esSupertest: ({ getService, }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; supertestWithoutAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"node_modules/@types/supertest/lib/agent",
|
|
"<",
|
|
"SuperTestStatic",
|
|
".Test>; security: (ctx: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SecurityService",
|
|
"text": "SecurityService"
|
|
},
|
|
">; }, {}, ProvidedTypeMap<{ es: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"default",
|
|
"; kibanaServer: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.KbnClient",
|
|
"text": "KbnClient"
|
|
},
|
|
"; esArchiver: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/es-archiver",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsArchiverPluginApi",
|
|
"section": "def-common.EsArchiver",
|
|
"text": "EsArchiver"
|
|
},
|
|
"; retry: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RetryService",
|
|
"text": "RetryService"
|
|
},
|
|
"; search: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SearchService",
|
|
"text": "SearchService"
|
|
},
|
|
"; console: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { createIndex: (indexName: string) => Promise<void>; createAlias: (indexName: string, aliasName: string) => Promise<void>; createLegacyTemplate: (templateName: string) => Promise<void>; createIndexTemplate: (templateName: string, indexPatterns: string[], composedOf: string[]) => Promise<void>; createComponentTemplate: (templateName: string) => Promise<void>; createDataStream: (dataStream: string) => Promise<void>; deleteIndex: (indexName: string) => Promise<void>; deleteAlias: (indexName: string, aliasName: string) => Promise<void>; deleteLegacyTemplate: (templateName: string) => Promise<void>; deleteIndexTemplate: (templateName: string) => Promise<void>; deleteComponentTemplate: (templateName: string) => Promise<void>; deleteDataStream: (dataStream: string) => Promise<void>; }; deployment: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.DeploymentService",
|
|
"text": "DeploymentService"
|
|
},
|
|
"; esDeleteAllIndices: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => (patterns: string | string[], remote?: boolean) => Promise<void>; indexPatterns: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
},
|
|
"; savedObjectInfo: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SavedObjectInfoService",
|
|
"text": "SavedObjectInfoService"
|
|
},
|
|
"; randomness: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RandomnessService",
|
|
"text": "RandomnessService"
|
|
},
|
|
"; samlAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { getInteractiveUserSessionCookieWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<string>; getM2MApiCookieCredentialsWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getM2MApiCookieCredentialsWithCustomRoleScope(options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getEmail(role: string): Promise<string>; getUserData(role: string): Promise<",
|
|
"UserProfile",
|
|
">; checkRoleIsSupported(role: string): void; createM2mApiKeyWithDefaultRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithRoleScope(role: string): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithCustomRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; invalidateM2mApiKeyWithRoleScope(roleCredentials: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
"): Promise<void>; setCustomRole(descriptors: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.KibanaRoleDescriptors",
|
|
"text": "KibanaRoleDescriptors"
|
|
},
|
|
"): Promise<void>; deleteCustomRole(): Promise<void>; getCommonRequestHeader(): { 'kbn-xsrf': string; }; getInternalRequestHeader(): ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.InternalRequestHeader",
|
|
"text": "InternalRequestHeader"
|
|
},
|
|
"; DEFAULT_ROLE: string; CUSTOM_ROLE: string; }; supertest: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; esSupertest: ({ getService, }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; supertestWithoutAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"node_modules/@types/supertest/lib/agent",
|
|
"<",
|
|
"SuperTestStatic",
|
|
".Test>; security: (ctx: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SecurityService",
|
|
"text": "SecurityService"
|
|
},
|
|
">; }>, ProvidedTypeMap<{}>>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/es_delete_all_indices.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.services.indexPatterns",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "indexPatterns",
|
|
"description": [],
|
|
"signature": [
|
|
"typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/all.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.services.savedObjectInfo",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedObjectInfo",
|
|
"description": [],
|
|
"signature": [
|
|
"typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SavedObjectInfoService",
|
|
"text": "SavedObjectInfoService"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/all.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.services.randomness",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "randomness",
|
|
"description": [],
|
|
"signature": [
|
|
"typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RandomnessService",
|
|
"text": "RandomnessService"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/all.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.services.samlAuth",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "samlAuth",
|
|
"description": [],
|
|
"signature": [
|
|
"({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { getInteractiveUserSessionCookieWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<string>; getM2MApiCookieCredentialsWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getM2MApiCookieCredentialsWithCustomRoleScope(options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getEmail(role: string): Promise<string>; getUserData(role: string): Promise<",
|
|
"UserProfile",
|
|
">; checkRoleIsSupported(role: string): void; createM2mApiKeyWithDefaultRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithRoleScope(role: string): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithCustomRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; invalidateM2mApiKeyWithRoleScope(roleCredentials: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
"): Promise<void>; setCustomRole(descriptors: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.KibanaRoleDescriptors",
|
|
"text": "KibanaRoleDescriptors"
|
|
},
|
|
"): Promise<void>; deleteCustomRole(): Promise<void>; getCommonRequestHeader(): { 'kbn-xsrf': string; }; getInternalRequestHeader(): ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.InternalRequestHeader",
|
|
"text": "InternalRequestHeader"
|
|
},
|
|
"; DEFAULT_ROLE: string; CUSTOM_ROLE: string; }"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/all.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.services.samlAuth.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "__0",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GenericFtrProviderContext",
|
|
"text": "GenericFtrProviderContext"
|
|
},
|
|
"<{ es: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"default",
|
|
"; kibanaServer: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.KbnClient",
|
|
"text": "KbnClient"
|
|
},
|
|
"; esArchiver: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/es-archiver",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsArchiverPluginApi",
|
|
"section": "def-common.EsArchiver",
|
|
"text": "EsArchiver"
|
|
},
|
|
"; retry: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RetryService",
|
|
"text": "RetryService"
|
|
},
|
|
"; search: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SearchService",
|
|
"text": "SearchService"
|
|
},
|
|
"; console: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { createIndex: (indexName: string) => Promise<void>; createAlias: (indexName: string, aliasName: string) => Promise<void>; createLegacyTemplate: (templateName: string) => Promise<void>; createIndexTemplate: (templateName: string, indexPatterns: string[], composedOf: string[]) => Promise<void>; createComponentTemplate: (templateName: string) => Promise<void>; createDataStream: (dataStream: string) => Promise<void>; deleteIndex: (indexName: string) => Promise<void>; deleteAlias: (indexName: string, aliasName: string) => Promise<void>; deleteLegacyTemplate: (templateName: string) => Promise<void>; deleteIndexTemplate: (templateName: string) => Promise<void>; deleteComponentTemplate: (templateName: string) => Promise<void>; deleteDataStream: (dataStream: string) => Promise<void>; }; deployment: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.DeploymentService",
|
|
"text": "DeploymentService"
|
|
},
|
|
"; esDeleteAllIndices: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => (patterns: string | string[], remote?: boolean) => Promise<void>; indexPatterns: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
},
|
|
"; savedObjectInfo: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SavedObjectInfoService",
|
|
"text": "SavedObjectInfoService"
|
|
},
|
|
"; randomness: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RandomnessService",
|
|
"text": "RandomnessService"
|
|
},
|
|
"; samlAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { getInteractiveUserSessionCookieWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<string>; getM2MApiCookieCredentialsWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getM2MApiCookieCredentialsWithCustomRoleScope(options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getEmail(role: string): Promise<string>; getUserData(role: string): Promise<",
|
|
"UserProfile",
|
|
">; checkRoleIsSupported(role: string): void; createM2mApiKeyWithDefaultRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithRoleScope(role: string): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithCustomRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; invalidateM2mApiKeyWithRoleScope(roleCredentials: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
"): Promise<void>; setCustomRole(descriptors: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.KibanaRoleDescriptors",
|
|
"text": "KibanaRoleDescriptors"
|
|
},
|
|
"): Promise<void>; deleteCustomRole(): Promise<void>; getCommonRequestHeader(): { 'kbn-xsrf': string; }; getInternalRequestHeader(): ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.InternalRequestHeader",
|
|
"text": "InternalRequestHeader"
|
|
},
|
|
"; DEFAULT_ROLE: string; CUSTOM_ROLE: string; }; supertest: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; esSupertest: ({ getService, }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; supertestWithoutAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"node_modules/@types/supertest/lib/agent",
|
|
"<",
|
|
"SuperTestStatic",
|
|
".Test>; security: (ctx: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SecurityService",
|
|
"text": "SecurityService"
|
|
},
|
|
">; }, {}, ProvidedTypeMap<{ es: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"default",
|
|
"; kibanaServer: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.KbnClient",
|
|
"text": "KbnClient"
|
|
},
|
|
"; esArchiver: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/es-archiver",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsArchiverPluginApi",
|
|
"section": "def-common.EsArchiver",
|
|
"text": "EsArchiver"
|
|
},
|
|
"; retry: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RetryService",
|
|
"text": "RetryService"
|
|
},
|
|
"; search: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SearchService",
|
|
"text": "SearchService"
|
|
},
|
|
"; console: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { createIndex: (indexName: string) => Promise<void>; createAlias: (indexName: string, aliasName: string) => Promise<void>; createLegacyTemplate: (templateName: string) => Promise<void>; createIndexTemplate: (templateName: string, indexPatterns: string[], composedOf: string[]) => Promise<void>; createComponentTemplate: (templateName: string) => Promise<void>; createDataStream: (dataStream: string) => Promise<void>; deleteIndex: (indexName: string) => Promise<void>; deleteAlias: (indexName: string, aliasName: string) => Promise<void>; deleteLegacyTemplate: (templateName: string) => Promise<void>; deleteIndexTemplate: (templateName: string) => Promise<void>; deleteComponentTemplate: (templateName: string) => Promise<void>; deleteDataStream: (dataStream: string) => Promise<void>; }; deployment: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.DeploymentService",
|
|
"text": "DeploymentService"
|
|
},
|
|
"; esDeleteAllIndices: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => (patterns: string | string[], remote?: boolean) => Promise<void>; indexPatterns: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
},
|
|
"; savedObjectInfo: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SavedObjectInfoService",
|
|
"text": "SavedObjectInfoService"
|
|
},
|
|
"; randomness: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RandomnessService",
|
|
"text": "RandomnessService"
|
|
},
|
|
"; samlAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { getInteractiveUserSessionCookieWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<string>; getM2MApiCookieCredentialsWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getM2MApiCookieCredentialsWithCustomRoleScope(options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getEmail(role: string): Promise<string>; getUserData(role: string): Promise<",
|
|
"UserProfile",
|
|
">; checkRoleIsSupported(role: string): void; createM2mApiKeyWithDefaultRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithRoleScope(role: string): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithCustomRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; invalidateM2mApiKeyWithRoleScope(roleCredentials: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
"): Promise<void>; setCustomRole(descriptors: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.KibanaRoleDescriptors",
|
|
"text": "KibanaRoleDescriptors"
|
|
},
|
|
"): Promise<void>; deleteCustomRole(): Promise<void>; getCommonRequestHeader(): { 'kbn-xsrf': string; }; getInternalRequestHeader(): ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.InternalRequestHeader",
|
|
"text": "InternalRequestHeader"
|
|
},
|
|
"; DEFAULT_ROLE: string; CUSTOM_ROLE: string; }; supertest: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; esSupertest: ({ getService, }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; supertestWithoutAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"node_modules/@types/supertest/lib/agent",
|
|
"<",
|
|
"SuperTestStatic",
|
|
".Test>; security: (ctx: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SecurityService",
|
|
"text": "SecurityService"
|
|
},
|
|
">; }>, ProvidedTypeMap<{}>>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/saml_auth/saml_auth_provider.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.services.supertest",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "supertest",
|
|
"description": [],
|
|
"signature": [
|
|
"({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/all.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.services.supertest.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "__0",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GenericFtrProviderContext",
|
|
"text": "GenericFtrProviderContext"
|
|
},
|
|
"<{ es: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"default",
|
|
"; kibanaServer: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.KbnClient",
|
|
"text": "KbnClient"
|
|
},
|
|
"; esArchiver: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/es-archiver",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsArchiverPluginApi",
|
|
"section": "def-common.EsArchiver",
|
|
"text": "EsArchiver"
|
|
},
|
|
"; retry: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RetryService",
|
|
"text": "RetryService"
|
|
},
|
|
"; search: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SearchService",
|
|
"text": "SearchService"
|
|
},
|
|
"; console: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { createIndex: (indexName: string) => Promise<void>; createAlias: (indexName: string, aliasName: string) => Promise<void>; createLegacyTemplate: (templateName: string) => Promise<void>; createIndexTemplate: (templateName: string, indexPatterns: string[], composedOf: string[]) => Promise<void>; createComponentTemplate: (templateName: string) => Promise<void>; createDataStream: (dataStream: string) => Promise<void>; deleteIndex: (indexName: string) => Promise<void>; deleteAlias: (indexName: string, aliasName: string) => Promise<void>; deleteLegacyTemplate: (templateName: string) => Promise<void>; deleteIndexTemplate: (templateName: string) => Promise<void>; deleteComponentTemplate: (templateName: string) => Promise<void>; deleteDataStream: (dataStream: string) => Promise<void>; }; deployment: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.DeploymentService",
|
|
"text": "DeploymentService"
|
|
},
|
|
"; esDeleteAllIndices: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => (patterns: string | string[], remote?: boolean) => Promise<void>; indexPatterns: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
},
|
|
"; savedObjectInfo: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SavedObjectInfoService",
|
|
"text": "SavedObjectInfoService"
|
|
},
|
|
"; randomness: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RandomnessService",
|
|
"text": "RandomnessService"
|
|
},
|
|
"; samlAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { getInteractiveUserSessionCookieWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<string>; getM2MApiCookieCredentialsWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getM2MApiCookieCredentialsWithCustomRoleScope(options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getEmail(role: string): Promise<string>; getUserData(role: string): Promise<",
|
|
"UserProfile",
|
|
">; checkRoleIsSupported(role: string): void; createM2mApiKeyWithDefaultRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithRoleScope(role: string): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithCustomRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; invalidateM2mApiKeyWithRoleScope(roleCredentials: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
"): Promise<void>; setCustomRole(descriptors: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.KibanaRoleDescriptors",
|
|
"text": "KibanaRoleDescriptors"
|
|
},
|
|
"): Promise<void>; deleteCustomRole(): Promise<void>; getCommonRequestHeader(): { 'kbn-xsrf': string; }; getInternalRequestHeader(): ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.InternalRequestHeader",
|
|
"text": "InternalRequestHeader"
|
|
},
|
|
"; DEFAULT_ROLE: string; CUSTOM_ROLE: string; }; supertest: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; esSupertest: ({ getService, }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; supertestWithoutAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"node_modules/@types/supertest/lib/agent",
|
|
"<",
|
|
"SuperTestStatic",
|
|
".Test>; security: (ctx: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SecurityService",
|
|
"text": "SecurityService"
|
|
},
|
|
">; }, {}, ProvidedTypeMap<{ es: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"default",
|
|
"; kibanaServer: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.KbnClient",
|
|
"text": "KbnClient"
|
|
},
|
|
"; esArchiver: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/es-archiver",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsArchiverPluginApi",
|
|
"section": "def-common.EsArchiver",
|
|
"text": "EsArchiver"
|
|
},
|
|
"; retry: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RetryService",
|
|
"text": "RetryService"
|
|
},
|
|
"; search: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SearchService",
|
|
"text": "SearchService"
|
|
},
|
|
"; console: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { createIndex: (indexName: string) => Promise<void>; createAlias: (indexName: string, aliasName: string) => Promise<void>; createLegacyTemplate: (templateName: string) => Promise<void>; createIndexTemplate: (templateName: string, indexPatterns: string[], composedOf: string[]) => Promise<void>; createComponentTemplate: (templateName: string) => Promise<void>; createDataStream: (dataStream: string) => Promise<void>; deleteIndex: (indexName: string) => Promise<void>; deleteAlias: (indexName: string, aliasName: string) => Promise<void>; deleteLegacyTemplate: (templateName: string) => Promise<void>; deleteIndexTemplate: (templateName: string) => Promise<void>; deleteComponentTemplate: (templateName: string) => Promise<void>; deleteDataStream: (dataStream: string) => Promise<void>; }; deployment: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.DeploymentService",
|
|
"text": "DeploymentService"
|
|
},
|
|
"; esDeleteAllIndices: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => (patterns: string | string[], remote?: boolean) => Promise<void>; indexPatterns: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
},
|
|
"; savedObjectInfo: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SavedObjectInfoService",
|
|
"text": "SavedObjectInfoService"
|
|
},
|
|
"; randomness: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RandomnessService",
|
|
"text": "RandomnessService"
|
|
},
|
|
"; samlAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { getInteractiveUserSessionCookieWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<string>; getM2MApiCookieCredentialsWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getM2MApiCookieCredentialsWithCustomRoleScope(options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getEmail(role: string): Promise<string>; getUserData(role: string): Promise<",
|
|
"UserProfile",
|
|
">; checkRoleIsSupported(role: string): void; createM2mApiKeyWithDefaultRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithRoleScope(role: string): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithCustomRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; invalidateM2mApiKeyWithRoleScope(roleCredentials: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
"): Promise<void>; setCustomRole(descriptors: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.KibanaRoleDescriptors",
|
|
"text": "KibanaRoleDescriptors"
|
|
},
|
|
"): Promise<void>; deleteCustomRole(): Promise<void>; getCommonRequestHeader(): { 'kbn-xsrf': string; }; getInternalRequestHeader(): ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.InternalRequestHeader",
|
|
"text": "InternalRequestHeader"
|
|
},
|
|
"; DEFAULT_ROLE: string; CUSTOM_ROLE: string; }; supertest: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; esSupertest: ({ getService, }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; supertestWithoutAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"node_modules/@types/supertest/lib/agent",
|
|
"<",
|
|
"SuperTestStatic",
|
|
".Test>; security: (ctx: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SecurityService",
|
|
"text": "SecurityService"
|
|
},
|
|
">; }>, ProvidedTypeMap<{}>>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/supertest.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.services.esSupertest",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "esSupertest",
|
|
"description": [],
|
|
"signature": [
|
|
"({ getService, }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/all.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.services.esSupertest.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "__0",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GenericFtrProviderContext",
|
|
"text": "GenericFtrProviderContext"
|
|
},
|
|
"<{ es: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"default",
|
|
"; kibanaServer: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.KbnClient",
|
|
"text": "KbnClient"
|
|
},
|
|
"; esArchiver: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/es-archiver",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsArchiverPluginApi",
|
|
"section": "def-common.EsArchiver",
|
|
"text": "EsArchiver"
|
|
},
|
|
"; retry: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RetryService",
|
|
"text": "RetryService"
|
|
},
|
|
"; search: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SearchService",
|
|
"text": "SearchService"
|
|
},
|
|
"; console: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { createIndex: (indexName: string) => Promise<void>; createAlias: (indexName: string, aliasName: string) => Promise<void>; createLegacyTemplate: (templateName: string) => Promise<void>; createIndexTemplate: (templateName: string, indexPatterns: string[], composedOf: string[]) => Promise<void>; createComponentTemplate: (templateName: string) => Promise<void>; createDataStream: (dataStream: string) => Promise<void>; deleteIndex: (indexName: string) => Promise<void>; deleteAlias: (indexName: string, aliasName: string) => Promise<void>; deleteLegacyTemplate: (templateName: string) => Promise<void>; deleteIndexTemplate: (templateName: string) => Promise<void>; deleteComponentTemplate: (templateName: string) => Promise<void>; deleteDataStream: (dataStream: string) => Promise<void>; }; deployment: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.DeploymentService",
|
|
"text": "DeploymentService"
|
|
},
|
|
"; esDeleteAllIndices: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => (patterns: string | string[], remote?: boolean) => Promise<void>; indexPatterns: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
},
|
|
"; savedObjectInfo: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SavedObjectInfoService",
|
|
"text": "SavedObjectInfoService"
|
|
},
|
|
"; randomness: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RandomnessService",
|
|
"text": "RandomnessService"
|
|
},
|
|
"; samlAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { getInteractiveUserSessionCookieWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<string>; getM2MApiCookieCredentialsWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getM2MApiCookieCredentialsWithCustomRoleScope(options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getEmail(role: string): Promise<string>; getUserData(role: string): Promise<",
|
|
"UserProfile",
|
|
">; checkRoleIsSupported(role: string): void; createM2mApiKeyWithDefaultRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithRoleScope(role: string): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithCustomRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; invalidateM2mApiKeyWithRoleScope(roleCredentials: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
"): Promise<void>; setCustomRole(descriptors: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.KibanaRoleDescriptors",
|
|
"text": "KibanaRoleDescriptors"
|
|
},
|
|
"): Promise<void>; deleteCustomRole(): Promise<void>; getCommonRequestHeader(): { 'kbn-xsrf': string; }; getInternalRequestHeader(): ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.InternalRequestHeader",
|
|
"text": "InternalRequestHeader"
|
|
},
|
|
"; DEFAULT_ROLE: string; CUSTOM_ROLE: string; }; supertest: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; esSupertest: ({ getService, }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; supertestWithoutAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"node_modules/@types/supertest/lib/agent",
|
|
"<",
|
|
"SuperTestStatic",
|
|
".Test>; security: (ctx: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SecurityService",
|
|
"text": "SecurityService"
|
|
},
|
|
">; }, {}, ProvidedTypeMap<{ es: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"default",
|
|
"; kibanaServer: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.KbnClient",
|
|
"text": "KbnClient"
|
|
},
|
|
"; esArchiver: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/es-archiver",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsArchiverPluginApi",
|
|
"section": "def-common.EsArchiver",
|
|
"text": "EsArchiver"
|
|
},
|
|
"; retry: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RetryService",
|
|
"text": "RetryService"
|
|
},
|
|
"; search: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SearchService",
|
|
"text": "SearchService"
|
|
},
|
|
"; console: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { createIndex: (indexName: string) => Promise<void>; createAlias: (indexName: string, aliasName: string) => Promise<void>; createLegacyTemplate: (templateName: string) => Promise<void>; createIndexTemplate: (templateName: string, indexPatterns: string[], composedOf: string[]) => Promise<void>; createComponentTemplate: (templateName: string) => Promise<void>; createDataStream: (dataStream: string) => Promise<void>; deleteIndex: (indexName: string) => Promise<void>; deleteAlias: (indexName: string, aliasName: string) => Promise<void>; deleteLegacyTemplate: (templateName: string) => Promise<void>; deleteIndexTemplate: (templateName: string) => Promise<void>; deleteComponentTemplate: (templateName: string) => Promise<void>; deleteDataStream: (dataStream: string) => Promise<void>; }; deployment: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.DeploymentService",
|
|
"text": "DeploymentService"
|
|
},
|
|
"; esDeleteAllIndices: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => (patterns: string | string[], remote?: boolean) => Promise<void>; indexPatterns: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
},
|
|
"; savedObjectInfo: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SavedObjectInfoService",
|
|
"text": "SavedObjectInfoService"
|
|
},
|
|
"; randomness: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RandomnessService",
|
|
"text": "RandomnessService"
|
|
},
|
|
"; samlAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { getInteractiveUserSessionCookieWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<string>; getM2MApiCookieCredentialsWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getM2MApiCookieCredentialsWithCustomRoleScope(options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getEmail(role: string): Promise<string>; getUserData(role: string): Promise<",
|
|
"UserProfile",
|
|
">; checkRoleIsSupported(role: string): void; createM2mApiKeyWithDefaultRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithRoleScope(role: string): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithCustomRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; invalidateM2mApiKeyWithRoleScope(roleCredentials: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
"): Promise<void>; setCustomRole(descriptors: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.KibanaRoleDescriptors",
|
|
"text": "KibanaRoleDescriptors"
|
|
},
|
|
"): Promise<void>; deleteCustomRole(): Promise<void>; getCommonRequestHeader(): { 'kbn-xsrf': string; }; getInternalRequestHeader(): ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.InternalRequestHeader",
|
|
"text": "InternalRequestHeader"
|
|
},
|
|
"; DEFAULT_ROLE: string; CUSTOM_ROLE: string; }; supertest: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; esSupertest: ({ getService, }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; supertestWithoutAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"node_modules/@types/supertest/lib/agent",
|
|
"<",
|
|
"SuperTestStatic",
|
|
".Test>; security: (ctx: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SecurityService",
|
|
"text": "SecurityService"
|
|
},
|
|
">; }>, ProvidedTypeMap<{}>>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/supertest.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.services.supertestWithoutAuth",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "supertestWithoutAuth",
|
|
"description": [],
|
|
"signature": [
|
|
"({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"node_modules/@types/supertest/lib/agent",
|
|
"<",
|
|
"SuperTestStatic",
|
|
".Test>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/all.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.services.supertestWithoutAuth.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "__0",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GenericFtrProviderContext",
|
|
"text": "GenericFtrProviderContext"
|
|
},
|
|
"<{ es: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"default",
|
|
"; kibanaServer: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.KbnClient",
|
|
"text": "KbnClient"
|
|
},
|
|
"; esArchiver: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/es-archiver",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsArchiverPluginApi",
|
|
"section": "def-common.EsArchiver",
|
|
"text": "EsArchiver"
|
|
},
|
|
"; retry: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RetryService",
|
|
"text": "RetryService"
|
|
},
|
|
"; search: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SearchService",
|
|
"text": "SearchService"
|
|
},
|
|
"; console: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { createIndex: (indexName: string) => Promise<void>; createAlias: (indexName: string, aliasName: string) => Promise<void>; createLegacyTemplate: (templateName: string) => Promise<void>; createIndexTemplate: (templateName: string, indexPatterns: string[], composedOf: string[]) => Promise<void>; createComponentTemplate: (templateName: string) => Promise<void>; createDataStream: (dataStream: string) => Promise<void>; deleteIndex: (indexName: string) => Promise<void>; deleteAlias: (indexName: string, aliasName: string) => Promise<void>; deleteLegacyTemplate: (templateName: string) => Promise<void>; deleteIndexTemplate: (templateName: string) => Promise<void>; deleteComponentTemplate: (templateName: string) => Promise<void>; deleteDataStream: (dataStream: string) => Promise<void>; }; deployment: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.DeploymentService",
|
|
"text": "DeploymentService"
|
|
},
|
|
"; esDeleteAllIndices: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => (patterns: string | string[], remote?: boolean) => Promise<void>; indexPatterns: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
},
|
|
"; savedObjectInfo: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SavedObjectInfoService",
|
|
"text": "SavedObjectInfoService"
|
|
},
|
|
"; randomness: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RandomnessService",
|
|
"text": "RandomnessService"
|
|
},
|
|
"; samlAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { getInteractiveUserSessionCookieWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<string>; getM2MApiCookieCredentialsWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getM2MApiCookieCredentialsWithCustomRoleScope(options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getEmail(role: string): Promise<string>; getUserData(role: string): Promise<",
|
|
"UserProfile",
|
|
">; checkRoleIsSupported(role: string): void; createM2mApiKeyWithDefaultRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithRoleScope(role: string): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithCustomRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; invalidateM2mApiKeyWithRoleScope(roleCredentials: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
"): Promise<void>; setCustomRole(descriptors: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.KibanaRoleDescriptors",
|
|
"text": "KibanaRoleDescriptors"
|
|
},
|
|
"): Promise<void>; deleteCustomRole(): Promise<void>; getCommonRequestHeader(): { 'kbn-xsrf': string; }; getInternalRequestHeader(): ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.InternalRequestHeader",
|
|
"text": "InternalRequestHeader"
|
|
},
|
|
"; DEFAULT_ROLE: string; CUSTOM_ROLE: string; }; supertest: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; esSupertest: ({ getService, }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; supertestWithoutAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"node_modules/@types/supertest/lib/agent",
|
|
"<",
|
|
"SuperTestStatic",
|
|
".Test>; security: (ctx: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SecurityService",
|
|
"text": "SecurityService"
|
|
},
|
|
">; }, {}, ProvidedTypeMap<{ es: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"default",
|
|
"; kibanaServer: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.KbnClient",
|
|
"text": "KbnClient"
|
|
},
|
|
"; esArchiver: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/es-archiver",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsArchiverPluginApi",
|
|
"section": "def-common.EsArchiver",
|
|
"text": "EsArchiver"
|
|
},
|
|
"; retry: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RetryService",
|
|
"text": "RetryService"
|
|
},
|
|
"; search: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SearchService",
|
|
"text": "SearchService"
|
|
},
|
|
"; console: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { createIndex: (indexName: string) => Promise<void>; createAlias: (indexName: string, aliasName: string) => Promise<void>; createLegacyTemplate: (templateName: string) => Promise<void>; createIndexTemplate: (templateName: string, indexPatterns: string[], composedOf: string[]) => Promise<void>; createComponentTemplate: (templateName: string) => Promise<void>; createDataStream: (dataStream: string) => Promise<void>; deleteIndex: (indexName: string) => Promise<void>; deleteAlias: (indexName: string, aliasName: string) => Promise<void>; deleteLegacyTemplate: (templateName: string) => Promise<void>; deleteIndexTemplate: (templateName: string) => Promise<void>; deleteComponentTemplate: (templateName: string) => Promise<void>; deleteDataStream: (dataStream: string) => Promise<void>; }; deployment: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.DeploymentService",
|
|
"text": "DeploymentService"
|
|
},
|
|
"; esDeleteAllIndices: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => (patterns: string | string[], remote?: boolean) => Promise<void>; indexPatterns: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
},
|
|
"; savedObjectInfo: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SavedObjectInfoService",
|
|
"text": "SavedObjectInfoService"
|
|
},
|
|
"; randomness: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RandomnessService",
|
|
"text": "RandomnessService"
|
|
},
|
|
"; samlAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { getInteractiveUserSessionCookieWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<string>; getM2MApiCookieCredentialsWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getM2MApiCookieCredentialsWithCustomRoleScope(options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getEmail(role: string): Promise<string>; getUserData(role: string): Promise<",
|
|
"UserProfile",
|
|
">; checkRoleIsSupported(role: string): void; createM2mApiKeyWithDefaultRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithRoleScope(role: string): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithCustomRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; invalidateM2mApiKeyWithRoleScope(roleCredentials: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
"): Promise<void>; setCustomRole(descriptors: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.KibanaRoleDescriptors",
|
|
"text": "KibanaRoleDescriptors"
|
|
},
|
|
"): Promise<void>; deleteCustomRole(): Promise<void>; getCommonRequestHeader(): { 'kbn-xsrf': string; }; getInternalRequestHeader(): ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.InternalRequestHeader",
|
|
"text": "InternalRequestHeader"
|
|
},
|
|
"; DEFAULT_ROLE: string; CUSTOM_ROLE: string; }; supertest: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; esSupertest: ({ getService, }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; supertestWithoutAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"node_modules/@types/supertest/lib/agent",
|
|
"<",
|
|
"SuperTestStatic",
|
|
".Test>; security: (ctx: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SecurityService",
|
|
"text": "SecurityService"
|
|
},
|
|
">; }>, ProvidedTypeMap<{}>>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/supertest_without_auth.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.services.security",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "security",
|
|
"description": [],
|
|
"signature": [
|
|
"(ctx: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SecurityService",
|
|
"text": "SecurityService"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/all.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ftr-common-functional-services",
|
|
"id": "def-common.services.security.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "ctx",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GenericFtrProviderContext",
|
|
"text": "GenericFtrProviderContext"
|
|
},
|
|
"<{ es: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"default",
|
|
"; kibanaServer: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.KbnClient",
|
|
"text": "KbnClient"
|
|
},
|
|
"; esArchiver: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/es-archiver",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsArchiverPluginApi",
|
|
"section": "def-common.EsArchiver",
|
|
"text": "EsArchiver"
|
|
},
|
|
"; retry: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RetryService",
|
|
"text": "RetryService"
|
|
},
|
|
"; search: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SearchService",
|
|
"text": "SearchService"
|
|
},
|
|
"; console: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { createIndex: (indexName: string) => Promise<void>; createAlias: (indexName: string, aliasName: string) => Promise<void>; createLegacyTemplate: (templateName: string) => Promise<void>; createIndexTemplate: (templateName: string, indexPatterns: string[], composedOf: string[]) => Promise<void>; createComponentTemplate: (templateName: string) => Promise<void>; createDataStream: (dataStream: string) => Promise<void>; deleteIndex: (indexName: string) => Promise<void>; deleteAlias: (indexName: string, aliasName: string) => Promise<void>; deleteLegacyTemplate: (templateName: string) => Promise<void>; deleteIndexTemplate: (templateName: string) => Promise<void>; deleteComponentTemplate: (templateName: string) => Promise<void>; deleteDataStream: (dataStream: string) => Promise<void>; }; deployment: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.DeploymentService",
|
|
"text": "DeploymentService"
|
|
},
|
|
"; esDeleteAllIndices: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => (patterns: string | string[], remote?: boolean) => Promise<void>; indexPatterns: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
},
|
|
"; savedObjectInfo: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SavedObjectInfoService",
|
|
"text": "SavedObjectInfoService"
|
|
},
|
|
"; randomness: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RandomnessService",
|
|
"text": "RandomnessService"
|
|
},
|
|
"; samlAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { getInteractiveUserSessionCookieWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<string>; getM2MApiCookieCredentialsWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getM2MApiCookieCredentialsWithCustomRoleScope(options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getEmail(role: string): Promise<string>; getUserData(role: string): Promise<",
|
|
"UserProfile",
|
|
">; checkRoleIsSupported(role: string): void; createM2mApiKeyWithDefaultRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithRoleScope(role: string): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithCustomRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; invalidateM2mApiKeyWithRoleScope(roleCredentials: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
"): Promise<void>; setCustomRole(descriptors: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.KibanaRoleDescriptors",
|
|
"text": "KibanaRoleDescriptors"
|
|
},
|
|
"): Promise<void>; deleteCustomRole(): Promise<void>; getCommonRequestHeader(): { 'kbn-xsrf': string; }; getInternalRequestHeader(): ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.InternalRequestHeader",
|
|
"text": "InternalRequestHeader"
|
|
},
|
|
"; DEFAULT_ROLE: string; CUSTOM_ROLE: string; }; supertest: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; esSupertest: ({ getService, }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; supertestWithoutAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"node_modules/@types/supertest/lib/agent",
|
|
"<",
|
|
"SuperTestStatic",
|
|
".Test>; security: (ctx: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SecurityService",
|
|
"text": "SecurityService"
|
|
},
|
|
">; }, {}, ProvidedTypeMap<{ es: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"default",
|
|
"; kibanaServer: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.KbnClient",
|
|
"text": "KbnClient"
|
|
},
|
|
"; esArchiver: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/es-archiver",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsArchiverPluginApi",
|
|
"section": "def-common.EsArchiver",
|
|
"text": "EsArchiver"
|
|
},
|
|
"; retry: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RetryService",
|
|
"text": "RetryService"
|
|
},
|
|
"; search: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SearchService",
|
|
"text": "SearchService"
|
|
},
|
|
"; console: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { createIndex: (indexName: string) => Promise<void>; createAlias: (indexName: string, aliasName: string) => Promise<void>; createLegacyTemplate: (templateName: string) => Promise<void>; createIndexTemplate: (templateName: string, indexPatterns: string[], composedOf: string[]) => Promise<void>; createComponentTemplate: (templateName: string) => Promise<void>; createDataStream: (dataStream: string) => Promise<void>; deleteIndex: (indexName: string) => Promise<void>; deleteAlias: (indexName: string, aliasName: string) => Promise<void>; deleteLegacyTemplate: (templateName: string) => Promise<void>; deleteIndexTemplate: (templateName: string) => Promise<void>; deleteComponentTemplate: (templateName: string) => Promise<void>; deleteDataStream: (dataStream: string) => Promise<void>; }; deployment: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.DeploymentService",
|
|
"text": "DeploymentService"
|
|
},
|
|
"; esDeleteAllIndices: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => (patterns: string | string[], remote?: boolean) => Promise<void>; indexPatterns: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
},
|
|
"; savedObjectInfo: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SavedObjectInfoService",
|
|
"text": "SavedObjectInfoService"
|
|
},
|
|
"; randomness: typeof ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RandomnessService",
|
|
"text": "RandomnessService"
|
|
},
|
|
"; samlAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => { getInteractiveUserSessionCookieWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<string>; getM2MApiCookieCredentialsWithRoleScope(role: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getM2MApiCookieCredentialsWithCustomRoleScope(options?: ",
|
|
{
|
|
"pluginId": "@kbn/test",
|
|
"scope": "common",
|
|
"docId": "kibKbnTestPluginApi",
|
|
"section": "def-common.GetCookieOptions",
|
|
"text": "GetCookieOptions"
|
|
},
|
|
" | undefined): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.CookieCredentials",
|
|
"text": "CookieCredentials"
|
|
},
|
|
">; getEmail(role: string): Promise<string>; getUserData(role: string): Promise<",
|
|
"UserProfile",
|
|
">; checkRoleIsSupported(role: string): void; createM2mApiKeyWithDefaultRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithRoleScope(role: string): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; createM2mApiKeyWithCustomRoleScope(): Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
">; invalidateM2mApiKeyWithRoleScope(roleCredentials: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.RoleCredentials",
|
|
"text": "RoleCredentials"
|
|
},
|
|
"): Promise<void>; setCustomRole(descriptors: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.KibanaRoleDescriptors",
|
|
"text": "KibanaRoleDescriptors"
|
|
},
|
|
"): Promise<void>; deleteCustomRole(): Promise<void>; getCommonRequestHeader(): { 'kbn-xsrf': string; }; getInternalRequestHeader(): ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.InternalRequestHeader",
|
|
"text": "InternalRequestHeader"
|
|
},
|
|
"; DEFAULT_ROLE: string; CUSTOM_ROLE: string; }; supertest: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; esSupertest: ({ getService, }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"Agent",
|
|
"; supertestWithoutAuth: ({ getService }: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => ",
|
|
"node_modules/@types/supertest/lib/agent",
|
|
"<",
|
|
"SuperTestStatic",
|
|
".Test>; security: (ctx: ",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.FtrProviderContext",
|
|
"text": "FtrProviderContext"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "@kbn/ftr-common-functional-services",
|
|
"scope": "common",
|
|
"docId": "kibKbnFtrCommonFunctionalServicesPluginApi",
|
|
"section": "def-common.SecurityService",
|
|
"text": "SecurityService"
|
|
},
|
|
">; }>, ProvidedTypeMap<{}>>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-ftr-common-functional-services/services/security/security.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
]
|
|
}
|
|
} |