1 2 3[[Elasticsearch_Namespaces_RollupNamespace]] 4=== Elasticsearch\Namespaces\RollupNamespace 5 6 7 8Class RollupNamespace 9 10*Description* 11 12 13NOTE: this file is autogenerated using util/GenerateEndpoints.php 14and Elasticsearch 7.12.1 (3186837139b9c6b6d23c3200870651f10d3343b7) 15 16 17*Methods* 18 19The class defines the following methods: 20 21* <<Elasticsearch_Namespaces_RollupNamespacedeleteJob_deleteJob,`deleteJob()`>> 22* <<Elasticsearch_Namespaces_RollupNamespacegetJobs_getJobs,`getJobs()`>> 23* <<Elasticsearch_Namespaces_RollupNamespacegetRollupCaps_getRollupCaps,`getRollupCaps()`>> 24* <<Elasticsearch_Namespaces_RollupNamespacegetRollupIndexCaps_getRollupIndexCaps,`getRollupIndexCaps()`>> 25* <<Elasticsearch_Namespaces_RollupNamespaceputJob_putJob,`putJob()`>> 26* <<Elasticsearch_Namespaces_RollupNamespacerollup_rollup,`rollup()`>> 27* <<Elasticsearch_Namespaces_RollupNamespacerollupSearch_rollupSearch,`rollupSearch()`>> 28* <<Elasticsearch_Namespaces_RollupNamespacestartJob_startJob,`startJob()`>> 29* <<Elasticsearch_Namespaces_RollupNamespacestopJob_stopJob,`stopJob()`>> 30 31 32 33[[Elasticsearch_Namespaces_RollupNamespacedeleteJob_deleteJob]] 34.`deleteJob(array $params = [])` 35*NOTE:* This API is EXPERIMENTAL and may be changed or removed completely in a future release 36**** 37[source,php] 38---- 39/* 40$params['id'] = (string) The ID of the job to delete 41*/ 42---- 43**** 44 45 46 47[[Elasticsearch_Namespaces_RollupNamespacegetJobs_getJobs]] 48.`getJobs(array $params = [])` 49*NOTE:* This API is EXPERIMENTAL and may be changed or removed completely in a future release 50**** 51[source,php] 52---- 53/* 54$params['id'] = (string) The ID of the job(s) to fetch. Accepts glob patterns, or left blank for all jobs 55*/ 56---- 57**** 58 59 60 61[[Elasticsearch_Namespaces_RollupNamespacegetRollupCaps_getRollupCaps]] 62.`getRollupCaps(array $params = [])` 63*NOTE:* This API is EXPERIMENTAL and may be changed or removed completely in a future release 64**** 65[source,php] 66---- 67/* 68$params['id'] = (string) The ID of the index to check rollup capabilities on, or left blank for all jobs 69*/ 70---- 71**** 72 73 74 75[[Elasticsearch_Namespaces_RollupNamespacegetRollupIndexCaps_getRollupIndexCaps]] 76.`getRollupIndexCaps(array $params = [])` 77*NOTE:* This API is EXPERIMENTAL and may be changed or removed completely in a future release 78**** 79[source,php] 80---- 81/* 82$params['index'] = (string) The rollup index or index pattern to obtain rollup capabilities from. 83*/ 84---- 85**** 86 87 88 89[[Elasticsearch_Namespaces_RollupNamespaceputJob_putJob]] 90.`putJob(array $params = [])` 91*NOTE:* This API is EXPERIMENTAL and may be changed or removed completely in a future release 92**** 93[source,php] 94---- 95/* 96$params['id'] = (string) The ID of the job to create 97$params['body'] = (array) The job configuration (Required) 98*/ 99---- 100**** 101 102 103 104[[Elasticsearch_Namespaces_RollupNamespacerollup_rollup]] 105.`rollup(array $params = [])` 106**** 107[source,php] 108---- 109/* 110$params['index'] = (string) The index to roll up 111$params['rollup_index'] = (string) The name of the rollup index to create 112$params['body'] = (array) The rollup configuration (Required) 113*/ 114---- 115**** 116 117 118 119[[Elasticsearch_Namespaces_RollupNamespacerollupSearch_rollupSearch]] 120.`rollupSearch(array $params = [])` 121*NOTE:* This API is EXPERIMENTAL and may be changed or removed completely in a future release 122**** 123[source,php] 124---- 125/* 126$params['index'] = (list) The indices or index-pattern(s) (containing rollup or regular data) that should be searched (Required) 127$params['type'] = DEPRECATED (string) The doc type inside the index 128$params['typed_keys'] = (boolean) Specify whether aggregation and suggester names should be prefixed by their respective types in the response 129$params['rest_total_hits_as_int'] = (boolean) Indicates whether hits.total should be rendered as an integer or an object in the rest search response (Default = false) 130$params['body'] = (array) The search request body (Required) 131*/ 132---- 133**** 134 135 136 137[[Elasticsearch_Namespaces_RollupNamespacestartJob_startJob]] 138.`startJob(array $params = [])` 139*NOTE:* This API is EXPERIMENTAL and may be changed or removed completely in a future release 140**** 141[source,php] 142---- 143/* 144$params['id'] = (string) The ID of the job to start 145*/ 146---- 147**** 148 149 150 151[[Elasticsearch_Namespaces_RollupNamespacestopJob_stopJob]] 152.`stopJob(array $params = [])` 153*NOTE:* This API is EXPERIMENTAL and may be changed or removed completely in a future release 154**** 155[source,php] 156---- 157/* 158$params['id'] = (string) The ID of the job to stop 159$params['wait_for_completion'] = (boolean) True if the API should block until the job has fully stopped, false if should be executed async. Defaults to false. 160*/ 161---- 162**** 163 164 165