github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-25 02:09:32 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/encrypted_saved_objects.devdocs.json
Kibana Machine e82e0a150f
[api-docs] Daily api_docs build (#144203)
2022-10-29 00:46:56 -04:00

1114 lines
No EOL
43 KiB
JSON
Raw Blame History

{
"id": "encryptedSavedObjects",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptionError",
"type": "Class",
"tags": [],
"label": "EncryptionError",
"description": [],
"signature": [
{
"pluginId": "encryptedSavedObjects",
"scope": "server",
"docId": "kibEncryptedSavedObjectsPluginApi",
"section": "def-server.EncryptionError",
"text": "EncryptionError"
},
" extends Error"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptionError.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptionError.Unnamed.$1",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptionError.Unnamed.$2",
"type": "string",
"tags": [],
"label": "attributeName",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptionError.Unnamed.$3",
"type": "Enum",
"tags": [],
"label": "operation",
"description": [],
"signature": [
{
"pluginId": "encryptedSavedObjects",
"scope": "server",
"docId": "kibEncryptedSavedObjectsPluginApi",
"section": "def-server.EncryptionErrorOperation",
"text": "EncryptionErrorOperation"
}
],
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptionError.Unnamed.$4",
"type": "Object",
"tags": [],
"label": "cause",
"description": [],
"signature": [
"Error | undefined"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptionError.toJSON",
"type": "Function",
"tags": [],
"label": "toJSON",
"description": [],
"signature": [
"() => { message: string; }"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.AttributeToEncrypt",
"type": "Interface",
"tags": [],
"label": "AttributeToEncrypt",
"description": [
"\nDescribes the attributes to encrypt. By default, attribute values won't be exposed to end-users\nand can only be consumed by the internal Kibana server. If end-users should have access to the\nencrypted values use `dangerouslyExposeValue: true`"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.AttributeToEncrypt.key",
"type": "string",
"tags": [],
"label": "key",
"description": [],
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.AttributeToEncrypt.dangerouslyExposeValue",
"type": "CompoundType",
"tags": [],
"label": "dangerouslyExposeValue",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.CreateEncryptedSavedObjectsMigrationFnOpts",
"type": "Interface",
"tags": [],
"label": "CreateEncryptedSavedObjectsMigrationFnOpts",
"description": [],
"signature": [
{
"pluginId": "encryptedSavedObjects",
"scope": "server",
"docId": "kibEncryptedSavedObjectsPluginApi",
"section": "def-server.CreateEncryptedSavedObjectsMigrationFnOpts",
"text": "CreateEncryptedSavedObjectsMigrationFnOpts"
},
"<InputAttributes, MigratedAttributes>"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.CreateEncryptedSavedObjectsMigrationFnOpts.isMigrationNeededPredicate",
"type": "Function",
"tags": [],
"label": "isMigrationNeededPredicate",
"description": [],
"signature": [
"(encryptedDoc: ",
{
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<InputAttributes> | ",
{
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<MigratedAttributes>) => encryptedDoc is ",
{
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<InputAttributes>"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.CreateEncryptedSavedObjectsMigrationFnOpts.isMigrationNeededPredicate.$1",
"type": "CompoundType",
"tags": [],
"label": "encryptedDoc",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<InputAttributes> | ",
{
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<MigratedAttributes>"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.CreateEncryptedSavedObjectsMigrationFnOpts.migration",
"type": "Function",
"tags": [],
"label": "migration",
"description": [],
"signature": [
"(doc: ",
{
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<InputAttributes>, context: ",
{
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectMigrationContext",
"text": "SavedObjectMigrationContext"
},
") => ",
{
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<MigratedAttributes>"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.CreateEncryptedSavedObjectsMigrationFnOpts.migration.$1",
"type": "CompoundType",
"tags": [],
"label": "doc",
"description": [],
"signature": [
"SavedObjectDoc<InputAttributes> & { references?: ",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[] | undefined; }"
],
"path": "packages/core/saved-objects/core-saved-objects-server/src/migration.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.CreateEncryptedSavedObjectsMigrationFnOpts.migration.$2",
"type": "Object",
"tags": [],
"label": "context",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectMigrationContext",
"text": "SavedObjectMigrationContext"
}
],
"path": "packages/core/saved-objects/core-saved-objects-server/src/migration.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.CreateEncryptedSavedObjectsMigrationFnOpts.shouldMigrateIfDecryptionFails",
"type": "CompoundType",
"tags": [],
"label": "shouldMigrateIfDecryptionFails",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.CreateEncryptedSavedObjectsMigrationFnOpts.inputType",
"type": "Object",
"tags": [],
"label": "inputType",
"description": [],
"signature": [
{
"pluginId": "encryptedSavedObjects",
"scope": "server",
"docId": "kibEncryptedSavedObjectsPluginApi",
"section": "def-server.EncryptedSavedObjectTypeRegistration",
"text": "EncryptedSavedObjectTypeRegistration"
},
" | undefined"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.CreateEncryptedSavedObjectsMigrationFnOpts.migratedType",
"type": "Object",
"tags": [],
"label": "migratedType",
"description": [],
"signature": [
{
"pluginId": "encryptedSavedObjects",
"scope": "server",
"docId": "kibEncryptedSavedObjectsPluginApi",
"section": "def-server.EncryptedSavedObjectTypeRegistration",
"text": "EncryptedSavedObjectTypeRegistration"
},
" | undefined"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsClient",
"type": "Interface",
"tags": [],
"label": "EncryptedSavedObjectsClient",
"description": [],
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsClient.getDecryptedAsInternalUser",
"type": "Function",
"tags": [],
"label": "getDecryptedAsInternalUser",
"description": [],
"signature": [
"<T = unknown>(type: string, id: string, options?: ",
{
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined) => Promise<",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObject",
"text": "SavedObject"
},
"<T>>"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsClient.getDecryptedAsInternalUser.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsClient.getDecryptedAsInternalUser.$2",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsClient.getDecryptedAsInternalUser.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsClient.createPointInTimeFinderDecryptedAsInternalUser",
"type": "Function",
"tags": [],
"label": "createPointInTimeFinderDecryptedAsInternalUser",
"description": [
"\nAPI method, that can be used to help page through large sets of saved objects and returns decrypted properties in result SO.\nIts interface matches interface of the corresponding Saved Objects API `createPointInTimeFinder` method:\n"
],
"signature": [
"<T = unknown, A = unknown>(findOptions: ",
{
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-server.SavedObjectsCreatePointInTimeFinderOptions",
"text": "SavedObjectsCreatePointInTimeFinderOptions"
},
", dependencies?: ",
{
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
},
" | undefined) => Promise<",
{
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-server.ISavedObjectsPointInTimeFinder",
"text": "ISavedObjectsPointInTimeFinder"
},
"<T, A>>"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsClient.createPointInTimeFinderDecryptedAsInternalUser.$1",
"type": "Object",
"tags": [],
"label": "findOptions",
"description": [
"matches interface of corresponding argument of Saved Objects API `createPointInTimeFinder` {@link SavedObjectsCreatePointInTimeFinderOptions }"
],
"signature": [
{
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-server.SavedObjectsCreatePointInTimeFinderOptions",
"text": "SavedObjectsCreatePointInTimeFinderOptions"
}
],
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsClient.createPointInTimeFinderDecryptedAsInternalUser.$2",
"type": "Object",
"tags": [],
"label": "dependencies",
"description": [
"matches interface of corresponding argument of Saved Objects API `createPointInTimeFinder` {@link SavedObjectsCreatePointInTimeFinderDependencies }"
],
"signature": [
{
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
},
" | undefined"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsClientOptions",
"type": "Interface",
"tags": [],
"label": "EncryptedSavedObjectsClientOptions",
"description": [],
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsClientOptions.includedHiddenTypes",
"type": "Array",
"tags": [],
"label": "includedHiddenTypes",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectTypeRegistration",
"type": "Interface",
"tags": [],
"label": "EncryptedSavedObjectTypeRegistration",
"description": [
"\nDescribes the registration entry for the saved object type that contain attributes that need to\nbe encrypted."
],
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectTypeRegistration.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectTypeRegistration.attributesToEncrypt",
"type": "Object",
"tags": [],
"label": "attributesToEncrypt",
"description": [],
"signature": [
"ReadonlySet<string | ",
{
"pluginId": "encryptedSavedObjects",
"scope": "server",
"docId": "kibEncryptedSavedObjectsPluginApi",
"section": "def-server.AttributeToEncrypt",
"text": "AttributeToEncrypt"
},
">"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectTypeRegistration.attributesToExcludeFromAAD",
"type": "Object",
"tags": [],
"label": "attributesToExcludeFromAAD",
"description": [],
"signature": [
"ReadonlySet<string> | undefined"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptionErrorOperation",
"type": "Enum",
"tags": [],
"label": "EncryptionErrorOperation",
"description": [
"\nDefines operation (encryption or decryption) during which error occurred."
],
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.ClientInstanciator",
"type": "Type",
"tags": [],
"label": "ClientInstanciator",
"description": [],
"signature": [
"(options?: ",
{
"pluginId": "encryptedSavedObjects",
"scope": "server",
"docId": "kibEncryptedSavedObjectsPluginApi",
"section": "def-server.EncryptedSavedObjectsClientOptions",
"text": "EncryptedSavedObjectsClientOptions"
},
" | undefined) => ",
{
"pluginId": "encryptedSavedObjects",
"scope": "server",
"docId": "kibEncryptedSavedObjectsPluginApi",
"section": "def-server.EncryptedSavedObjectsClient",
"text": "EncryptedSavedObjectsClient"
}
],
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.ClientInstanciator.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "encryptedSavedObjects",
"scope": "server",
"docId": "kibEncryptedSavedObjectsPluginApi",
"section": "def-server.EncryptedSavedObjectsClientOptions",
"text": "EncryptedSavedObjectsClientOptions"
},
" | undefined"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.CreateEncryptedSavedObjectsMigrationFn",
"type": "Type",
"tags": [],
"label": "CreateEncryptedSavedObjectsMigrationFn",
"description": [],
"signature": [
"<InputAttributes = unknown, MigratedAttributes = InputAttributes>(opts: ",
{
"pluginId": "encryptedSavedObjects",
"scope": "server",
"docId": "kibEncryptedSavedObjectsPluginApi",
"section": "def-server.CreateEncryptedSavedObjectsMigrationFnOpts",
"text": "CreateEncryptedSavedObjectsMigrationFnOpts"
},
"<InputAttributes, MigratedAttributes>) => SavedObjectOptionalMigrationFn<InputAttributes, MigratedAttributes>"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.CreateEncryptedSavedObjectsMigrationFn.$1",
"type": "Object",
"tags": [],
"label": "opts",
"description": [],
"signature": [
{
"pluginId": "encryptedSavedObjects",
"scope": "server",
"docId": "kibEncryptedSavedObjectsPluginApi",
"section": "def-server.CreateEncryptedSavedObjectsMigrationFnOpts",
"text": "CreateEncryptedSavedObjectsMigrationFnOpts"
},
"<InputAttributes, MigratedAttributes>"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.IsMigrationNeededPredicate",
"type": "Type",
"tags": [],
"label": "IsMigrationNeededPredicate",
"description": [],
"signature": [
"(encryptedDoc: ",
{
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<InputAttributes> | ",
{
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<MigratedAttributes>) => encryptedDoc is ",
{
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<InputAttributes>"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.IsMigrationNeededPredicate.$1",
"type": "CompoundType",
"tags": [],
"label": "encryptedDoc",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<InputAttributes> | ",
{
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<MigratedAttributes>"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsPluginSetup",
"type": "Interface",
"tags": [],
"label": "EncryptedSavedObjectsPluginSetup",
"description": [],
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsPluginSetup.canEncrypt",
"type": "boolean",
"tags": [],
"label": "canEncrypt",
"description": [
"\nIndicates if Saved Object encryption is possible. Requires an encryption key to be explicitly set via `xpack.encryptedSavedObjects.encryptionKey`."
],
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsPluginSetup.registerType",
"type": "Function",
"tags": [],
"label": "registerType",
"description": [],
"signature": [
"(typeRegistration: ",
{
"pluginId": "encryptedSavedObjects",
"scope": "server",
"docId": "kibEncryptedSavedObjectsPluginApi",
"section": "def-server.EncryptedSavedObjectTypeRegistration",
"text": "EncryptedSavedObjectTypeRegistration"
},
") => void"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsPluginSetup.registerType.$1",
"type": "Object",
"tags": [],
"label": "typeRegistration",
"description": [],
"signature": [
{
"pluginId": "encryptedSavedObjects",
"scope": "server",
"docId": "kibEncryptedSavedObjectsPluginApi",
"section": "def-server.EncryptedSavedObjectTypeRegistration",
"text": "EncryptedSavedObjectTypeRegistration"
}
],
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsPluginSetup.createMigration",
"type": "Function",
"tags": [],
"label": "createMigration",
"description": [],
"signature": [
"<InputAttributes = unknown, MigratedAttributes = InputAttributes>(opts: ",
{
"pluginId": "encryptedSavedObjects",
"scope": "server",
"docId": "kibEncryptedSavedObjectsPluginApi",
"section": "def-server.CreateEncryptedSavedObjectsMigrationFnOpts",
"text": "CreateEncryptedSavedObjectsMigrationFnOpts"
},
"<InputAttributes, MigratedAttributes>) => SavedObjectOptionalMigrationFn<InputAttributes, MigratedAttributes>"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsPluginSetup.createMigration.$1",
"type": "Object",
"tags": [],
"label": "opts",
"description": [],
"signature": [
{
"pluginId": "encryptedSavedObjects",
"scope": "server",
"docId": "kibEncryptedSavedObjectsPluginApi",
"section": "def-server.CreateEncryptedSavedObjectsMigrationFnOpts",
"text": "CreateEncryptedSavedObjectsMigrationFnOpts"
},
"<InputAttributes, MigratedAttributes>"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsPluginStart",
"type": "Interface",
"tags": [],
"label": "EncryptedSavedObjectsPluginStart",
"description": [],
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsPluginStart.isEncryptionError",
"type": "Function",
"tags": [],
"label": "isEncryptionError",
"description": [],
"signature": [
"(error: Error) => boolean"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsPluginStart.isEncryptionError.$1",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsPluginStart.getClient",
"type": "Function",
"tags": [],
"label": "getClient",
"description": [],
"signature": [
"(options?: ",
{
"pluginId": "encryptedSavedObjects",
"scope": "server",
"docId": "kibEncryptedSavedObjectsPluginApi",
"section": "def-server.EncryptedSavedObjectsClientOptions",
"text": "EncryptedSavedObjectsClientOptions"
},
" | undefined) => ",
{
"pluginId": "encryptedSavedObjects",
"scope": "server",
"docId": "kibEncryptedSavedObjectsPluginApi",
"section": "def-server.EncryptedSavedObjectsClient",
"text": "EncryptedSavedObjectsClient"
}
],
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsPluginStart.getClient.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "encryptedSavedObjects",
"scope": "server",
"docId": "kibEncryptedSavedObjectsPluginApi",
"section": "def-server.EncryptedSavedObjectsClientOptions",
"text": "EncryptedSavedObjectsClientOptions"
},
" | undefined"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink