Class OpenSearch\Namespaces\SnapshotNamespace

Removes stale data from repository.

$params['repository'] = (string) Snapshot repository to clean up. $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. $params['master_timeout'] = (string) Period to wait for a connection to the master node. $params['timeout'] = (string) Period to wait for a response. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".

Clones indexes from one snapshot into another snapshot in the same repository.

$params['repository'] = (string) A repository name $params['snapshot'] = (string) The name of the snapshot to clone from $params['target_snapshot'] = (string) The name of the cloned snapshot to create $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. $params['master_timeout'] = (string) Explicit operation timeout for connection to master node $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". $params['body'] = (array) The snapshot clone definition (Required)

Creates a snapshot in a repository.

$params['repository'] = (string) Repository for the snapshot. $params['snapshot'] = (string) Name of the snapshot. Must be unique in the repository. $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. $params['master_timeout'] = (string) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. $params['wait_for_completion'] = (boolean) If true, the request returns a response when the snapshot is complete. If false, the request returns a response when the snapshot initializes. (Default = false) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". $params['body'] = (array) The snapshot definition

Creates a repository.

$params['repository'] = (string) A repository name $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. $params['master_timeout'] = (string) Explicit operation timeout for connection to master node $params['timeout'] = (string) Explicit operation timeout $params['verify'] = (boolean) Whether to verify the repository after creation $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". $params['body'] = (array) The repository definition (Required)

Deletes a snapshot.

$params['repository'] = (string) A repository name $params['snapshot'] = (string) A comma-separated list of snapshot names $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. $params['master_timeout'] = (string) Explicit operation timeout for connection to master node $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".

Deletes a repository.

$params['repository'] = (array) Name of the snapshot repository to unregister. Wildcard (*) patterns are supported. $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. $params['master_timeout'] = (string) Explicit operation timeout for connection to master node $params['timeout'] = (string) Explicit operation timeout $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".

Returns information about a snapshot.

$params['repository'] = (string) Comma-separated list of snapshot repository names used to limit the request. Wildcard () expressions are supported. $params['snapshot'] = (array) Comma-separated list of snapshot names to retrieve. Also accepts wildcards (). - To get information about all snapshots in a registered repository, use a wildcard (*) or _all. - To get information about any snapshots that are currently running, use _current. $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. $params['ignore_unavailable'] = (boolean) If false, the request returns an error for any snapshots that are unavailable. (Default = false) $params['master_timeout'] = (string) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. $params['verbose'] = (boolean) If true, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".

Returns information about a repository.

$params['repository'] = (array) A comma-separated list of repository names $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) $params['master_timeout'] = (string) Explicit operation timeout for connection to master node $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".

Restores a snapshot.

$params['repository'] = (string) A repository name $params['snapshot'] = (string) A snapshot name $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. $params['master_timeout'] = (string) Explicit operation timeout for connection to master node $params['wait_for_completion'] = (boolean) Should this request wait until the operation has completed before returning (Default = false) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". $params['body'] = (array) Details of what to restore

Returns information about the status of a snapshot.

$params['repository'] = (string) A repository name $params['snapshot'] = (array) A comma-separated list of snapshot names $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. $params['ignore_unavailable'] = (boolean) Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown (Default = false) $params['master_timeout'] = (string) Explicit operation timeout for connection to master node $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".

Verifies a repository.

$params['repository'] = (string) A repository name $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. $params['master_timeout'] = (string) Explicit operation timeout for connection to master node $params['timeout'] = (string) Explicit operation timeout $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".