opensearch-ruby 2.0.3 → 3.4.0

data/lib/opensearch/dsl/search/aggregations/percentiles.rb

@@ -0,0 +1,57 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Aggregations
+        # A multi-value metrics aggregation which calculates percentiles on numeric values
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :load_time_outliers do
+        #         percentiles do
+        #           field 'load_time'
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/search-aggregations-metrics-percentile-aggregation.html
+        #
+        class Percentiles
+          include BaseComponent
+
+          option_method :field
+          option_method :percents
+          option_method :script
+          option_method :params
+          option_method :compression
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/pipeline/avg_bucket.rb

@@ -0,0 +1,58 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Aggregations
+        # A sibling pipeline aggregation which calculates the (mean) average value of a specified metric in a sibling aggregation.
+        #
+        # @example Passing the options as a Hash
+        #
+        #     aggregation :avg_monthly_sales do
+        #       avg_bucket buckets_path: 'sales_per_month>sales'
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     aggregation :avg_monthly_sales do
+        #       avg_bucket do
+        #         buckets_path 'sales_per_month>sales'
+        #       end
+        #     end
+        #
+        #
+        class AvgBucket
+          include BaseAggregationComponent
+
+          option_method :buckets_path
+          option_method :gap_policy
+          option_method :format
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/pipeline/bucket_script.rb

@@ -0,0 +1,60 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Aggregations
+        # A parent pipeline aggregation which executes a script which can perform per bucket computations on specified metrics in the parent multi-bucket aggregation.
+        #
+        # @example Passing the options as a Hash
+        #
+        #     aggregation :t-shirt-percentage do
+        #       bucket_script buckets_path: { tShirtSales: 't-shirts>sales', totalSales: 'total_sales' }, script: 'tShirtSales / totalSales * 100'
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     aggregation :t-shirt-percentage do
+        #       bucket_script do
+        #         buckets_path tShirtSales: 't-shirts>sales', totalSales: 'total_sales'
+        #         script 'tShirtSales / totalSales * 100'
+        #       end
+        #     end
+        #
+        #
+        class BucketScript
+          include BaseAggregationComponent
+
+          option_method :buckets_path
+          option_method :script
+          option_method :gap_policy
+          option_method :format
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/pipeline/bucket_selector.rb

@@ -0,0 +1,59 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Aggregations
+        # A parent pipeline aggregation which executes a script which determines whether the current bucket will be retained in the parent multi-bucket aggregation.
+        #
+        # @example Passing the options as a Hash
+        #
+        #     aggregation :sales_bucket_filter do
+        #       bucket_selector buckets_path: { totalSales: 'total_sales' }, script: 'totalSales <= 50'
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     aggregation :sales_bucket_filter do
+        #       bucket_selector do
+        #         buckets_path totalSales: 'total_sales'
+        #         script 'totalSales <= 50'
+        #       end
+        #     end
+        #
+        #
+        class BucketSelector
+          include BaseAggregationComponent
+
+          option_method :buckets_path
+          option_method :script
+          option_method :gap_policy
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/pipeline/bucket_sort.rb

@@ -0,0 +1,111 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Aggregations
+        # A parent pipeline aggregation which sorts the buckets of its parent multi-bucket aggregation.
+        #
+        # @example Passing the options as a Hash
+        #
+        #     aggregation :sales_bucket_filter do
+        #       bucket_sort gap_policy: 'insert_zero'
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     aggregation :sales_bucket_sort do
+        #       bucket_sort do
+        #         sort do
+        #           by :total_sales, order: 'desc'
+        #         end
+        #         size 3
+        #       end
+        #     end
+        #
+        #
+        class BucketSort
+          include BaseAggregationComponent
+
+          # Add a sort clause to the search definition.
+          #
+          # @example
+          #
+          #   bucket_sort do
+          #     sort do
+          #       by :total_sales, order: 'desc'
+          #     end
+          #   end
+          #
+          # @return [ Sort, Hash ] The sort definition.
+          #
+          # @since 0.1.9
+          def sort(*args, &block)
+            if !args.empty? || block
+              @sort = Sort.new(*args, &block)
+              self
+            else
+              @sort
+            end
+          end
+
+          # Get a hash representation of the aggregation.
+          #
+          # @example
+          #
+          #   s = search do
+          #     aggregation do
+          #       bucket_sort do
+          #         sort do
+          #           by :total_sales, order: 'desc'
+          #         end
+          #       end
+          #     end
+          #   end
+          #
+          # client.search(body: s.to_hash)
+          #
+          # @return [ Hash ] The hash representation of the aggregation.
+          #
+          # @since 0.1.9
+          def to_hash
+            call
+
+            @hash[:aggregations] = @aggregations.to_hash if @aggregations
+
+            @hash[name].merge!(sort: @sort.to_hash) if @sort
+            @hash
+          end
+
+          option_method :from
+          option_method :size
+          option_method :gap_policy
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/pipeline/cumulative_sum.rb

