feat(csharp): add TransformationOptions for ingestion transporter configuration (generated)

algolia/api-clients-automation#6292

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Mario-Alexandru Dan <marioalexandrudan@gmail.com>

Author: algolia-bot

algoliasearch/Clients/SearchClient.cs

@@ -5146,6 +5146,7 @@ public partial class SearchClient : ISearchClient
   internal HttpTransport _transport;
   private readonly ILogger<SearchClient> _logger;
   private IIngestionClient _ingestionTransporter;
+  private ILoggerFactory _loggerFactory;
 
   /// <summary>
   /// Create a new Search client for the given appID and apiKey.
@@ -5216,6 +5217,8 @@ public SearchClient(
         "WARNING: DEBUG level logging is enabled. This logs full request/response bodies which may contain sensitive data. Only use in local development."
       );
     }
+
+    _loggerFactory = factory;
   }
 
   /// <summary>
@@ -5229,27 +5232,64 @@ public void SetClientApiKey(string apiKey)
   }
 
   /// <summary>
-  /// Sets the region of the transformation pipeline. This is required to be called
-  /// if you wish to leverage the transformation pipeline (via the *WithTransformation methods).
+  /// Sets (or replaces) the ingestion transporter used by *WithTransformation helpers.
+  /// The ingestion transporter is created using the region from <paramref name="transformationOptions"/>
+  /// and Ingestion API defaults; only fields explicitly set on <paramref name="transformationOptions"/>
+  /// replace those defaults.
+  /// See https://www.algolia.com/doc/libraries/sdk/methods/ingestion
+  /// </summary>
+  /// <param name="transformationOptions">The transformation options including region and optional ingestion transporter overrides.</param>
+  public void SetTransformationOptions(TransformationOptions transformationOptions)
+  {
+    if (transformationOptions == null)
+      throw new ArgumentNullException(nameof(transformationOptions));
+
+    var ingestionConfig = new IngestionConfig(
+      _transport._algoliaConfig.AppId,
+      _transport._algoliaConfig.ApiKey,
+      transformationOptions.Region
+    );
+
+    if (transformationOptions.CustomHosts != null)
+      ingestionConfig.CustomHosts = transformationOptions.CustomHosts;
+    if (transformationOptions.ConnectTimeout.HasValue)
+      ingestionConfig.ConnectTimeout = transformationOptions.ConnectTimeout;
+    if (transformationOptions.ReadTimeout.HasValue)
+      ingestionConfig.ReadTimeout = transformationOptions.ReadTimeout;
+    if (transformationOptions.WriteTimeout.HasValue)
+      ingestionConfig.WriteTimeout = transformationOptions.WriteTimeout;
+    if (transformationOptions.Compression.HasValue)
+      ingestionConfig.Compression = transformationOptions.Compression.Value;
+    if (transformationOptions.DefaultHeaders != null)
+    {
+      foreach (var kvp in transformationOptions.DefaultHeaders)
+        ingestionConfig.DefaultHeaders[kvp.Key] = kvp.Value;
+    }
+
+    _ingestionTransporter = new IngestionClient(ingestionConfig, _loggerFactory);
+  }
+
+  /// <summary>
+  /// Sets the region of the transformation pipeline.
   /// </summary>
   /// <param name="region">The region ("us" or "eu")</param>
-  /// <param name="factory">Logger factory</param>
+  /// <param name="factory">Logger factory.</param>
+  [Obsolete(
+    "SetTransformationRegion is deprecated. Use SetTransformationOptions instead. "
+      + "See https://www.algolia.com/doc/libraries/sdk/methods/ingestion"
+  )]
   public void SetTransformationRegion(string region, ILoggerFactory factory = null)
   {
     if (string.IsNullOrWhiteSpace(region))
-    {
       throw new ArgumentException(
         "`region` must be provided when leveraging the transformation pipeline"
       );
-    }
 
     if (
       string.IsNullOrWhiteSpace(_transport._algoliaConfig.AppId)
       || string.IsNullOrWhiteSpace(_transport._algoliaConfig.ApiKey)
     )
-    {
       throw new ArgumentException("AppId and ApiKey are required for transformation pipeline");
-    }
 
     _ingestionTransporter = new IngestionClient(
       new IngestionConfig(_transport._algoliaConfig.AppId, _transport._algoliaConfig.ApiKey, region)
@@ -5261,10 +5301,57 @@ public void SetTransformationRegion(string region, ILoggerFactory factory = null
         Compression = _transport._algoliaConfig.Compression,
         CustomHosts = _transport._algoliaConfig.CustomHosts,
       },
-      factory
+      factory ?? _loggerFactory
     );
   }
 
