Sha256: 61e2cae160459c22e93e4efc34a392d7bcf511554870c250dc5640d88ad04f82

Contents?: true

Size: 1.77 KB

Versions: 5

Compression:

Stored size: 1.77 KB

Contents

# frozen_string_literal: true

# 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 Elastic
  module EnterpriseSearch
    module AppSearch
      module Actions
        # Engines - Retrieve all engines
        # Retrieves all engines with optional pagination support
        #
        # @param arguments [Hash] endpoint arguments
        # @option arguments [Integer] :current_page The page to fetch. Defaults to 1
        # @option arguments [Integer] :page_size The number of results per page
        # @option arguments [Hash] :body The request body
        # @option arguments [Hash] :headers optional HTTP headers to send with the request
        #
        # @see https://www.elastic.co/guide/en/app-search/current/engines.html#engines-list
        #
        def list_engines(arguments = {})
          body = arguments.delete(:body) || {}
          headers = arguments.delete(:headers) || {}

          request(
            :get,
            'api/as/v1/engines/',
            arguments,
            body,
            headers
          )
        end
      end
    end
  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version Path
elastic-enterprise-search-7.17.1 lib/elastic/app-search/api/list_engines.rb
elastic-enterprise-search-7.17.0 lib/elastic/app-search/api/list_engines.rb
elastic-enterprise-search-7.16.0 lib/elastic/app-search/api/list_engines.rb
elastic-enterprise-search-7.15.1 lib/elastic/app-search/api/list_engines.rb
elastic-enterprise-search-7.15.0 lib/elastic/app-search/api/list_engines.rb