| Methods |
public
|
delete(array $params = []): array
Delete index rollup.
Delete index rollup.
$params['id'] = (string) Rollup to access (Required)
$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 "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
explain(array $params = []): array
Get a rollup's current status.
Get a rollup's current status.
$params['id'] = (string) Rollup to access (Required)
$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 "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
get(array $params = []): array
Get an index rollup.
Get an index rollup.
$params['id'] = (string) Rollup to access (Required)
$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 "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
put(array $params = []): array
Create or update index rollup.
Create or update index rollup.
$params['id'] = (string) Rollup to access (Required)
$params['if_primary_term'] = (number) Only perform the operation if the document has this primary term.
$params['if_seq_no'] = (integer) Only perform the operation if the document has this sequence number.
$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 "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
start(array $params = []): array
Start rollup.
Start rollup.
$params['id'] = (string) Rollup to access (Required)
$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 "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
stop(array $params = []): array
Stop rollup.
Stop rollup.
$params['id'] = (string) Rollup to access (Required)
$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 "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|