/* 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.
*/

using OpenSearch.Net;

namespace OpenSearch.Client
{
	/// <summary>
	/// May be applied to helper requests where they may be called by an upstream helper.
	/// </summary>
	/// <remarks>
	/// For example, the reindex helper calls down into the bulk helper and scroll helpers.
	/// <see cref="BulkAllRequest{T}"/> and <see cref="ScrollAllRequest"/> therefore both
	/// implement this interface.
	/// </remarks>
	internal interface IHelperCallable
	{
		/// <summary>
		/// The <see cref="RequestMetaData"/> of the parent helper when this requestis created by a parent
		/// helper.
		/// </summary>
		RequestMetaData ParentMetaData { get; internal set; }
	}
}