1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
package Search::Elasticsearch::Client::8_0::Direct::Rollup;
$Search::Elasticsearch::Client::8_0::Direct::Rollup::VERSION = '8.12';
use Moo;
with 'Search::Elasticsearch::Client::8_0::Role::API';
with 'Search::Elasticsearch::Role::Client::Direct';
use namespace::clean;
__PACKAGE__->_install_api('rollup');
1;
=pod
=encoding UTF-8
=head1 NAME
Search::Elasticsearch::Client::8_0::Direct::Rollup - Plugin providing Rollups for Search::Elasticsearch 8.x
=head1 VERSION
version 8.12
=head1 SYNOPSIS
my $response = $es->rollup->search( body => {...} )
=head2 DESCRIPTION
This class extends the L<Search::Elasticsearch> client with a C<rollup>
namespace, to support the
L<Rollup APIs|https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-apis.html>.
The full documentation for the Rollups feature is available here:
L<https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-rollup.html>
=head1 GENERAL METHODS
=head2 C<search()>
$response = $es->rollup->search(
index => $index | \@indices, # optional
body => {...} # optional
)
The C<search()> method executes a normal search but can join the results from ordinary indices with
those from rolled up indices.
Query string parameters:
C<error_trace>,
C<filter_path>,
C<human>,
C<typed_keys>
See the L<rollup search docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-search.html>
for more information.
=head1 JOB METHODS
=head2 C<put_job()>
$response = $es->rollup->put_job(
id => $id, # required
body => {...} # optional
)
The C<put_job()> method creates a rollup job which will rollup matching indices to a rolled up index
in the background.
Query string parameters:
C<error_trace>,
C<filter_path>,
C<human>
See the L<rollup create job docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-put-job.html>
for more information.
=head2 C<delete_job()>
$response = $es->rollup->delete_job(
id => $id, # required
)
The C<delete_job()> method deletes a rollup job by ID.
Query string parameters:
C<error_trace>,
C<filter_path>,
C<human>
See the L<rollup delete job docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-delete-job.html>
for more information.
=head2 C<get_jobs()>
$response = $es->rollup->get_jobs(
id => $id, # optional
)
The C<get_job()> method retrieves a rollup job by ID, or all jobs if not specified.
Query string parameters:
C<error_trace>,
C<filter_path>,
C<human>
See the L<rollup get jobs docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-get-job.html>
for more information.
=head2 C<start_job()>
$response = $es->rollup->start_job(
id => $id, # required
)
The C<start_job()> method starts the specified rollup job.
Query string parameters:
C<error_trace>,
C<filter_path>,
C<human>
See the L<rollup start job docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-start-job.html>
for more information.
=head2 C<stop_job()>
$response = $es->rollup->stop_job(
id => $id, # required
)
The C<stop_job()> method stops the specified rollup job.
Query string parameters:
C<error_trace>,
C<filter_path>,
C<human>
See the L<rollup stop job docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-stop-job.html>
for more information.
=head1 DATA METHODS
=head2 C<get_rollup_caps()>
$response = $es->rollup->get_rollup_caps(
id => $index # optional
)
The C<get_rollup_caps()> method returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.
Query string parameters:
C<error_trace>,
C<filter_path>,
C<human>
See the L<get rollup caps docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-get-rollup-caps.html>
for more information.
=head2 C<get_rollup_index_caps()>
$response = $es->rollup->get_rollup_index_caps(
id => $index # optional
)
The C<get_rollup_index_caps()> method returns the rollup capabilities of all jobs inside of a rollup index.
Query string parameters:
C<error_trace>,
C<filter_path>,
C<human>
See the L<get rollup index caps docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-get-rollup-index-caps.html>
for more information.
=head1 AUTHOR
Enrico Zimuel <enrico.zimuel@elastic.co>
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2024 by Elasticsearch BV.
This is free software, licensed under:
The Apache License, Version 2.0, January 2004
=cut
__END__
# ABSTRACT: Plugin providing Rollups for Search::Elasticsearch 8.x
|
