Skip to content

Latest commit

 

History

History
33 lines (25 loc) · 3.31 KB

kibana-plugin-core-public.savedobjectsfindoptions.md

File metadata and controls

33 lines (25 loc) · 3.31 KB

Home > kibana-plugin-core-public > SavedObjectsFindOptions

SavedObjectsFindOptions interface

Signature:

export interface SavedObjectsFindOptions 

Properties

Property Type Description
defaultSearchOperator 'AND' | 'OR'
fields string[] An array of fields to include in the results
filter string | KueryNode
hasReference {
type: string;
id: string;
}
namespaces string[]
page number
perPage number
preference string An optional ES preference value to be used for the query *
rootSearchFields string[] The fields to perform the parsed query against. Unlike the searchFields argument, these are expected to be root fields and will not be modified. If used in conjunction with searchFields, both are concatenated together.
search string Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String query argument for more information
searchFields string[] The fields to perform the parsed query against. See Elasticsearch Simple Query String fields argument for more information
sortField string
sortOrder string
type string | string[]
typeToNamespacesMap Map<string, string[] | undefined> This map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved object client wrapper. If this is defined, it supersedes the type and namespaces fields when building the Elasticsearch query. Any types that are not included in this map will be excluded entirely. If a type is included but its value is undefined, the operation will search for that type in the Default namespace.