/* 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.
*/
namespace OpenSearch.Client.Specification.IndicesApi
{
public interface IMergeSchedulerSettings
{
///
/// If this is true (the default), then the merge scheduler will rate-limit IO (writes) for merges to an
/// adaptive value depending on how many merges are requested over time. An application with a low indexing rate
/// that unluckily suddenly requires a large merge will see that merge aggressively throttled,
/// while an application doing heavy indexing will see the throttle move higher to allow merges to keep
/// up with ongoing indexing.
///
bool? AutoThrottle { get; set; }
///
/// The maximum number of threads that may be merging at once. Defaults to
///
/// which works well for a good solid-state-disk (SSD). If your index is on spinning platter drives instead,
/// decrease this to 1.
///
int? MaxThreadCount { get; set; }
}
public class MergeSchedulerSettings : IMergeSchedulerSettings
{
///
public bool? AutoThrottle { get; set; }
///
public int? MaxThreadCount { get; set; }
}
public class MergeSchedulerSettingsDescriptor
: DescriptorBase, IMergeSchedulerSettings
{
bool? IMergeSchedulerSettings.AutoThrottle { get; set; }
int? IMergeSchedulerSettings.MaxThreadCount { get; set; }
///
public MergeSchedulerSettingsDescriptor AutoThrottle(bool? throttle = true) =>
Assign(throttle, (a, v) => a.AutoThrottle = v);
///
public MergeSchedulerSettingsDescriptor MaxThreadCount(int? maxThreadCount) =>
Assign(maxThreadCount, (a, v) => a.MaxThreadCount = v);
}
}