/* 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 System; using System.Runtime.Serialization; using OpenSearch.Net.Extensions; using OpenSearch.Net.Utf8Json; using OpenSearch.Net.Utf8Json.Internal; namespace OpenSearch.Client.Specification.SnapshotApi { /// /// A source repository enables you to create minimal, source-only snapshots that take up to 50% less space on disk. /// Source only snapshots contain stored fields and index metadata. They do not include index or doc values structures /// and are not searchable when restored. After restoring a source-only snapshot, you must reindex the data into a new index. /// [JsonFormatter(typeof(SourceOnlyRepositoryFormatter))] public interface ISourceOnlyRepository : IRepositoryWithSettings { /// /// The type of snapshot repository to delegate to for storage /// [IgnoreDataMember] string DelegateType { get; } } /// public class SourceOnlyRepository : ISourceOnlyRepository { private readonly object _delegateSettings; private readonly string _delegateType; internal SourceOnlyRepository() { } internal SourceOnlyRepository(string delegateType, object settings) { _delegateType = delegateType; _delegateSettings = settings; } public SourceOnlyRepository(IRepositoryWithSettings repositoryToDelegateTo) { if (repositoryToDelegateTo == null) throw new ArgumentNullException(nameof(repositoryToDelegateTo)); _delegateType = repositoryToDelegateTo.Type; _delegateSettings = repositoryToDelegateTo.DelegateSettings; } object IRepositoryWithSettings.DelegateSettings => _delegateSettings; string ISourceOnlyRepository.DelegateType => _delegateType; string ISnapshotRepository.Type { get; } = "source"; } /// public class SourceOnlyRepositoryDescriptor : DescriptorBase, ISourceOnlyRepository { private object _delegateSettings; private string _delegateType; object IRepositoryWithSettings.DelegateSettings => _delegateSettings; string ISourceOnlyRepository.DelegateType => _delegateType; string ISnapshotRepository.Type { get; } = "source"; private SourceOnlyRepositoryDescriptor DelegateTo(Func selector) where TDescriptor : IRepositoryWithSettings, new() => Custom(selector?.Invoke(new TDescriptor())); /// public SourceOnlyRepositoryDescriptor FileSystem(Func selector) => DelegateTo(selector); /// public SourceOnlyRepositoryDescriptor ReadOnlyUrl(Func selector) => DelegateTo(selector); /// public SourceOnlyRepositoryDescriptor Azure(Func selector = null) => DelegateTo(selector); /// public SourceOnlyRepositoryDescriptor Hdfs(Func selector) => DelegateTo(selector); /// public SourceOnlyRepositoryDescriptor S3(Func selector) => DelegateTo(selector); /// public SourceOnlyRepositoryDescriptor Custom(IRepositoryWithSettings repository) { _delegateType = repository?.Type; _delegateSettings = repository?.DelegateSettings; return this; } } internal class SourceOnlyRepositoryFormatter : IJsonFormatter { private static readonly AutomataDictionary Fields = new AutomataDictionary { { "type", 0 }, { "settings", 1 } }; private static readonly byte[] DelegateType = JsonWriter.GetEncodedPropertyNameWithoutQuotation("delegate_type"); public void Serialize(ref JsonWriter writer, ISourceOnlyRepository value, IJsonFormatterResolver formatterResolver) { if (value.DelegateType.IsNullOrEmpty()) { writer.WriteNull(); return; } writer.WriteBeginObject(); writer.WritePropertyName("type"); writer.WriteString("source"); if (value.DelegateSettings != null) { writer.WriteValueSeparator(); writer.WritePropertyName("settings"); writer.WriteBeginObject(); writer.WritePropertyName("delegate_type"); writer.WriteString(value.DelegateType); writer.WriteValueSeparator(); var innerWriter = new JsonWriter(); switch (value.DelegateType) { case "s3": Serialize(ref innerWriter, value.DelegateSettings, formatterResolver); break; case "azure": Serialize(ref innerWriter, value.DelegateSettings, formatterResolver); break; case "url": Serialize(ref innerWriter, value.DelegateSettings, formatterResolver); break; case "hdfs": Serialize(ref innerWriter, value.DelegateSettings, formatterResolver); break; case "fs": Serialize(ref innerWriter, value.DelegateSettings, formatterResolver); break; default: Serialize(ref innerWriter, value.DelegateSettings, formatterResolver); break; } var buffer = innerWriter.GetBuffer(); // get all the written bytes between the opening and closing {} for (var i = 1; i < buffer.Count - 1; i++) writer.WriteRawUnsafe(buffer.Array[i]); writer.WriteEndObject(); } writer.WriteEndObject(); } private static void Serialize(ref JsonWriter writer, object value, IJsonFormatterResolver formatterResolver) where TRepositorySettings : class, IRepositorySettings { var formatter = formatterResolver.GetFormatter(); formatter.Serialize(ref writer, value as TRepositorySettings, formatterResolver); } private static TRepositorySettings Deserialize(ref JsonReader reader, IJsonFormatterResolver formatterResolver) where TRepositorySettings : class, IRepositorySettings { var formatter = formatterResolver.GetFormatter(); return formatter.Deserialize(ref reader, formatterResolver); } public ISourceOnlyRepository Deserialize(ref JsonReader reader, IJsonFormatterResolver formatterResolver) { if (reader.GetCurrentJsonToken() != JsonToken.BeginObject) { reader.ReadNextBlock(); return null; } var count = 0; ArraySegment settings = default; while (reader.ReadIsInObject(ref count)) { var propertyName = reader.ReadPropertyNameSegmentRaw(); if (Fields.TryGetValue(propertyName, out var value)) { switch (value) { case 0: reader.ReadNext(); break; case 1: settings = reader.ReadNextBlockSegment(); break; } } else reader.ReadNextBlock(); } if (settings == default) return null; var segmentReader = new JsonReader(settings.Array, settings.Offset); string delegateType = null; object delegateSettings = null; // reset count to zero to so that ReadIsInObject skips opening brace count = 0; while (segmentReader.ReadIsInObject(ref count)) { var propertyName = segmentReader.ReadPropertyNameSegmentRaw(); if (propertyName.EqualsBytes(DelegateType)) { delegateType = segmentReader.ReadString(); break; } segmentReader.ReadNextBlock(); } // reset the offset segmentReader.ResetOffset(); switch (delegateType) { case "s3": delegateSettings = Deserialize(ref segmentReader, formatterResolver); break; case "azure": delegateSettings = Deserialize(ref segmentReader, formatterResolver); break; case "url": delegateSettings = Deserialize(ref segmentReader, formatterResolver); break; case "hdfs": delegateSettings = Deserialize(ref segmentReader, formatterResolver); break; case "fs": delegateSettings = Deserialize(ref segmentReader, formatterResolver); break; } return new SourceOnlyRepository(delegateType, delegateSettings); } } }