habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
b140fcda7f1d0e35dcf6fe3658ffe536a133c979
elasticsearch-js/docs/reference/api/Slm.md
Josh Mock b140fcda7f Another round of tweaks
2025-05-28 10:02:30 -05:00

10 KiB
Raw Blame History

Slm [class-Slm]

Constructor

new Slm(transport: [Transport](./Transport.md));

Properties [class-properties-Slm]

Name Type Description
acceptedParams Record<string, { path: string[]; body: string[]; query: string[]; }>  
transport Transport  

Methods [class-methods-Slm]

Name Signature Description
deleteLifecycle deleteLifecycle(this: [That](./That.md), params: [SlmDeleteLifecycleRequest](./SlmDeleteLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmDeleteLifecycleResponse](./SlmDeleteLifecycleResponse.md)>; Delete a policy. Delete a snapshot lifecycle policy definition. This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots.
deleteLifecycle deleteLifecycle(this: [That](./That.md), params: [SlmDeleteLifecycleRequest](./SlmDeleteLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmDeleteLifecycleResponse](./SlmDeleteLifecycleResponse.md), unknown>>;  
deleteLifecycle deleteLifecycle(this: [That](./That.md), params: [SlmDeleteLifecycleRequest](./SlmDeleteLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmDeleteLifecycleResponse](./SlmDeleteLifecycleResponse.md)>;  
executeLifecycle executeLifecycle(this: [That](./That.md), params: [SlmExecuteLifecycleRequest](./SlmExecuteLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmExecuteLifecycleResponse](./SlmExecuteLifecycleResponse.md)>; Run a policy. Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance.
executeLifecycle executeLifecycle(this: [That](./That.md), params: [SlmExecuteLifecycleRequest](./SlmExecuteLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmExecuteLifecycleResponse](./SlmExecuteLifecycleResponse.md), unknown>>;  
executeLifecycle executeLifecycle(this: [That](./That.md), params: [SlmExecuteLifecycleRequest](./SlmExecuteLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmExecuteLifecycleResponse](./SlmExecuteLifecycleResponse.md)>;  
executeRetention executeRetention(this: [That](./That.md), params?: [SlmExecuteRetentionRequest](./SlmExecuteRetentionRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmExecuteRetentionResponse](./SlmExecuteRetentionResponse.md)>; Run a retention policy. Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. The retention policy is normally applied according to its schedule.
executeRetention executeRetention(this: [That](./That.md), params?: [SlmExecuteRetentionRequest](./SlmExecuteRetentionRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmExecuteRetentionResponse](./SlmExecuteRetentionResponse.md), unknown>>;  
executeRetention executeRetention(this: [That](./That.md), params?: [SlmExecuteRetentionRequest](./SlmExecuteRetentionRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmExecuteRetentionResponse](./SlmExecuteRetentionResponse.md)>;  
getLifecycle getLifecycle(this: [That](./That.md), params?: [SlmGetLifecycleRequest](./SlmGetLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmGetLifecycleResponse](./SlmGetLifecycleResponse.md)>; Get policy information. Get snapshot lifecycle policy definitions and information about the latest snapshot attempts.
getLifecycle getLifecycle(this: [That](./That.md), params?: [SlmGetLifecycleRequest](./SlmGetLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmGetLifecycleResponse](./SlmGetLifecycleResponse.md), unknown>>;  
getLifecycle getLifecycle(this: [That](./That.md), params?: [SlmGetLifecycleRequest](./SlmGetLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmGetLifecycleResponse](./SlmGetLifecycleResponse.md)>;  
getStats getStats(this: [That](./That.md), params?: [SlmGetStatsRequest](./SlmGetStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmGetStatsResponse](./SlmGetStatsResponse.md)>; Get snapshot lifecycle management statistics. Get global and policy-level statistics about actions taken by snapshot lifecycle management.
getStats getStats(this: [That](./That.md), params?: [SlmGetStatsRequest](./SlmGetStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmGetStatsResponse](./SlmGetStatsResponse.md), unknown>>;  
getStats getStats(this: [That](./That.md), params?: [SlmGetStatsRequest](./SlmGetStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmGetStatsResponse](./SlmGetStatsResponse.md)>;  
getStatus getStatus(this: [That](./That.md), params?: [SlmGetStatusRequest](./SlmGetStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmGetStatusResponse](./SlmGetStatusResponse.md)>; Get the snapshot lifecycle management status.
getStatus getStatus(this: [That](./That.md), params?: [SlmGetStatusRequest](./SlmGetStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmGetStatusResponse](./SlmGetStatusResponse.md), unknown>>;  
getStatus getStatus(this: [That](./That.md), params?: [SlmGetStatusRequest](./SlmGetStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmGetStatusResponse](./SlmGetStatusResponse.md)>;  
putLifecycle putLifecycle(this: [That](./That.md), params: [SlmPutLifecycleRequest](./SlmPutLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmPutLifecycleResponse](./SlmPutLifecycleResponse.md)>; Create or update a policy. Create or update a snapshot lifecycle policy. If the policy already exists, this request increments the policy version. Only the latest version of a policy is stored.
putLifecycle putLifecycle(this: [That](./That.md), params: [SlmPutLifecycleRequest](./SlmPutLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmPutLifecycleResponse](./SlmPutLifecycleResponse.md), unknown>>;  
putLifecycle putLifecycle(this: [That](./That.md), params: [SlmPutLifecycleRequest](./SlmPutLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmPutLifecycleResponse](./SlmPutLifecycleResponse.md)>;  
start start(this: [That](./That.md), params?: [SlmStartRequest](./SlmStartRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmStartResponse](./SlmStartResponse.md)>; Start snapshot lifecycle management. Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. Manually starting SLM is necessary only if it has been stopped using the stop SLM API.
start start(this: [That](./That.md), params?: [SlmStartRequest](./SlmStartRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmStartResponse](./SlmStartResponse.md), unknown>>;  
start start(this: [That](./That.md), params?: [SlmStartRequest](./SlmStartRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmStartResponse](./SlmStartResponse.md)>;  
stop stop(this: [That](./That.md), params?: [SlmStopRequest](./SlmStopRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmStopResponse](./SlmStopResponse.md)>; Stop snapshot lifecycle management. Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. Stopping SLM does not stop any snapshots that are in progress. You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped. The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. Use the get snapshot lifecycle management status API to see if SLM is running.
stop stop(this: [That](./That.md), params?: [SlmStopRequest](./SlmStopRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmStopResponse](./SlmStopResponse.md), unknown>>;  
stop stop(this: [That](./That.md), params?: [SlmStopRequest](./SlmStopRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmStopResponse](./SlmStopResponse.md)>;