@@ -0,0 +1,57 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Aggregations
+        # A parent pipeline aggregation which calculates the cumulative sum of a specified metric in a parent histogram (or date_histogram) aggregation.
+        #
+        # @example Passing the options as a Hash
+        #
+        #     aggregation :cumulative_sales do
+        #       cumulative_sum buckets_path: 'sales'
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     aggregation :cumulative_sales do
+        #       cumulative_sum do
+        #         buckets_path 'sales'
+        #       end
+        #     end
+        #
+        #
+        class CumulativeSum
+          include BaseAggregationComponent
+
+          option_method :buckets_path
+          option_method :format
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/pipeline/derivative.rb

@@ -0,0 +1,58 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Aggregations
+        # A parent pipeline aggregation which calculates the derivative of a specified metric in a parent histogram (or date_histogram) aggregation.
+        #
+        # @example Passing the options as a Hash
+        #
+        #     aggregation :sales_deriv do
+        #       derivative buckets_path: 'sales'
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     aggregation :sales_deriv do
+        #       derivative do
+        #         buckets_path 'sales'
+        #       end
+        #     end
+        #
+        #
+        class Derivative
+          include BaseAggregationComponent
+
+          option_method :buckets_path
+          option_method :gap_policy
+          option_method :format
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/pipeline/extended_stats_bucket.rb

@@ -0,0 +1,58 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Aggregations
+        # A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation. The specified metric must be numeric and the sibling aggregation must be a multi-bucket aggregation.
+        #
+        # @example Passing the options as a Hash
+        #
+        #     aggregation :stats_monthly_sales do
+        #       extended_stats_bucket buckets_path: 'sales_per_month>sales'
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     aggregation :stats_monthly_sales do
+        #       extended_stats_bucket do
+        #         buckets_path 'sales_per_month>sales'
+        #       end
+        #     end
+        #
+        #
+        class ExtendedStatsBucket
+          include BaseAggregationComponent
+
+          option_method :buckets_path
+          option_method :gap_policy
+          option_method :format
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/pipeline/max_bucket.rb

@@ -0,0 +1,58 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Aggregations
+        # A sibling pipeline aggregation which identifies the bucket(s) with the maximum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s).
+        #
+        # @example Passing the options as a Hash
+        #
+        #     aggregation :max_monthly_sales do
+        #       max_bucket buckets_path: 'sales_per_month>sales'
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     aggregation :max_monthly_sales do
+        #       max_bucket do
+        #         buckets_path 'sales_per_month>sales'
+        #       end
+        #     end
+        #
+        #
+        class MaxBucket
+          include BaseAggregationComponent
+
+          option_method :buckets_path
+          option_method :gap_policy
+          option_method :format
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/pipeline/min_bucket.rb

@@ -0,0 +1,58 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Aggregations
+        # A sibling pipeline aggregation which identifies the bucket(s) with the minimum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s).
+        #
+        # @example Passing the options as a Hash
+        #
+        #     aggregation :min_monthly_sales do
+        #       min_bucket buckets_path: 'sales_per_month>sales'
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     aggregation :min_monthly_sales do
+        #       min_bucket do
+        #         buckets_path 'sales_per_month>sales'
+        #       end
+        #     end
+        #
+        #
+        class MinBucket
+          include BaseAggregationComponent
+
+          option_method :buckets_path
+          option_method :gap_policy
+          option_method :format
+        end
+      end
+    end
+  end
+end