Skip to content

Commit 49eccfb

Browse files
Auto-generated code for main (#1993)
1 parent f72d146 commit 49eccfb

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

docs/reference.asciidoc

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6923,7 +6923,7 @@ client.rollup.deleteJob({ id })
69236923
==== Arguments
69246924

69256925
* *Request (object):*
6926-
** *`id` (string)*: The ID of the job to delete
6926+
** *`id` (string)*: Identifier for the job.
69276927

69286928
[discrete]
69296929
==== get_jobs
@@ -6939,7 +6939,8 @@ client.rollup.getJobs({ ... })
69396939
==== Arguments
69406940

69416941
* *Request (object):*
6942-
** *`id` (Optional, string)*: The ID of the job(s) to fetch. Accepts glob patterns, or left blank for all jobs
6942+
** *`id` (Optional, string)*: Identifier for the rollup job.
6943+
If it is `_all` or omitted, the API returns all rollup jobs.
69436944

69446945
[discrete]
69456946
==== get_rollup_caps
@@ -6955,7 +6956,8 @@ client.rollup.getRollupCaps({ ... })
69556956
==== Arguments
69566957

69576958
* *Request (object):*
6958-
** *`id` (Optional, string)*: The ID of the index to check rollup capabilities on, or left blank for all jobs
6959+
** *`id` (Optional, string)*: Index, indices or index-pattern to return rollup capabilities for.
6960+
`_all` may be used to fetch rollup capabilities from all jobs.
69596961

69606962
[discrete]
69616963
==== get_rollup_index_caps
@@ -6971,7 +6973,8 @@ client.rollup.getRollupIndexCaps({ index })
69716973
==== Arguments
69726974

69736975
* *Request (object):*
6974-
** *`index` (string | string[])*: The rollup index or index pattern to obtain rollup capabilities from.
6976+
** *`index` (string | string[])*: Data stream or index to check for rollup capabilities.
6977+
Wildcard (`*`) expressions are supported.
69756978

69766979
[discrete]
69776980
==== put_job
@@ -7028,10 +7031,10 @@ client.rollup.rollupSearch({ index })
70287031
==== Arguments
70297032

70307033
* *Request (object):*
7031-
** *`index` (string | string[])*: The indices or index-pattern(s) (containing rollup or regular data) that should be searched
7032-
** *`aggregations` (Optional, Record<string, { aggregations, meta, adjacency_matrix, auto_date_histogram, avg, avg_bucket, boxplot, bucket_script, bucket_selector, bucket_sort, bucket_count_ks_test, bucket_correlation, cardinality, categorize_text, children, composite, cumulative_cardinality, cumulative_sum, date_histogram, date_range, derivative, diversified_sampler, extended_stats, extended_stats_bucket, frequent_item_sets, filter, filters, geo_bounds, geo_centroid, geo_distance, geohash_grid, geo_line, geotile_grid, geohex_grid, global, histogram, ip_range, ip_prefix, inference, line, matrix_stats, max, max_bucket, median_absolute_deviation, min, min_bucket, missing, moving_avg, moving_percentiles, moving_fn, multi_terms, nested, normalize, parent, percentile_ranks, percentiles, percentiles_bucket, range, rare_terms, rate, reverse_nested, sampler, scripted_metric, serial_diff, significant_terms, significant_text, stats, stats_bucket, string_stats, sum, sum_bucket, terms, top_hits, t_test, top_metrics, value_count, weighted_avg, variable_width_histogram }>)*
7033-
** *`query` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule_query, script, script_score, shape, simple_query_string, span_containing, field_masking_span, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, wildcard, wrapper, type })*
7034-
** *`size` (Optional, number)*: Must be zero if set, as rollups work on pre-aggregated data
7034+
** *`index` (string | string[])*: Enables searching rolled-up data using the standard Query DSL.
7035+
** *`aggregations` (Optional, Record<string, { aggregations, meta, adjacency_matrix, auto_date_histogram, avg, avg_bucket, boxplot, bucket_script, bucket_selector, bucket_sort, bucket_count_ks_test, bucket_correlation, cardinality, categorize_text, children, composite, cumulative_cardinality, cumulative_sum, date_histogram, date_range, derivative, diversified_sampler, extended_stats, extended_stats_bucket, frequent_item_sets, filter, filters, geo_bounds, geo_centroid, geo_distance, geohash_grid, geo_line, geotile_grid, geohex_grid, global, histogram, ip_range, ip_prefix, inference, line, matrix_stats, max, max_bucket, median_absolute_deviation, min, min_bucket, missing, moving_avg, moving_percentiles, moving_fn, multi_terms, nested, normalize, parent, percentile_ranks, percentiles, percentiles_bucket, range, rare_terms, rate, reverse_nested, sampler, scripted_metric, serial_diff, significant_terms, significant_text, stats, stats_bucket, string_stats, sum, sum_bucket, terms, top_hits, t_test, top_metrics, value_count, weighted_avg, variable_width_histogram }>)*: Specifies aggregations.
7036+
** *`query` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule_query, script, script_score, shape, simple_query_string, span_containing, field_masking_span, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, wildcard, wrapper, type })*: Specifies a DSL query.
7037+
** *`size` (Optional, number)*: Must be zero if set, as rollups work on pre-aggregated data.
70357038
** *`rest_total_hits_as_int` (Optional, boolean)*: Indicates whether hits.total should be rendered as an integer or an object in the rest search response
70367039
** *`typed_keys` (Optional, boolean)*: Specify whether aggregation and suggester names should be prefixed by their respective types in the response
70377040

@@ -7049,7 +7052,7 @@ client.rollup.startJob({ id })
70497052
==== Arguments
70507053

70517054
* *Request (object):*
7052-
** *`id` (string)*: The ID of the job to start
7055+
** *`id` (string)*: Identifier for the rollup job.
70537056

70547057
[discrete]
70557058
==== stop_job
@@ -7065,9 +7068,11 @@ client.rollup.stopJob({ id })
70657068
==== Arguments
70667069

70677070
* *Request (object):*
7068-
** *`id` (string)*: The ID of the job to stop
7069-
** *`timeout` (Optional, string | -1 | 0)*: Block for (at maximum) the specified duration while waiting for the job to stop. Defaults to 30s.
7070-
** *`wait_for_completion` (Optional, boolean)*: True if the API should block until the job has fully stopped, false if should be executed async. Defaults to false.
7071+
** *`id` (string)*: Identifier for the rollup job.
7072+
** *`timeout` (Optional, string | -1 | 0)*: If `wait_for_completion` is `true`, the API blocks for (at maximum) the specified duration while waiting for the job to stop.
7073+
If more than `timeout` time has passed, the API throws a timeout exception.
7074+
** *`wait_for_completion` (Optional, boolean)*: If set to `true`, causes the API to block until the indexer state completely stops.
7075+
If set to `false`, the API returns immediately and the indexer is stopped asynchronously in the background.
70717076

70727077
[discrete]
70737078
=== search_application

0 commit comments

Comments
 (0)