+  /// <summary>
+  /// Creates a <see cref="SearchClient"/> configured with <see cref="TransformationOptions"/> for use
+  /// with <c>*WithTransformation</c> helpers. The ingestion transporter is initialised eagerly using
+  /// Ingestion API defaults; set override fields on <see cref="TransformationOptions"/> to change
+  /// specific defaults.
+  /// See https://www.algolia.com/doc/libraries/sdk/methods/ingestion
+  /// </summary>
+  /// <param name="appId">Your Algolia application ID.</param>
+  /// <param name="apiKey">Your Algolia API key.</param>
+  /// <param name="transformationOptions">The transformation options including region and optional ingestion transporter overrides.</param>
+  /// <param name="loggerFactory">Logger factory.</param>
+  public static SearchClient WithTransformation(
+    string appId,
+    string apiKey,
+    TransformationOptions transformationOptions,
+    ILoggerFactory loggerFactory = null
+  )
+  {
+    if (transformationOptions == null)
+      throw new ArgumentNullException(nameof(transformationOptions));
+    var client = new SearchClient(appId, apiKey, loggerFactory);
+    client.SetTransformationOptions(transformationOptions);
+    return client;
+  }
+
+  /// <summary>
+  /// Creates a <see cref="SearchClient"/> configured with <see cref="TransformationOptions"/> for use
+  /// with <c>*WithTransformation</c> helpers, using a custom <see cref="SearchConfig"/> for the search
+  /// transporter.
+  /// See https://www.algolia.com/doc/libraries/sdk/methods/ingestion
+  /// </summary>
+  /// <param name="searchConfig">Custom search transporter configuration.</param>
+  /// <param name="transformationOptions">The transformation options including region and optional ingestion transporter overrides.</param>
+  /// <param name="loggerFactory">Logger factory.</param>
+  public static SearchClient WithTransformation(
+    SearchConfig searchConfig,
+    TransformationOptions transformationOptions,
+    ILoggerFactory loggerFactory = null
+  )
+  {
+    if (transformationOptions == null)
+      throw new ArgumentNullException(nameof(transformationOptions));
+    var client = new SearchClient(searchConfig, loggerFactory);
+    client.SetTransformationOptions(transformationOptions);
+    return client;
+  }
+
   /// <inheritdoc />
   public async Task<AddApiKeyResponse> AddApiKeyAsync(
     ApiKey apiKey,

algoliasearch/Clients/TransformationOptions.cs

@@ -0,0 +1,50 @@
+using System;
+using System.Collections.Generic;
+using Algolia.Search.Models.Common;
+using Algolia.Search.Transport;
+
+namespace Algolia.Search.Clients;
+
+/// <summary>
+/// Configuration options for the ingestion transporter used by <c>*WithTransformation</c> helpers.
+/// An ingestion transporter is eagerly created using the provided region and Ingestion API defaults
+/// (25 s timeouts, region-derived hosts, no compression). Only fields explicitly set here replace
+/// the Ingestion API defaults. Credentials are always taken from the parent <see cref="SearchClient"/>.
+/// See https://www.algolia.com/doc/libraries/sdk/methods/ingestion
+/// </summary>
+public class TransformationOptions
+{
+  /// <summary>The ingestion region ("eu" or "us"). Required.</summary>
+  public string Region { get; }
+
+  /// <summary>Override the default ingestion hosts.</summary>
+  public List<StatefulHost> CustomHosts { get; set; }
+
+  /// <summary>Override the default connect timeout (25 s).</summary>
+  public TimeSpan? ConnectTimeout { get; set; }
+
+  /// <summary>Override the default read timeout (25 s).</summary>
+  public TimeSpan? ReadTimeout { get; set; }
+
+  /// <summary>Override the default write timeout (25 s).</summary>
+  public TimeSpan? WriteTimeout { get; set; }
+
+  /// <summary>Override the default compression (none).</summary>
+  public CompressionType? Compression { get; set; }
+
+  /// <summary>Override the default headers.</summary>
+  public Dictionary<string, string> DefaultHeaders { get; set; }
+
+  /// <param name="region">The ingestion region ("eu" or "us"). Required.</param>
+  /// <exception cref="ArgumentException">Thrown when region is null or whitespace.</exception>
+  public TransformationOptions(string region)
+  {
+    if (string.IsNullOrWhiteSpace(region))
+    {
+      throw new ArgumentException(
+        "region is required in TransformationOptions. See https://www.algolia.com/doc/libraries/sdk/methods/ingestion"
+      );
+    }
+    Region = region;
+  }
+}

algoliasearch/Utils/SearchClientExtensions.cs

@@ -443,7 +443,7 @@ List<BatchResponse> PartialUpdateObjects<T>(
   /// <summary>
   /// Helper: Similar to the `SaveObjects` method but requires a Push connector to be created first,
   /// in order to transform records before indexing them to Algolia.
-  /// The ingestion region must have been provided at client instantiation.
+  /// <see cref="TransformationOptions"/> must have been set via <see cref="SearchClient.SetTransformationOptions"/> or <see cref="SearchClient.WithTransformation"/>.
   /// </summary>
   /// <param name="indexName">The index in which to perform the request.</param>
   /// <param name="objects">The list of `objects` to store in the given Algolia `indexName`.</param>
@@ -476,7 +476,7 @@ List<BatchResponse> PartialUpdateObjects<T>(
   /// <summary>
   /// Helper: Similar to the `PartialUpdateObjects` method but requires a Push connector to be created first,
   /// in order to transform records before indexing them to Algolia.
-  /// The ingestion region must have been provided at client instantiation.
+  /// <see cref="TransformationOptions"/> must have been set via <see cref="SearchClient.SetTransformationOptions"/> or <see cref="SearchClient.WithTransformation"/>.
   /// </summary>
   /// <param name="indexName">The index in which to perform the request.</param>
   /// <param name="objects">The list of `objects` to update in the given Algolia `indexName`.</param>
@@ -514,7 +514,7 @@ List<BatchResponse> PartialUpdateObjects<T>(
   /// <summary>
   /// Helper: Similar to the `ReplaceAllObjects` method but requires a Push connector to be created first,
   /// in order to transform records before indexing them to Algolia.
-  /// The ingestion region must have been provided at client instantiation.
+  /// <see cref="TransformationOptions"/> must have been set via <see cref="SearchClient.SetTransformationOptions"/> or <see cref="SearchClient.WithTransformation"/>.
   /// A temporary index is created during this process in order to backup your data.
   /// </summary>
   /// <param name="indexName">The index in which to perform the request.</param>
@@ -1386,7 +1386,7 @@ public async Task<
     if (_ingestionTransporter == null)
     {
       throw new AlgoliaException(
-        "`setTransformationRegion` must have been called before calling this method."
+        "TransformationOptions must be set in the client config before calling this method. It defaults to the Ingestion API defaults. See https://www.algolia.com/doc/libraries/sdk/methods/ingestion"
       );
     }
 
@@ -1446,7 +1446,7 @@ public async Task<
     if (_ingestionTransporter == null)
     {
       throw new AlgoliaException(
-        "`setTransformationRegion` must have been called before calling this method."
+        "TransformationOptions must be set in the client config before calling this method. It defaults to the Ingestion API defaults. See https://www.algolia.com/doc/libraries/sdk/methods/ingestion"
       );
     }
 
@@ -1510,7 +1510,7 @@ public async Task<ReplaceAllObjectsWithTransformationResponse> ReplaceAllObjects
     if (_ingestionTransporter == null)
     {
       throw new AlgoliaException(
-        "`setTransformationRegion` must have been called before calling this method."
+        "TransformationOptions must be set in the client config before calling this method. It defaults to the Ingestion API defaults. See https://www.algolia.com/doc/libraries/sdk/methods/ingestion"
       );
     }