extends |
AbstractNamespace |
|---|
Class SmNamespace
NOTE: This file is autogenerated using util/GenerateEndpoints.php
| Methods | ||||
|---|---|---|---|---|
public
|
createPolicy(array $params = []): array
Creates a snapshot management policy.
Creates a snapshot management policy. $params['policy_name'] = (string) The name of the snapshot management policy to create.
$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 = false)
$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) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
deletePolicy(array $params = []): array
Deletes a snapshot management policy.
Deletes a snapshot management policy. $params['policy_name'] = (string) The name of the snapshot management policy to delete.
$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 = false)
$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) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
explainPolicy(array $params = []): array
Explains the state of the snapshot management policy.
Explains the state of the snapshot management policy. $params['policy_name'] = (string) The name of the snapshot management policy to explain.
$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 = false)
$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) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
getPolicies(array $params = []): array
Retrieves all snapshot management policies with optional pagination and filtering.
Retrieves all snapshot management policies with optional pagination and filtering. $params['from'] = (integer) The starting index from which to retrieve snapshot management policies. (Default = 0)
$params['queryString'] = (string) The query string to filter the returned snapshot management policies.
$params['size'] = (integer) The number of snapshot management policies to return.
$params['sortField'] = (string) The name of the field to sort the snapshot management policies by.
$params['sortOrder'] = (enum) The order to sort the snapshot management policies. (Options = asc,desc)
$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 = false)
$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) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
getPolicy(array $params = []): array
Retrieves a specific snapshot management policy by name.
Retrieves a specific snapshot management policy by name. $params['policy_name'] = (string) The name of the snapshot management policy to retrieve.
$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 = false)
$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) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
startPolicy(array $params = []): array
Starts a snapshot management policy.
Starts a snapshot management policy. $params['policy_name'] = (string) The name of the snapshot management policy to start.
$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 = false)
$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) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
stopPolicy(array $params = []): array
Stops a snapshot management policy.
Stops a snapshot management policy. $params['policy_name'] = (string) The name of the snapshot management policy to stop.
$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 = false)
$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) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
updatePolicy(array $params = []): array
Updates an existing snapshot management policy. Requires `if_seq_no` and `if_primary_term`.
Updates an existing snapshot management policy. Requires $params['policy_name'] = (string) The name of the snapshot management policy to update.
$params['if_primary_term'] = (integer) The primary term of the policy to update.
$params['if_seq_no'] = (integer) The sequence number of the policy to update.
$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 = false)
$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) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
| Methods inherited from OpenSearch\Namespaces\AbstractNamespace |
|---|
__construct(), extractArgument(), performRequest() |
| Properties inherited from OpenSearch\Namespaces\AbstractNamespace |
|---|
$transport, $httpTransport, $endpointFactory, $endpoints |