Namespace: API-PIT

API-PIT

Source:

Methods

(static) createPitApi(params, optionsopt, callbackopt) → {Object|Promise.<never>|*}

Creates a point in time.
See Also: Opensearch - Create a PIT
Parameters:
Name Type Attributes Description
params Object
Properties
Name Type Attributes Default Description
index string The name(s) of the target index(es) for the PIT. May contain a comma-separated list or a wildcard index pattern.
keep_alive string The amount of time to keep the PIT
preference string <optional>
 random The node or the shard used to perform the search.
routing string <optional>
 Specifies to route search requests to a specific shard.
expand_wildcards string <optional>
 open The type of index that can match the wildcard pattern. Supports comma-separated values.
allow_partial_pit_creation string <optional>
 false Specifies whether to create a PIT with partial failures.
options Object <optional>
 Options for Transport#request
callback function <optional>
 Callback that handles errors and response
Source:
Returns:
Create PIT Response
Type
Object | Promise.<never> | *

(static) deleteAllPitsApi(params, optionsopt, callbackopt) → {Object|Promise.<never>|*}

Deletes all PITs in the OpenSearch cluster. The Delete All PITs API deletes only local PITs or mixed PITs (PITs created in both local and remote clusters). It does not delete fully remote PITs.
See Also: Opensearch - Delete PITs
Parameters:
Name Type Attributes Description
params Object
options Object <optional>
 Options for Transport#request
callback function <optional>
 Callback that handles errors and response
Source:
Returns:
Delete all PITs Response
Type
Object | Promise.<never> | *

(static) deletePitApi(params, optionsopt, callbackopt) → {Object|Promise.<never>|*}

Deletes one or several PITs. PITs are automatically deleted when the keep_alive time period elapses. However, to deallocate resources, you can delete a PIT using the Delete PIT API.
See Also: Opensearch - Delete PITs
Parameters:
Name Type Attributes Description
params Object
Properties
Name Type Description
body Object
Properties
Name Type Description
pit_id Array.<string> The PIT IDs of the PITs to be deleted.
options Object <optional>
 Options for Transport#request
callback function <optional>
 Callback that handles errors and response
Source:
Returns:
Delete PIT Response
Type
Object | Promise.<never> | *

(static) getAllPitsApi(params, optionsopt, callbackopt) → {Object|Promise.<never>|*}

Returns all PITs in the OpenSearch cluster.
See Also: Opensearch - List all PITs
Parameters:
Name Type Attributes Description
params Object
options Object <optional>
 Options for Transport#request
callback function <optional>
 Callback that handles errors and response
Source:
Returns:
List all PITs Response
Type
Object | Promise.<never> | *