@elastic/elasticsearch 8.9.2 → 8.10.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/catalog-info.yaml +5 -4
- package/lib/api/api/async_search.d.ts +4 -4
- package/lib/api/api/autoscaling.d.ts +4 -4
- package/lib/api/api/bulk.d.ts +1 -1
- package/lib/api/api/cat.d.ts +26 -26
- package/lib/api/api/ccr.d.ts +13 -13
- package/lib/api/api/clear_scroll.d.ts +1 -1
- package/lib/api/api/close_point_in_time.d.ts +1 -1
- package/lib/api/api/cluster.d.ts +16 -16
- package/lib/api/api/cluster.js +1 -1
- package/lib/api/api/cluster.js.map +1 -1
- package/lib/api/api/count.d.ts +1 -1
- package/lib/api/api/create.d.ts +1 -1
- package/lib/api/api/dangling_indices.d.ts +3 -3
- package/lib/api/api/delete.d.ts +1 -1
- package/lib/api/api/delete_by_query.d.ts +1 -1
- package/lib/api/api/delete_by_query_rethrottle.d.ts +1 -1
- package/lib/api/api/delete_script.d.ts +1 -1
- package/lib/api/api/enrich.d.ts +5 -5
- package/lib/api/api/eql.d.ts +4 -4
- package/lib/api/api/exists.d.ts +1 -1
- package/lib/api/api/exists_source.d.ts +1 -1
- package/lib/api/api/explain.d.ts +1 -1
- package/lib/api/api/features.d.ts +2 -2
- package/lib/api/api/field_caps.d.ts +1 -1
- package/lib/api/api/fleet.d.ts +1 -1
- package/lib/api/api/get.d.ts +1 -1
- package/lib/api/api/get_script.d.ts +1 -1
- package/lib/api/api/get_script_context.d.ts +1 -1
- package/lib/api/api/get_script_languages.d.ts +1 -1
- package/lib/api/api/get_source.d.ts +1 -1
- package/lib/api/api/graph.d.ts +1 -1
- package/lib/api/api/health_report.d.ts +1 -1
- package/lib/api/api/ilm.d.ts +11 -11
- package/lib/api/api/index.d.ts +1 -1
- package/lib/api/api/indices.d.ts +58 -58
- package/lib/api/api/info.d.ts +1 -1
- package/lib/api/api/ingest.d.ts +6 -6
- package/lib/api/api/knn_search.d.ts +1 -1
- package/lib/api/api/license.d.ts +7 -7
- package/lib/api/api/logstash.d.ts +3 -3
- package/lib/api/api/mget.d.ts +1 -1
- package/lib/api/api/migration.d.ts +3 -3
- package/lib/api/api/ml.d.ts +73 -73
- package/lib/api/api/ml.js +1 -1
- package/lib/api/api/ml.js.map +1 -1
- package/lib/api/api/monitoring.d.ts +1 -1
- package/lib/api/api/msearch.d.ts +1 -1
- package/lib/api/api/msearch_template.d.ts +1 -1
- package/lib/api/api/mtermvectors.d.ts +1 -1
- package/lib/api/api/nodes.d.ts +7 -7
- package/lib/api/api/open_point_in_time.d.ts +1 -1
- package/lib/api/api/ping.d.ts +1 -1
- package/lib/api/api/put_script.d.ts +1 -1
- package/lib/api/api/query_ruleset.d.ts +39 -0
- package/lib/api/api/query_ruleset.js +116 -0
- package/lib/api/api/query_ruleset.js.map +1 -0
- package/lib/api/api/rank_eval.d.ts +1 -1
- package/lib/api/api/reindex.d.ts +1 -1
- package/lib/api/api/reindex_rethrottle.d.ts +1 -1
- package/lib/api/api/render_search_template.d.ts +1 -1
- package/lib/api/api/rollup.d.ts +8 -8
- package/lib/api/api/scripts_painless_execute.d.ts +1 -1
- package/lib/api/api/scroll.d.ts +1 -1
- package/lib/api/api/search.d.ts +1 -1
- package/lib/api/api/search_application.d.ts +9 -9
- package/lib/api/api/search_mvt.d.ts +1 -1
- package/lib/api/api/search_shards.d.ts +1 -1
- package/lib/api/api/search_template.d.ts +1 -1
- package/lib/api/api/searchable_snapshots.d.ts +4 -4
- package/lib/api/api/security.d.ts +57 -57
- package/lib/api/api/slm.d.ts +9 -9
- package/lib/api/api/snapshot.d.ts +12 -12
- package/lib/api/api/sql.d.ts +6 -6
- package/lib/api/api/ssl.d.ts +1 -1
- package/lib/api/api/synonyms.d.ts +40 -12
- package/lib/api/api/synonyms.js +108 -11
- package/lib/api/api/synonyms.js.map +1 -1
- package/lib/api/api/tasks.d.ts +3 -3
- package/lib/api/api/terms_enum.d.ts +1 -1
- package/lib/api/api/termvectors.d.ts +1 -1
- package/lib/api/api/text_structure.d.ts +1 -1
- package/lib/api/api/transform.d.ts +11 -11
- package/lib/api/api/update.d.ts +1 -1
- package/lib/api/api/update_by_query.d.ts +1 -1
- package/lib/api/api/update_by_query_rethrottle.d.ts +1 -1
- package/lib/api/api/watcher.d.ts +13 -13
- package/lib/api/api/xpack.d.ts +2 -2
- package/lib/api/index.d.ts +4 -0
- package/lib/api/index.js +14 -2
- package/lib/api/index.js.map +1 -1
- package/lib/api/types.d.ts +241 -81
- package/lib/api/typesWithBodyKey.d.ts +250 -81
- package/lib/helpers.js +3 -2
- package/lib/helpers.js.map +1 -1
- package/package.json +3 -7
|
@@ -9,399 +9,399 @@ export default class Security {
|
|
|
9
9
|
constructor(transport: Transport);
|
|
10
10
|
/**
|
|
11
11
|
* Creates or updates the user profile on behalf of another user.
|
|
12
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
12
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-activate-user-profile.html | Elasticsearch API documentation}
|
|
13
13
|
*/
|
|
14
14
|
activateUserProfile(this: That, params: T.SecurityActivateUserProfileRequest | TB.SecurityActivateUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityActivateUserProfileResponse>;
|
|
15
15
|
activateUserProfile(this: That, params: T.SecurityActivateUserProfileRequest | TB.SecurityActivateUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityActivateUserProfileResponse, unknown>>;
|
|
16
16
|
activateUserProfile(this: That, params: T.SecurityActivateUserProfileRequest | TB.SecurityActivateUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityActivateUserProfileResponse>;
|
|
17
17
|
/**
|
|
18
18
|
* Enables authentication as a user and retrieve information about the authenticated user.
|
|
19
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
19
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-authenticate.html | Elasticsearch API documentation}
|
|
20
20
|
*/
|
|
21
21
|
authenticate(this: That, params?: T.SecurityAuthenticateRequest | TB.SecurityAuthenticateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityAuthenticateResponse>;
|
|
22
22
|
authenticate(this: That, params?: T.SecurityAuthenticateRequest | TB.SecurityAuthenticateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityAuthenticateResponse, unknown>>;
|
|
23
23
|
authenticate(this: That, params?: T.SecurityAuthenticateRequest | TB.SecurityAuthenticateRequest, options?: TransportRequestOptions): Promise<T.SecurityAuthenticateResponse>;
|
|
24
24
|
/**
|
|
25
25
|
* Updates the attributes of multiple existing API keys.
|
|
26
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
26
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-bulk-update-api-keys.html | Elasticsearch API documentation}
|
|
27
27
|
*/
|
|
28
28
|
bulkUpdateApiKeys(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
|
|
29
29
|
bulkUpdateApiKeys(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
|
|
30
30
|
bulkUpdateApiKeys(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
|
|
31
31
|
/**
|
|
32
32
|
* Changes the passwords of users in the native realm and built-in users.
|
|
33
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
33
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-change-password.html | Elasticsearch API documentation}
|
|
34
34
|
*/
|
|
35
35
|
changePassword(this: That, params?: T.SecurityChangePasswordRequest | TB.SecurityChangePasswordRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityChangePasswordResponse>;
|
|
36
36
|
changePassword(this: That, params?: T.SecurityChangePasswordRequest | TB.SecurityChangePasswordRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityChangePasswordResponse, unknown>>;
|
|
37
37
|
changePassword(this: That, params?: T.SecurityChangePasswordRequest | TB.SecurityChangePasswordRequest, options?: TransportRequestOptions): Promise<T.SecurityChangePasswordResponse>;
|
|
38
38
|
/**
|
|
39
39
|
* Clear a subset or all entries from the API key cache.
|
|
40
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
40
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-clear-api-key-cache.html | Elasticsearch API documentation}
|
|
41
41
|
*/
|
|
42
42
|
clearApiKeyCache(this: That, params: T.SecurityClearApiKeyCacheRequest | TB.SecurityClearApiKeyCacheRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearApiKeyCacheResponse>;
|
|
43
43
|
clearApiKeyCache(this: That, params: T.SecurityClearApiKeyCacheRequest | TB.SecurityClearApiKeyCacheRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityClearApiKeyCacheResponse, unknown>>;
|
|
44
44
|
clearApiKeyCache(this: That, params: T.SecurityClearApiKeyCacheRequest | TB.SecurityClearApiKeyCacheRequest, options?: TransportRequestOptions): Promise<T.SecurityClearApiKeyCacheResponse>;
|
|
45
45
|
/**
|
|
46
46
|
* Evicts application privileges from the native application privileges cache.
|
|
47
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
47
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-clear-privilege-cache.html | Elasticsearch API documentation}
|
|
48
48
|
*/
|
|
49
49
|
clearCachedPrivileges(this: That, params: T.SecurityClearCachedPrivilegesRequest | TB.SecurityClearCachedPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearCachedPrivilegesResponse>;
|
|
50
50
|
clearCachedPrivileges(this: That, params: T.SecurityClearCachedPrivilegesRequest | TB.SecurityClearCachedPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityClearCachedPrivilegesResponse, unknown>>;
|
|
51
51
|
clearCachedPrivileges(this: That, params: T.SecurityClearCachedPrivilegesRequest | TB.SecurityClearCachedPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityClearCachedPrivilegesResponse>;
|
|
52
52
|
/**
|
|
53
53
|
* Evicts users from the user cache. Can completely clear the cache or evict specific users.
|
|
54
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
54
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-clear-cache.html | Elasticsearch API documentation}
|
|
55
55
|
*/
|
|
56
56
|
clearCachedRealms(this: That, params: T.SecurityClearCachedRealmsRequest | TB.SecurityClearCachedRealmsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearCachedRealmsResponse>;
|
|
57
57
|
clearCachedRealms(this: That, params: T.SecurityClearCachedRealmsRequest | TB.SecurityClearCachedRealmsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityClearCachedRealmsResponse, unknown>>;
|
|
58
58
|
clearCachedRealms(this: That, params: T.SecurityClearCachedRealmsRequest | TB.SecurityClearCachedRealmsRequest, options?: TransportRequestOptions): Promise<T.SecurityClearCachedRealmsResponse>;
|
|
59
59
|
/**
|
|
60
60
|
* Evicts roles from the native role cache.
|
|
61
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
61
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-clear-role-cache.html | Elasticsearch API documentation}
|
|
62
62
|
*/
|
|
63
63
|
clearCachedRoles(this: That, params: T.SecurityClearCachedRolesRequest | TB.SecurityClearCachedRolesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearCachedRolesResponse>;
|
|
64
64
|
clearCachedRoles(this: That, params: T.SecurityClearCachedRolesRequest | TB.SecurityClearCachedRolesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityClearCachedRolesResponse, unknown>>;
|
|
65
65
|
clearCachedRoles(this: That, params: T.SecurityClearCachedRolesRequest | TB.SecurityClearCachedRolesRequest, options?: TransportRequestOptions): Promise<T.SecurityClearCachedRolesResponse>;
|
|
66
66
|
/**
|
|
67
67
|
* Evicts tokens from the service account token caches.
|
|
68
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
68
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-clear-service-token-caches.html | Elasticsearch API documentation}
|
|
69
69
|
*/
|
|
70
70
|
clearCachedServiceTokens(this: That, params: T.SecurityClearCachedServiceTokensRequest | TB.SecurityClearCachedServiceTokensRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearCachedServiceTokensResponse>;
|
|
71
71
|
clearCachedServiceTokens(this: That, params: T.SecurityClearCachedServiceTokensRequest | TB.SecurityClearCachedServiceTokensRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityClearCachedServiceTokensResponse, unknown>>;
|
|
72
72
|
clearCachedServiceTokens(this: That, params: T.SecurityClearCachedServiceTokensRequest | TB.SecurityClearCachedServiceTokensRequest, options?: TransportRequestOptions): Promise<T.SecurityClearCachedServiceTokensResponse>;
|
|
73
73
|
/**
|
|
74
74
|
* Creates an API key for access without requiring basic authentication.
|
|
75
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
75
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-create-api-key.html | Elasticsearch API documentation}
|
|
76
76
|
*/
|
|
77
77
|
createApiKey(this: That, params?: T.SecurityCreateApiKeyRequest | TB.SecurityCreateApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityCreateApiKeyResponse>;
|
|
78
78
|
createApiKey(this: That, params?: T.SecurityCreateApiKeyRequest | TB.SecurityCreateApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityCreateApiKeyResponse, unknown>>;
|
|
79
79
|
createApiKey(this: That, params?: T.SecurityCreateApiKeyRequest | TB.SecurityCreateApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityCreateApiKeyResponse>;
|
|
80
80
|
/**
|
|
81
81
|
* Creates a cross-cluster API key for API key based remote cluster access.
|
|
82
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
82
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-create-cross-cluster-api-key.html | Elasticsearch API documentation}
|
|
83
83
|
*/
|
|
84
84
|
createCrossClusterApiKey(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
|
|
85
85
|
createCrossClusterApiKey(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
|
|
86
86
|
createCrossClusterApiKey(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
|
|
87
87
|
/**
|
|
88
88
|
* Creates a service account token for access without requiring basic authentication.
|
|
89
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
89
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-create-service-token.html | Elasticsearch API documentation}
|
|
90
90
|
*/
|
|
91
91
|
createServiceToken(this: That, params: T.SecurityCreateServiceTokenRequest | TB.SecurityCreateServiceTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityCreateServiceTokenResponse>;
|
|
92
92
|
createServiceToken(this: That, params: T.SecurityCreateServiceTokenRequest | TB.SecurityCreateServiceTokenRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityCreateServiceTokenResponse, unknown>>;
|
|
93
93
|
createServiceToken(this: That, params: T.SecurityCreateServiceTokenRequest | TB.SecurityCreateServiceTokenRequest, options?: TransportRequestOptions): Promise<T.SecurityCreateServiceTokenResponse>;
|
|
94
94
|
/**
|
|
95
95
|
* Removes application privileges.
|
|
96
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
96
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-delete-privilege.html | Elasticsearch API documentation}
|
|
97
97
|
*/
|
|
98
98
|
deletePrivileges(this: That, params: T.SecurityDeletePrivilegesRequest | TB.SecurityDeletePrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeletePrivilegesResponse>;
|
|
99
99
|
deletePrivileges(this: That, params: T.SecurityDeletePrivilegesRequest | TB.SecurityDeletePrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDeletePrivilegesResponse, unknown>>;
|
|
100
100
|
deletePrivileges(this: That, params: T.SecurityDeletePrivilegesRequest | TB.SecurityDeletePrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityDeletePrivilegesResponse>;
|
|
101
101
|
/**
|
|
102
102
|
* Removes roles in the native realm.
|
|
103
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
103
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-delete-role.html | Elasticsearch API documentation}
|
|
104
104
|
*/
|
|
105
105
|
deleteRole(this: That, params: T.SecurityDeleteRoleRequest | TB.SecurityDeleteRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeleteRoleResponse>;
|
|
106
106
|
deleteRole(this: That, params: T.SecurityDeleteRoleRequest | TB.SecurityDeleteRoleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDeleteRoleResponse, unknown>>;
|
|
107
107
|
deleteRole(this: That, params: T.SecurityDeleteRoleRequest | TB.SecurityDeleteRoleRequest, options?: TransportRequestOptions): Promise<T.SecurityDeleteRoleResponse>;
|
|
108
108
|
/**
|
|
109
109
|
* Removes role mappings.
|
|
110
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
110
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-delete-role-mapping.html | Elasticsearch API documentation}
|
|
111
111
|
*/
|
|
112
112
|
deleteRoleMapping(this: That, params: T.SecurityDeleteRoleMappingRequest | TB.SecurityDeleteRoleMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeleteRoleMappingResponse>;
|
|
113
113
|
deleteRoleMapping(this: That, params: T.SecurityDeleteRoleMappingRequest | TB.SecurityDeleteRoleMappingRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDeleteRoleMappingResponse, unknown>>;
|
|
114
114
|
deleteRoleMapping(this: That, params: T.SecurityDeleteRoleMappingRequest | TB.SecurityDeleteRoleMappingRequest, options?: TransportRequestOptions): Promise<T.SecurityDeleteRoleMappingResponse>;
|
|
115
115
|
/**
|
|
116
116
|
* Deletes a service account token.
|
|
117
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
117
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-delete-service-token.html | Elasticsearch API documentation}
|
|
118
118
|
*/
|
|
119
119
|
deleteServiceToken(this: That, params: T.SecurityDeleteServiceTokenRequest | TB.SecurityDeleteServiceTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeleteServiceTokenResponse>;
|
|
120
120
|
deleteServiceToken(this: That, params: T.SecurityDeleteServiceTokenRequest | TB.SecurityDeleteServiceTokenRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDeleteServiceTokenResponse, unknown>>;
|
|
121
121
|
deleteServiceToken(this: That, params: T.SecurityDeleteServiceTokenRequest | TB.SecurityDeleteServiceTokenRequest, options?: TransportRequestOptions): Promise<T.SecurityDeleteServiceTokenResponse>;
|
|
122
122
|
/**
|
|
123
123
|
* Deletes users from the native realm.
|
|
124
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
124
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-delete-user.html | Elasticsearch API documentation}
|
|
125
125
|
*/
|
|
126
126
|
deleteUser(this: That, params: T.SecurityDeleteUserRequest | TB.SecurityDeleteUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeleteUserResponse>;
|
|
127
127
|
deleteUser(this: That, params: T.SecurityDeleteUserRequest | TB.SecurityDeleteUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDeleteUserResponse, unknown>>;
|
|
128
128
|
deleteUser(this: That, params: T.SecurityDeleteUserRequest | TB.SecurityDeleteUserRequest, options?: TransportRequestOptions): Promise<T.SecurityDeleteUserResponse>;
|
|
129
129
|
/**
|
|
130
130
|
* Disables users in the native realm.
|
|
131
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
131
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-disable-user.html | Elasticsearch API documentation}
|
|
132
132
|
*/
|
|
133
133
|
disableUser(this: That, params: T.SecurityDisableUserRequest | TB.SecurityDisableUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDisableUserResponse>;
|
|
134
134
|
disableUser(this: That, params: T.SecurityDisableUserRequest | TB.SecurityDisableUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDisableUserResponse, unknown>>;
|
|
135
135
|
disableUser(this: That, params: T.SecurityDisableUserRequest | TB.SecurityDisableUserRequest, options?: TransportRequestOptions): Promise<T.SecurityDisableUserResponse>;
|
|
136
136
|
/**
|
|
137
137
|
* Disables a user profile so it's not visible in user profile searches.
|
|
138
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
138
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-disable-user-profile.html | Elasticsearch API documentation}
|
|
139
139
|
*/
|
|
140
140
|
disableUserProfile(this: That, params: T.SecurityDisableUserProfileRequest | TB.SecurityDisableUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDisableUserProfileResponse>;
|
|
141
141
|
disableUserProfile(this: That, params: T.SecurityDisableUserProfileRequest | TB.SecurityDisableUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDisableUserProfileResponse, unknown>>;
|
|
142
142
|
disableUserProfile(this: That, params: T.SecurityDisableUserProfileRequest | TB.SecurityDisableUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityDisableUserProfileResponse>;
|
|
143
143
|
/**
|
|
144
144
|
* Enables users in the native realm.
|
|
145
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
145
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-enable-user.html | Elasticsearch API documentation}
|
|
146
146
|
*/
|
|
147
147
|
enableUser(this: That, params: T.SecurityEnableUserRequest | TB.SecurityEnableUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityEnableUserResponse>;
|
|
148
148
|
enableUser(this: That, params: T.SecurityEnableUserRequest | TB.SecurityEnableUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityEnableUserResponse, unknown>>;
|
|
149
149
|
enableUser(this: That, params: T.SecurityEnableUserRequest | TB.SecurityEnableUserRequest, options?: TransportRequestOptions): Promise<T.SecurityEnableUserResponse>;
|
|
150
150
|
/**
|
|
151
151
|
* Enables a user profile so it's visible in user profile searches.
|
|
152
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
152
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-enable-user-profile.html | Elasticsearch API documentation}
|
|
153
153
|
*/
|
|
154
154
|
enableUserProfile(this: That, params: T.SecurityEnableUserProfileRequest | TB.SecurityEnableUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityEnableUserProfileResponse>;
|
|
155
155
|
enableUserProfile(this: That, params: T.SecurityEnableUserProfileRequest | TB.SecurityEnableUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityEnableUserProfileResponse, unknown>>;
|
|
156
156
|
enableUserProfile(this: That, params: T.SecurityEnableUserProfileRequest | TB.SecurityEnableUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityEnableUserProfileResponse>;
|
|
157
157
|
/**
|
|
158
158
|
* Allows a kibana instance to configure itself to communicate with a secured elasticsearch cluster.
|
|
159
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
159
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-kibana-enrollment.html | Elasticsearch API documentation}
|
|
160
160
|
*/
|
|
161
161
|
enrollKibana(this: That, params?: T.SecurityEnrollKibanaRequest | TB.SecurityEnrollKibanaRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityEnrollKibanaResponse>;
|
|
162
162
|
enrollKibana(this: That, params?: T.SecurityEnrollKibanaRequest | TB.SecurityEnrollKibanaRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityEnrollKibanaResponse, unknown>>;
|
|
163
163
|
enrollKibana(this: That, params?: T.SecurityEnrollKibanaRequest | TB.SecurityEnrollKibanaRequest, options?: TransportRequestOptions): Promise<T.SecurityEnrollKibanaResponse>;
|
|
164
164
|
/**
|
|
165
165
|
* Allows a new node to enroll to an existing cluster with security enabled.
|
|
166
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
166
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-node-enrollment.html | Elasticsearch API documentation}
|
|
167
167
|
*/
|
|
168
168
|
enrollNode(this: That, params?: T.SecurityEnrollNodeRequest | TB.SecurityEnrollNodeRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityEnrollNodeResponse>;
|
|
169
169
|
enrollNode(this: That, params?: T.SecurityEnrollNodeRequest | TB.SecurityEnrollNodeRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityEnrollNodeResponse, unknown>>;
|
|
170
170
|
enrollNode(this: That, params?: T.SecurityEnrollNodeRequest | TB.SecurityEnrollNodeRequest, options?: TransportRequestOptions): Promise<T.SecurityEnrollNodeResponse>;
|
|
171
171
|
/**
|
|
172
172
|
* Retrieves information for one or more API keys.
|
|
173
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
173
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-get-api-key.html | Elasticsearch API documentation}
|
|
174
174
|
*/
|
|
175
175
|
getApiKey(this: That, params?: T.SecurityGetApiKeyRequest | TB.SecurityGetApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetApiKeyResponse>;
|
|
176
176
|
getApiKey(this: That, params?: T.SecurityGetApiKeyRequest | TB.SecurityGetApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetApiKeyResponse, unknown>>;
|
|
177
177
|
getApiKey(this: That, params?: T.SecurityGetApiKeyRequest | TB.SecurityGetApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityGetApiKeyResponse>;
|
|
178
178
|
/**
|
|
179
179
|
* Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.
|
|
180
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
180
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-get-builtin-privileges.html | Elasticsearch API documentation}
|
|
181
181
|
*/
|
|
182
182
|
getBuiltinPrivileges(this: That, params?: T.SecurityGetBuiltinPrivilegesRequest | TB.SecurityGetBuiltinPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetBuiltinPrivilegesResponse>;
|
|
183
183
|
getBuiltinPrivileges(this: That, params?: T.SecurityGetBuiltinPrivilegesRequest | TB.SecurityGetBuiltinPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetBuiltinPrivilegesResponse, unknown>>;
|
|
184
184
|
getBuiltinPrivileges(this: That, params?: T.SecurityGetBuiltinPrivilegesRequest | TB.SecurityGetBuiltinPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityGetBuiltinPrivilegesResponse>;
|
|
185
185
|
/**
|
|
186
186
|
* Retrieves application privileges.
|
|
187
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
187
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-get-privileges.html | Elasticsearch API documentation}
|
|
188
188
|
*/
|
|
189
189
|
getPrivileges(this: That, params?: T.SecurityGetPrivilegesRequest | TB.SecurityGetPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetPrivilegesResponse>;
|
|
190
190
|
getPrivileges(this: That, params?: T.SecurityGetPrivilegesRequest | TB.SecurityGetPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetPrivilegesResponse, unknown>>;
|
|
191
191
|
getPrivileges(this: That, params?: T.SecurityGetPrivilegesRequest | TB.SecurityGetPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityGetPrivilegesResponse>;
|
|
192
192
|
/**
|
|
193
193
|
* Retrieves roles in the native realm.
|
|
194
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
194
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-get-role.html | Elasticsearch API documentation}
|
|
195
195
|
*/
|
|
196
196
|
getRole(this: That, params?: T.SecurityGetRoleRequest | TB.SecurityGetRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetRoleResponse>;
|
|
197
197
|
getRole(this: That, params?: T.SecurityGetRoleRequest | TB.SecurityGetRoleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetRoleResponse, unknown>>;
|
|
198
198
|
getRole(this: That, params?: T.SecurityGetRoleRequest | TB.SecurityGetRoleRequest, options?: TransportRequestOptions): Promise<T.SecurityGetRoleResponse>;
|
|
199
199
|
/**
|
|
200
200
|
* Retrieves role mappings.
|
|
201
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
201
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-get-role-mapping.html | Elasticsearch API documentation}
|
|
202
202
|
*/
|
|
203
203
|
getRoleMapping(this: That, params?: T.SecurityGetRoleMappingRequest | TB.SecurityGetRoleMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetRoleMappingResponse>;
|
|
204
204
|
getRoleMapping(this: That, params?: T.SecurityGetRoleMappingRequest | TB.SecurityGetRoleMappingRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetRoleMappingResponse, unknown>>;
|
|
205
205
|
getRoleMapping(this: That, params?: T.SecurityGetRoleMappingRequest | TB.SecurityGetRoleMappingRequest, options?: TransportRequestOptions): Promise<T.SecurityGetRoleMappingResponse>;
|
|
206
206
|
/**
|
|
207
207
|
* Retrieves information about service accounts.
|
|
208
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
208
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-get-service-accounts.html | Elasticsearch API documentation}
|
|
209
209
|
*/
|
|
210
210
|
getServiceAccounts(this: That, params?: T.SecurityGetServiceAccountsRequest | TB.SecurityGetServiceAccountsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetServiceAccountsResponse>;
|
|
211
211
|
getServiceAccounts(this: That, params?: T.SecurityGetServiceAccountsRequest | TB.SecurityGetServiceAccountsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetServiceAccountsResponse, unknown>>;
|
|
212
212
|
getServiceAccounts(this: That, params?: T.SecurityGetServiceAccountsRequest | TB.SecurityGetServiceAccountsRequest, options?: TransportRequestOptions): Promise<T.SecurityGetServiceAccountsResponse>;
|
|
213
213
|
/**
|
|
214
214
|
* Retrieves information of all service credentials for a service account.
|
|
215
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
215
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-get-service-credentials.html | Elasticsearch API documentation}
|
|
216
216
|
*/
|
|
217
217
|
getServiceCredentials(this: That, params: T.SecurityGetServiceCredentialsRequest | TB.SecurityGetServiceCredentialsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetServiceCredentialsResponse>;
|
|
218
218
|
getServiceCredentials(this: That, params: T.SecurityGetServiceCredentialsRequest | TB.SecurityGetServiceCredentialsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetServiceCredentialsResponse, unknown>>;
|
|
219
219
|
getServiceCredentials(this: That, params: T.SecurityGetServiceCredentialsRequest | TB.SecurityGetServiceCredentialsRequest, options?: TransportRequestOptions): Promise<T.SecurityGetServiceCredentialsResponse>;
|
|
220
220
|
/**
|
|
221
221
|
* Creates a bearer token for access without requiring basic authentication.
|
|
222
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
222
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-get-token.html | Elasticsearch API documentation}
|
|
223
223
|
*/
|
|
224
224
|
getToken(this: That, params?: T.SecurityGetTokenRequest | TB.SecurityGetTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetTokenResponse>;
|
|
225
225
|
getToken(this: That, params?: T.SecurityGetTokenRequest | TB.SecurityGetTokenRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetTokenResponse, unknown>>;
|
|
226
226
|
getToken(this: That, params?: T.SecurityGetTokenRequest | TB.SecurityGetTokenRequest, options?: TransportRequestOptions): Promise<T.SecurityGetTokenResponse>;
|
|
227
227
|
/**
|
|
228
228
|
* Retrieves information about users in the native realm and built-in users.
|
|
229
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
229
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-get-user.html | Elasticsearch API documentation}
|
|
230
230
|
*/
|
|
231
231
|
getUser(this: That, params?: T.SecurityGetUserRequest | TB.SecurityGetUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetUserResponse>;
|
|
232
232
|
getUser(this: That, params?: T.SecurityGetUserRequest | TB.SecurityGetUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetUserResponse, unknown>>;
|
|
233
233
|
getUser(this: That, params?: T.SecurityGetUserRequest | TB.SecurityGetUserRequest, options?: TransportRequestOptions): Promise<T.SecurityGetUserResponse>;
|
|
234
234
|
/**
|
|
235
235
|
* Retrieves security privileges for the logged in user.
|
|
236
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
236
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-get-user-privileges.html | Elasticsearch API documentation}
|
|
237
237
|
*/
|
|
238
238
|
getUserPrivileges(this: That, params?: T.SecurityGetUserPrivilegesRequest | TB.SecurityGetUserPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetUserPrivilegesResponse>;
|
|
239
239
|
getUserPrivileges(this: That, params?: T.SecurityGetUserPrivilegesRequest | TB.SecurityGetUserPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetUserPrivilegesResponse, unknown>>;
|
|
240
240
|
getUserPrivileges(this: That, params?: T.SecurityGetUserPrivilegesRequest | TB.SecurityGetUserPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityGetUserPrivilegesResponse>;
|
|
241
241
|
/**
|
|
242
242
|
* Retrieves user profiles for the given unique ID(s).
|
|
243
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
243
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-get-user-profile.html | Elasticsearch API documentation}
|
|
244
244
|
*/
|
|
245
245
|
getUserProfile(this: That, params: T.SecurityGetUserProfileRequest | TB.SecurityGetUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetUserProfileResponse>;
|
|
246
246
|
getUserProfile(this: That, params: T.SecurityGetUserProfileRequest | TB.SecurityGetUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetUserProfileResponse, unknown>>;
|
|
247
247
|
getUserProfile(this: That, params: T.SecurityGetUserProfileRequest | TB.SecurityGetUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityGetUserProfileResponse>;
|
|
248
248
|
/**
|
|
249
249
|
* Creates an API key on behalf of another user.
|
|
250
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
250
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-grant-api-key.html | Elasticsearch API documentation}
|
|
251
251
|
*/
|
|
252
252
|
grantApiKey(this: That, params: T.SecurityGrantApiKeyRequest | TB.SecurityGrantApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGrantApiKeyResponse>;
|
|
253
253
|
grantApiKey(this: That, params: T.SecurityGrantApiKeyRequest | TB.SecurityGrantApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGrantApiKeyResponse, unknown>>;
|
|
254
254
|
grantApiKey(this: That, params: T.SecurityGrantApiKeyRequest | TB.SecurityGrantApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityGrantApiKeyResponse>;
|
|
255
255
|
/**
|
|
256
256
|
* Determines whether the specified user has a specified list of privileges.
|
|
257
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
257
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-has-privileges.html | Elasticsearch API documentation}
|
|
258
258
|
*/
|
|
259
259
|
hasPrivileges(this: That, params?: T.SecurityHasPrivilegesRequest | TB.SecurityHasPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityHasPrivilegesResponse>;
|
|
260
260
|
hasPrivileges(this: That, params?: T.SecurityHasPrivilegesRequest | TB.SecurityHasPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityHasPrivilegesResponse, unknown>>;
|
|
261
261
|
hasPrivileges(this: That, params?: T.SecurityHasPrivilegesRequest | TB.SecurityHasPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityHasPrivilegesResponse>;
|
|
262
262
|
/**
|
|
263
263
|
* Determines whether the users associated with the specified profile IDs have all the requested privileges.
|
|
264
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
264
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-has-privileges-user-profile.html | Elasticsearch API documentation}
|
|
265
265
|
*/
|
|
266
266
|
hasPrivilegesUserProfile(this: That, params: T.SecurityHasPrivilegesUserProfileRequest | TB.SecurityHasPrivilegesUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityHasPrivilegesUserProfileResponse>;
|
|
267
267
|
hasPrivilegesUserProfile(this: That, params: T.SecurityHasPrivilegesUserProfileRequest | TB.SecurityHasPrivilegesUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityHasPrivilegesUserProfileResponse, unknown>>;
|
|
268
268
|
hasPrivilegesUserProfile(this: That, params: T.SecurityHasPrivilegesUserProfileRequest | TB.SecurityHasPrivilegesUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityHasPrivilegesUserProfileResponse>;
|
|
269
269
|
/**
|
|
270
270
|
* Invalidates one or more API keys.
|
|
271
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
271
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-invalidate-api-key.html | Elasticsearch API documentation}
|
|
272
272
|
*/
|
|
273
273
|
invalidateApiKey(this: That, params?: T.SecurityInvalidateApiKeyRequest | TB.SecurityInvalidateApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityInvalidateApiKeyResponse>;
|
|
274
274
|
invalidateApiKey(this: That, params?: T.SecurityInvalidateApiKeyRequest | TB.SecurityInvalidateApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityInvalidateApiKeyResponse, unknown>>;
|
|
275
275
|
invalidateApiKey(this: That, params?: T.SecurityInvalidateApiKeyRequest | TB.SecurityInvalidateApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityInvalidateApiKeyResponse>;
|
|
276
276
|
/**
|
|
277
277
|
* Invalidates one or more access tokens or refresh tokens.
|
|
278
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
278
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-invalidate-token.html | Elasticsearch API documentation}
|
|
279
279
|
*/
|
|
280
280
|
invalidateToken(this: That, params?: T.SecurityInvalidateTokenRequest | TB.SecurityInvalidateTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityInvalidateTokenResponse>;
|
|
281
281
|
invalidateToken(this: That, params?: T.SecurityInvalidateTokenRequest | TB.SecurityInvalidateTokenRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityInvalidateTokenResponse, unknown>>;
|
|
282
282
|
invalidateToken(this: That, params?: T.SecurityInvalidateTokenRequest | TB.SecurityInvalidateTokenRequest, options?: TransportRequestOptions): Promise<T.SecurityInvalidateTokenResponse>;
|
|
283
283
|
/**
|
|
284
284
|
* Exchanges an OpenID Connection authentication response message for an Elasticsearch access token and refresh token pair
|
|
285
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
285
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-oidc-authenticate.html | Elasticsearch API documentation}
|
|
286
286
|
*/
|
|
287
287
|
oidcAuthenticate(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
|
|
288
288
|
oidcAuthenticate(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
|
|
289
289
|
oidcAuthenticate(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
|
|
290
290
|
/**
|
|
291
291
|
* Invalidates a refresh token and access token that was generated from the OpenID Connect Authenticate API
|
|
292
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
292
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-oidc-logout.html | Elasticsearch API documentation}
|
|
293
293
|
*/
|
|
294
294
|
oidcLogout(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
|
|
295
295
|
oidcLogout(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
|
|
296
296
|
oidcLogout(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
|
|
297
297
|
/**
|
|
298
298
|
* Creates an OAuth 2.0 authentication request as a URL string
|
|
299
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
299
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-oidc-prepare-authentication.html | Elasticsearch API documentation}
|
|
300
300
|
*/
|
|
301
301
|
oidcPrepareAuthentication(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
|
|
302
302
|
oidcPrepareAuthentication(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
|
|
303
303
|
oidcPrepareAuthentication(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
|
|
304
304
|
/**
|
|
305
305
|
* Adds or updates application privileges.
|
|
306
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
306
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-put-privileges.html | Elasticsearch API documentation}
|
|
307
307
|
*/
|
|
308
308
|
putPrivileges(this: That, params: T.SecurityPutPrivilegesRequest | TB.SecurityPutPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityPutPrivilegesResponse>;
|
|
309
309
|
putPrivileges(this: That, params: T.SecurityPutPrivilegesRequest | TB.SecurityPutPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityPutPrivilegesResponse, unknown>>;
|
|
310
310
|
putPrivileges(this: That, params: T.SecurityPutPrivilegesRequest | TB.SecurityPutPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityPutPrivilegesResponse>;
|
|
311
311
|
/**
|
|
312
312
|
* Adds and updates roles in the native realm.
|
|
313
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
313
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-put-role.html | Elasticsearch API documentation}
|
|
314
314
|
*/
|
|
315
315
|
putRole(this: That, params: T.SecurityPutRoleRequest | TB.SecurityPutRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityPutRoleResponse>;
|
|
316
316
|
putRole(this: That, params: T.SecurityPutRoleRequest | TB.SecurityPutRoleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityPutRoleResponse, unknown>>;
|
|
317
317
|
putRole(this: That, params: T.SecurityPutRoleRequest | TB.SecurityPutRoleRequest, options?: TransportRequestOptions): Promise<T.SecurityPutRoleResponse>;
|
|
318
318
|
/**
|
|
319
319
|
* Creates and updates role mappings.
|
|
320
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
320
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-put-role-mapping.html | Elasticsearch API documentation}
|
|
321
321
|
*/
|
|
322
322
|
putRoleMapping(this: That, params: T.SecurityPutRoleMappingRequest | TB.SecurityPutRoleMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityPutRoleMappingResponse>;
|
|
323
323
|
putRoleMapping(this: That, params: T.SecurityPutRoleMappingRequest | TB.SecurityPutRoleMappingRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityPutRoleMappingResponse, unknown>>;
|
|
324
324
|
putRoleMapping(this: That, params: T.SecurityPutRoleMappingRequest | TB.SecurityPutRoleMappingRequest, options?: TransportRequestOptions): Promise<T.SecurityPutRoleMappingResponse>;
|
|
325
325
|
/**
|
|
326
326
|
* Adds and updates users in the native realm. These users are commonly referred to as native users.
|
|
327
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
327
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-put-user.html | Elasticsearch API documentation}
|
|
328
328
|
*/
|
|
329
329
|
putUser(this: That, params: T.SecurityPutUserRequest | TB.SecurityPutUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityPutUserResponse>;
|
|
330
330
|
putUser(this: That, params: T.SecurityPutUserRequest | TB.SecurityPutUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityPutUserResponse, unknown>>;
|
|
331
331
|
putUser(this: That, params: T.SecurityPutUserRequest | TB.SecurityPutUserRequest, options?: TransportRequestOptions): Promise<T.SecurityPutUserResponse>;
|
|
332
332
|
/**
|
|
333
333
|
* Retrieves information for API keys using a subset of query DSL
|
|
334
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
334
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-query-api-key.html | Elasticsearch API documentation}
|
|
335
335
|
*/
|
|
336
336
|
queryApiKeys(this: That, params?: T.SecurityQueryApiKeysRequest | TB.SecurityQueryApiKeysRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityQueryApiKeysResponse>;
|
|
337
337
|
queryApiKeys(this: That, params?: T.SecurityQueryApiKeysRequest | TB.SecurityQueryApiKeysRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityQueryApiKeysResponse, unknown>>;
|
|
338
338
|
queryApiKeys(this: That, params?: T.SecurityQueryApiKeysRequest | TB.SecurityQueryApiKeysRequest, options?: TransportRequestOptions): Promise<T.SecurityQueryApiKeysResponse>;
|
|
339
339
|
/**
|
|
340
340
|
* Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair
|
|
341
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
341
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-saml-authenticate.html | Elasticsearch API documentation}
|
|
342
342
|
*/
|
|
343
343
|
samlAuthenticate(this: That, params: T.SecuritySamlAuthenticateRequest | TB.SecuritySamlAuthenticateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlAuthenticateResponse>;
|
|
344
344
|
samlAuthenticate(this: That, params: T.SecuritySamlAuthenticateRequest | TB.SecuritySamlAuthenticateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlAuthenticateResponse, unknown>>;
|
|
345
345
|
samlAuthenticate(this: That, params: T.SecuritySamlAuthenticateRequest | TB.SecuritySamlAuthenticateRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlAuthenticateResponse>;
|
|
346
346
|
/**
|
|
347
347
|
* Verifies the logout response sent from the SAML IdP
|
|
348
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
348
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-saml-complete-logout.html | Elasticsearch API documentation}
|
|
349
349
|
*/
|
|
350
350
|
samlCompleteLogout(this: That, params: T.SecuritySamlCompleteLogoutRequest | TB.SecuritySamlCompleteLogoutRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlCompleteLogoutResponse>;
|
|
351
351
|
samlCompleteLogout(this: That, params: T.SecuritySamlCompleteLogoutRequest | TB.SecuritySamlCompleteLogoutRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlCompleteLogoutResponse, unknown>>;
|
|
352
352
|
samlCompleteLogout(this: That, params: T.SecuritySamlCompleteLogoutRequest | TB.SecuritySamlCompleteLogoutRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlCompleteLogoutResponse>;
|
|
353
353
|
/**
|
|
354
354
|
* Consumes a SAML LogoutRequest
|
|
355
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
355
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-saml-invalidate.html | Elasticsearch API documentation}
|
|
356
356
|
*/
|
|
357
357
|
samlInvalidate(this: That, params: T.SecuritySamlInvalidateRequest | TB.SecuritySamlInvalidateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlInvalidateResponse>;
|
|
358
358
|
samlInvalidate(this: That, params: T.SecuritySamlInvalidateRequest | TB.SecuritySamlInvalidateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlInvalidateResponse, unknown>>;
|
|
359
359
|
samlInvalidate(this: That, params: T.SecuritySamlInvalidateRequest | TB.SecuritySamlInvalidateRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlInvalidateResponse>;
|
|
360
360
|
/**
|
|
361
361
|
* Invalidates an access token and a refresh token that were generated via the SAML Authenticate API
|
|
362
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
362
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-saml-logout.html | Elasticsearch API documentation}
|
|
363
363
|
*/
|
|
364
364
|
samlLogout(this: That, params: T.SecuritySamlLogoutRequest | TB.SecuritySamlLogoutRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlLogoutResponse>;
|
|
365
365
|
samlLogout(this: That, params: T.SecuritySamlLogoutRequest | TB.SecuritySamlLogoutRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlLogoutResponse, unknown>>;
|
|
366
366
|
samlLogout(this: That, params: T.SecuritySamlLogoutRequest | TB.SecuritySamlLogoutRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlLogoutResponse>;
|
|
367
367
|
/**
|
|
368
368
|
* Creates a SAML authentication request
|
|
369
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
369
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-saml-prepare-authentication.html | Elasticsearch API documentation}
|
|
370
370
|
*/
|
|
371
371
|
samlPrepareAuthentication(this: That, params?: T.SecuritySamlPrepareAuthenticationRequest | TB.SecuritySamlPrepareAuthenticationRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlPrepareAuthenticationResponse>;
|
|
372
372
|
samlPrepareAuthentication(this: That, params?: T.SecuritySamlPrepareAuthenticationRequest | TB.SecuritySamlPrepareAuthenticationRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlPrepareAuthenticationResponse, unknown>>;
|
|
373
373
|
samlPrepareAuthentication(this: That, params?: T.SecuritySamlPrepareAuthenticationRequest | TB.SecuritySamlPrepareAuthenticationRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlPrepareAuthenticationResponse>;
|
|
374
374
|
/**
|
|
375
375
|
* Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider
|
|
376
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
376
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-saml-sp-metadata.html | Elasticsearch API documentation}
|
|
377
377
|
*/
|
|
378
378
|
samlServiceProviderMetadata(this: That, params: T.SecuritySamlServiceProviderMetadataRequest | TB.SecuritySamlServiceProviderMetadataRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlServiceProviderMetadataResponse>;
|
|
379
379
|
samlServiceProviderMetadata(this: That, params: T.SecuritySamlServiceProviderMetadataRequest | TB.SecuritySamlServiceProviderMetadataRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlServiceProviderMetadataResponse, unknown>>;
|
|
380
380
|
samlServiceProviderMetadata(this: That, params: T.SecuritySamlServiceProviderMetadataRequest | TB.SecuritySamlServiceProviderMetadataRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlServiceProviderMetadataResponse>;
|
|
381
381
|
/**
|
|
382
382
|
* Get suggestions for user profiles that match specified search criteria.
|
|
383
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
383
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-suggest-user-profile.html | Elasticsearch API documentation}
|
|
384
384
|
*/
|
|
385
385
|
suggestUserProfiles(this: That, params?: T.SecuritySuggestUserProfilesRequest | TB.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySuggestUserProfilesResponse>;
|
|
386
386
|
suggestUserProfiles(this: That, params?: T.SecuritySuggestUserProfilesRequest | TB.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySuggestUserProfilesResponse, unknown>>;
|
|
387
387
|
suggestUserProfiles(this: That, params?: T.SecuritySuggestUserProfilesRequest | TB.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptions): Promise<T.SecuritySuggestUserProfilesResponse>;
|
|
388
388
|
/**
|
|
389
389
|
* Updates attributes of an existing API key.
|
|
390
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
390
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-update-api-key.html | Elasticsearch API documentation}
|
|
391
391
|
*/
|
|
392
392
|
updateApiKey(this: That, params: T.SecurityUpdateApiKeyRequest | TB.SecurityUpdateApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityUpdateApiKeyResponse>;
|
|
393
393
|
updateApiKey(this: That, params: T.SecurityUpdateApiKeyRequest | TB.SecurityUpdateApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityUpdateApiKeyResponse, unknown>>;
|
|
394
394
|
updateApiKey(this: That, params: T.SecurityUpdateApiKeyRequest | TB.SecurityUpdateApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityUpdateApiKeyResponse>;
|
|
395
395
|
/**
|
|
396
396
|
* Updates attributes of an existing cross-cluster API key.
|
|
397
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
397
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-update-cross-cluster-api-key.html | Elasticsearch API documentation}
|
|
398
398
|
*/
|
|
399
399
|
updateCrossClusterApiKey(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
|
|
400
400
|
updateCrossClusterApiKey(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
|
|
401
401
|
updateCrossClusterApiKey(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
|
|
402
402
|
/**
|
|
403
403
|
* Update application specific data for the user profile of the given unique ID.
|
|
404
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
404
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/security-api-update-user-profile-data.html | Elasticsearch API documentation}
|
|
405
405
|
*/
|
|
406
406
|
updateUserProfileData(this: That, params: T.SecurityUpdateUserProfileDataRequest | TB.SecurityUpdateUserProfileDataRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityUpdateUserProfileDataResponse>;
|
|
407
407
|
updateUserProfileData(this: That, params: T.SecurityUpdateUserProfileDataRequest | TB.SecurityUpdateUserProfileDataRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityUpdateUserProfileDataResponse, unknown>>;
|
package/lib/api/api/slm.d.ts
CHANGED
|
@@ -9,63 +9,63 @@ export default class Slm {
|
|
|
9
9
|
constructor(transport: Transport);
|
|
10
10
|
/**
|
|
11
11
|
* Deletes an existing snapshot lifecycle policy.
|
|
12
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
12
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/slm-api-delete-policy.html | Elasticsearch API documentation}
|
|
13
13
|
*/
|
|
14
14
|
deleteLifecycle(this: That, params: T.SlmDeleteLifecycleRequest | TB.SlmDeleteLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SlmDeleteLifecycleResponse>;
|
|
15
15
|
deleteLifecycle(this: That, params: T.SlmDeleteLifecycleRequest | TB.SlmDeleteLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SlmDeleteLifecycleResponse, unknown>>;
|
|
16
16
|
deleteLifecycle(this: That, params: T.SlmDeleteLifecycleRequest | TB.SlmDeleteLifecycleRequest, options?: TransportRequestOptions): Promise<T.SlmDeleteLifecycleResponse>;
|
|
17
17
|
/**
|
|
18
18
|
* Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.
|
|
19
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
19
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/slm-api-execute-lifecycle.html | Elasticsearch API documentation}
|
|
20
20
|
*/
|
|
21
21
|
executeLifecycle(this: That, params: T.SlmExecuteLifecycleRequest | TB.SlmExecuteLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SlmExecuteLifecycleResponse>;
|
|
22
22
|
executeLifecycle(this: That, params: T.SlmExecuteLifecycleRequest | TB.SlmExecuteLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SlmExecuteLifecycleResponse, unknown>>;
|
|
23
23
|
executeLifecycle(this: That, params: T.SlmExecuteLifecycleRequest | TB.SlmExecuteLifecycleRequest, options?: TransportRequestOptions): Promise<T.SlmExecuteLifecycleResponse>;
|
|
24
24
|
/**
|
|
25
25
|
* Deletes any snapshots that are expired according to the policy's retention rules.
|
|
26
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
26
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/slm-api-execute-retention.html | Elasticsearch API documentation}
|
|
27
27
|
*/
|
|
28
28
|
executeRetention(this: That, params?: T.SlmExecuteRetentionRequest | TB.SlmExecuteRetentionRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SlmExecuteRetentionResponse>;
|
|
29
29
|
executeRetention(this: That, params?: T.SlmExecuteRetentionRequest | TB.SlmExecuteRetentionRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SlmExecuteRetentionResponse, unknown>>;
|
|
30
30
|
executeRetention(this: That, params?: T.SlmExecuteRetentionRequest | TB.SlmExecuteRetentionRequest, options?: TransportRequestOptions): Promise<T.SlmExecuteRetentionResponse>;
|
|
31
31
|
/**
|
|
32
32
|
* Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.
|
|
33
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
33
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/slm-api-get-policy.html | Elasticsearch API documentation}
|
|
34
34
|
*/
|
|
35
35
|
getLifecycle(this: That, params?: T.SlmGetLifecycleRequest | TB.SlmGetLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SlmGetLifecycleResponse>;
|
|
36
36
|
getLifecycle(this: That, params?: T.SlmGetLifecycleRequest | TB.SlmGetLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SlmGetLifecycleResponse, unknown>>;
|
|
37
37
|
getLifecycle(this: That, params?: T.SlmGetLifecycleRequest | TB.SlmGetLifecycleRequest, options?: TransportRequestOptions): Promise<T.SlmGetLifecycleResponse>;
|
|
38
38
|
/**
|
|
39
39
|
* Returns global and policy-level statistics about actions taken by snapshot lifecycle management.
|
|
40
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
40
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/slm-api-get-stats.html | Elasticsearch API documentation}
|
|
41
41
|
*/
|
|
42
42
|
getStats(this: That, params?: T.SlmGetStatsRequest | TB.SlmGetStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SlmGetStatsResponse>;
|
|
43
43
|
getStats(this: That, params?: T.SlmGetStatsRequest | TB.SlmGetStatsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SlmGetStatsResponse, unknown>>;
|
|
44
44
|
getStats(this: That, params?: T.SlmGetStatsRequest | TB.SlmGetStatsRequest, options?: TransportRequestOptions): Promise<T.SlmGetStatsResponse>;
|
|
45
45
|
/**
|
|
46
46
|
* Retrieves the status of snapshot lifecycle management (SLM).
|
|
47
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
47
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/slm-api-get-status.html | Elasticsearch API documentation}
|
|
48
48
|
*/
|
|
49
49
|
getStatus(this: That, params?: T.SlmGetStatusRequest | TB.SlmGetStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SlmGetStatusResponse>;
|
|
50
50
|
getStatus(this: That, params?: T.SlmGetStatusRequest | TB.SlmGetStatusRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SlmGetStatusResponse, unknown>>;
|
|
51
51
|
getStatus(this: That, params?: T.SlmGetStatusRequest | TB.SlmGetStatusRequest, options?: TransportRequestOptions): Promise<T.SlmGetStatusResponse>;
|
|
52
52
|
/**
|
|
53
53
|
* Creates or updates a snapshot lifecycle policy.
|
|
54
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
54
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/slm-api-put-policy.html | Elasticsearch API documentation}
|
|
55
55
|
*/
|
|
56
56
|
putLifecycle(this: That, params: T.SlmPutLifecycleRequest | TB.SlmPutLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SlmPutLifecycleResponse>;
|
|
57
57
|
putLifecycle(this: That, params: T.SlmPutLifecycleRequest | TB.SlmPutLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SlmPutLifecycleResponse, unknown>>;
|
|
58
58
|
putLifecycle(this: That, params: T.SlmPutLifecycleRequest | TB.SlmPutLifecycleRequest, options?: TransportRequestOptions): Promise<T.SlmPutLifecycleResponse>;
|
|
59
59
|
/**
|
|
60
60
|
* Turns on snapshot lifecycle management (SLM).
|
|
61
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
61
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/slm-api-start.html | Elasticsearch API documentation}
|
|
62
62
|
*/
|
|
63
63
|
start(this: That, params?: T.SlmStartRequest | TB.SlmStartRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SlmStartResponse>;
|
|
64
64
|
start(this: That, params?: T.SlmStartRequest | TB.SlmStartRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SlmStartResponse, unknown>>;
|
|
65
65
|
start(this: That, params?: T.SlmStartRequest | TB.SlmStartRequest, options?: TransportRequestOptions): Promise<T.SlmStartResponse>;
|
|
66
66
|
/**
|
|
67
67
|
* Turns off snapshot lifecycle management (SLM).
|
|
68
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
68
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/slm-api-stop.html | Elasticsearch API documentation}
|
|
69
69
|
*/
|
|
70
70
|
stop(this: That, params?: T.SlmStopRequest | TB.SlmStopRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SlmStopResponse>;
|
|
71
71
|
stop(this: That, params?: T.SlmStopRequest | TB.SlmStopRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SlmStopResponse, unknown>>;
|