Sha256: 4954ab307f3e69375f098cdcba8e7d6963cba69ef6b7b8ec23fea51a6ebd5ab2
Contents?: true
Size: 1.89 KB
Versions: 10
Compression:
Stored size: 1.89 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
# Documents - Retrieve one or more documents
# Retrieves one or more documents by id
#
# @param [String] engine_name Name of the engine (*Required*)
# @param [Hash] arguments endpoint arguments
# @option arguments [Array] :ids[] List of Document IDs to fetch
# @option arguments [Array<String>] :document_ids
# @option arguments [Hash] :headers optional HTTP headers to send with the request
#
# @see https://www.elastic.co/guide/en/app-search/current/documents.html#documents-get
#
def documents(engine_name, arguments = {})
raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
document_ids = arguments.delete(:document_ids) || {}
headers = arguments.delete(:headers) || {}
request(
:get,
"api/as/v1/engines/#{engine_name}/documents/",
arguments,
document_ids,
headers
)
end
end
end
end
end
Version data entries
10 entries across 10 versions & 1 rubygems