| Methods |
public
|
delete(array $params = []): array
Deletes an index rollup job configuration.
Deletes an index rollup job configuration.
$params['id'] = (string) The ID of the rollup job. (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 = 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
| $params |
Associative array of parameters
|
|
#
|
public
|
explain(array $params = []): array
Retrieves the execution status information for an index rollup job.
Retrieves the execution status information for an index rollup job.
$params['id'] = (string) The ID of the rollup job. (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 = 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
| $params |
Associative array of parameters
|
|
#
|
public
|
get(array $params = []): array
Retrieves an index rollup job configuration by ID.
Retrieves an index rollup job configuration by ID.
$params['id'] = (string) The ID of the rollup job. (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 = 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
| $params |
Associative array of parameters
|
|
#
|
public
|
put(array $params = []): array
Creates or updates an index rollup job configuration.
Creates or updates an index rollup job configuration.
$params['id'] = (string) The ID of the rollup job. (Required)
$params['if_primary_term'] = (number) Only performs the operation if the document has the specified primary term.
$params['if_seq_no'] = (integer) Only performs the operation if the document has the specified 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 = 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
| $params |
Associative array of parameters
|
|
#
|
public
|
start(array $params = []): array
Starts the execution of an index rollup job.
Starts the execution of an index rollup job.
$params['id'] = (string) The ID of the rollup job. (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 = 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
| $params |
Associative array of parameters
|
|
#
|
public
|
stop(array $params = []): array
Stops the execution of an index rollup job.
Stops the execution of an index rollup job.
$params['id'] = (string) The ID of the rollup job. (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 = 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
| $params |
Associative array of parameters
|
|
#
|