Move to Elastic.Transport nuget package (#5071)

Author: Mpdreamz

Directory.Build.props

@@ -42,6 +42,7 @@
   <ItemGroup>
     <PackageReference Condition="'$(OS)' != 'Windows_NT' and $(DefineConstants.Contains(FULLFRAMEWORK))" Include="Microsoft.NETFramework.ReferenceAssemblies" PrivateAssets="All" Version="1.0.0-preview.2"/>
   </ItemGroup>
+  
 
 
   <!--- 

Elasticsearch.sln

@@ -65,8 +65,6 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ApiGenerator", "src\ApiGene
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DocGenerator", "src\DocGenerator\DocGenerator.csproj", "{AB8A08CC-FCA5-49AF-901A-9120DAAA11D6}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Elastic.Transport.VirtualizedCluster", "src\Elastic.Transport.VirtualizedCluster\Elastic.Transport.VirtualizedCluster.csproj", "{CFE97627-8DD3-470B-B7CF-78B62E1D305D}"
-EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ExamplesGenerator", "src\ExamplesGenerator\ExamplesGenerator.csproj", "{1B9CCE9F-10CE-410A-BF9B-80935F3710A7}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Examples", "tests\Examples\Examples.csproj", "{393913C6-36ED-4F20-8864-2DA03E5606F0}"
@@ -79,10 +77,6 @@ ProjectSection(SolutionItems) = preProject
 	Directory.Build.targets = Directory.Build.targets
 EndProjectSection
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Elastic.Transport", "src\Elastic.Transport\Elastic.Transport.csproj", "{F510A0DE-8758-4A90-AE10-E25BE87A6D3D}"
-EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Elastic.Transport.Tests", "tests\Elastic.Transport.Tests\Elastic.Transport.Tests.csproj", "{CB131DE7-72C9-4383-86F0-B6D268904EC8}"
-EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -110,15 +104,12 @@ Global
 		{072BA7DA-7B60-407D-8B6E-95E3186BE70C} = {3EA11364-0513-44B7-AD6D-A675485E7448}
 		{CA508E92-50AE-4858-BD94-8637E88A8FAC} = {3EA11364-0513-44B7-AD6D-A675485E7448}
 		{AB8A08CC-FCA5-49AF-901A-9120DAAA11D6} = {3EA11364-0513-44B7-AD6D-A675485E7448}
-		{CFE97627-8DD3-470B-B7CF-78B62E1D305D} = {3EA11364-0513-44B7-AD6D-A675485E7448}
 		{1B9CCE9F-10CE-410A-BF9B-80935F3710A7} = {3EA11364-0513-44B7-AD6D-A675485E7448}
 		{393913C6-36ED-4F20-8864-2DA03E5606F0} = {6C4A2627-AF22-4388-9DF7-7A9AEACFD635}
 		{3D4B5CC3-43E1-44BD-A0EA-63798563B475} = {3EA11364-0513-44B7-AD6D-A675485E7448}
 		{D6997ADC-E933-418E-831C-DE1A78897493} = {29E53C13-34F7-4F0D-8D28-41EF768793E7}
 		{5A9C1B95-9280-433E-8D1B-1F5396126166} = {29E53C13-34F7-4F0D-8D28-41EF768793E7}
 		{432D5575-2347-4D3C-BF8C-3E38410C46CA} = {29E53C13-34F7-4F0D-8D28-41EF768793E7}
-		{F510A0DE-8758-4A90-AE10-E25BE87A6D3D} = {3EA11364-0513-44B7-AD6D-A675485E7448}
-		{CB131DE7-72C9-4383-86F0-B6D268904EC8} = {6C4A2627-AF22-4388-9DF7-7A9AEACFD635}
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
 		{5B393962-7586-49BA-BD99-3B1E35F48E94}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
@@ -181,10 +172,6 @@ Global
 		{AB8A08CC-FCA5-49AF-901A-9120DAAA11D6}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{AB8A08CC-FCA5-49AF-901A-9120DAAA11D6}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{AB8A08CC-FCA5-49AF-901A-9120DAAA11D6}.Release|Any CPU.Build.0 = Release|Any CPU
-		{CFE97627-8DD3-470B-B7CF-78B62E1D305D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{CFE97627-8DD3-470B-B7CF-78B62E1D305D}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{CFE97627-8DD3-470B-B7CF-78B62E1D305D}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{CFE97627-8DD3-470B-B7CF-78B62E1D305D}.Release|Any CPU.Build.0 = Release|Any CPU
 		{1B9CCE9F-10CE-410A-BF9B-80935F3710A7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{1B9CCE9F-10CE-410A-BF9B-80935F3710A7}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{1B9CCE9F-10CE-410A-BF9B-80935F3710A7}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -197,13 +184,5 @@ Global
 		{3D4B5CC3-43E1-44BD-A0EA-63798563B475}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{3D4B5CC3-43E1-44BD-A0EA-63798563B475}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{3D4B5CC3-43E1-44BD-A0EA-63798563B475}.Release|Any CPU.Build.0 = Release|Any CPU
-		{F510A0DE-8758-4A90-AE10-E25BE87A6D3D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{F510A0DE-8758-4A90-AE10-E25BE87A6D3D}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{F510A0DE-8758-4A90-AE10-E25BE87A6D3D}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{F510A0DE-8758-4A90-AE10-E25BE87A6D3D}.Release|Any CPU.Build.0 = Release|Any CPU
-		{CB131DE7-72C9-4383-86F0-B6D268904EC8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{CB131DE7-72C9-4383-86F0-B6D268904EC8}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{CB131DE7-72C9-4383-86F0-B6D268904EC8}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{CB131DE7-72C9-4383-86F0-B6D268904EC8}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 EndGlobal

docs/client-concepts/connection-pooling/building-blocks/connection-pooling.asciidoc

@@ -92,7 +92,7 @@ A cloud connection pool can be created using credentials and a `cloudId`
 
 [source,csharp]
 ----
-var credentials = new BasicAuthenticationCredentials("username", "password"); <1>
+var credentials = new BasicAuthentication("username", "password"); <1>
 var pool = new CloudConnectionPool(cloudId, credentials); <2>
 var client = new ElasticClient(new ConnectionSettings(pool));
 ----

docs/client-concepts/connection-pooling/building-blocks/keeping-track-of-nodes.asciidoc

@@ -111,7 +111,7 @@ Nodes are considered equal if they have the same endpoint, no matter what other
 [source,csharp]
 ----
 var node = new Node(new Uri("http://localhost:9200"));
-var nodeAsMaster = new Node(new Uri("http://localhost:9200"), ElasticsearchNodeFeatures.MasterEligableOnly);
+var nodeAsMaster = new Node(new Uri("http://localhost:9200"), ElasticsearchNodeFeatures.MasterEligibleOnly);
 
 (node == nodeAsMaster).Should().BeTrue();
 (node != nodeAsMaster).Should().BeFalse();

docs/client-concepts/connection-pooling/building-blocks/request-pipelines.asciidoc

@@ -23,7 +23,7 @@ the whole coordination of the request is deferred to a new instance in a `using`
 
 [source,csharp]
 ----
-var pipeline = new RequestPipeline(
+var pipeline = new RequestPipeline<IConnectionSettingsValues>(
     settings,
     DateTimeProvider.Default,
     new RecyclableMemoryStreamFactory(),
@@ -38,15 +38,15 @@ to create them
 
 [source,csharp]
 ----
-var requestPipelineFactory = new RequestPipelineFactory();
+var requestPipelineFactory = new RequestPipelineFactory<IConnectionSettingsValues>();
 var requestPipeline = requestPipelineFactory.Create(
     settings,
     DateTimeProvider.Default, <1>
     new RecyclableMemoryStreamFactory(),
     new SearchRequestParameters()
 );
 
-requestPipeline.Should().BeOfType<RequestPipeline>();
+requestPipeline.Should().BeOfType<RequestPipeline<IConnectionSettingsValues>>();
 requestPipeline.GetType().Should().Implement<IDisposable>();
 ----
 <1> An <<date-time-providers,`IDateTimeProvider`>> implementation

docs/client-concepts/connection-pooling/sniffing/on-connection-failure.asciidoc

@@ -188,7 +188,7 @@ void SniffUrlAssert(Audit a, string host, int expectedPort)
     HostAssert(a, host, expectedPort);
     var sniffUri = new UriBuilder(a.Node.Uri)
     {
-        Path = RequestPipeline.SniffPath,
+        Path = ElasticsearchProductRegistration.SniffPath,
         Query = "flat_settings=true&timeout=2s"
     }.Uri;
     sniffUri.PathEquals(a.Path, nameof(SniffUrlAssert));

docs/client-concepts/connection-pooling/sniffing/on-startup.asciidoc

@@ -141,8 +141,8 @@ Sniffing prefers to run on master eligible nodes
 ----
 var audit = new Auditor(() => Virtual.Elasticsearch
     .Bootstrap(new[] {
-        new Node(new Uri("http://localhost:9200"), NotMasterEligable),
-        new Node(new Uri("http://localhost:9201"), NotMasterEligable),
+        new Node(new Uri("http://localhost:9200"), NotMasterEligible),
+        new Node(new Uri("http://localhost:9201"), NotMasterEligible),
         new Node(new Uri("http://localhost:9202")),
     })
     .Sniff(s => s.Succeeds(Always))
@@ -168,7 +168,7 @@ var audit = new Auditor(() => Virtual.Elasticsearch
     .Bootstrap(new[] {
         new Node(new Uri("http://localhost:9200")),
         new Node(new Uri("http://localhost:9201")),
-        new Node(new Uri("http://localhost:9202"), NotMasterEligable),
+        new Node(new Uri("http://localhost:9202"), NotMasterEligible),
     })
     .Sniff(s => s.Fails(Always))
     .Sniff(s => s.OnPort(9202).Succeeds(Always))

docs/client-concepts/connection/configuration-options.asciidoc

@@ -26,105 +26,113 @@ The following is a list of available connection configuration options on `Connec
 `ConnectionSettings` derives from `ConnectionConfiguration`, these options are available for both
 the low level and high level client:
 
-`ApiKeyAuthentication`::
+`Authentication`::
 
-Api Key to send with all requests to Elasticsearch
-
-`BasicAuthentication`::
-
-Basic Authentication credentials to send with all requests to Elasticsearch
+An implementation of `IAuthenticationHeader` describing what http header to use to authenticate with the product.
++
+ `BasicAuthentication` for basic authentication
++
+ `ApiKey` for simple secret token
++
+ `Base64ApiKey` for Elastic Cloud style encoded api keys
 
 `ClientCertificate`::
 
-Use a `X509Certificate` to authenticate all HTTP requests. You can also set them on individual request using `ClientCertificates`
+Use the following certificates to authenticate all HTTP requests. You can also set them on individual request using `ClientCertificates`
 
 `ClientCertificates`::
 
 Use the following certificates to authenticate all HTTP requests. You can also set them on individual request using `ClientCertificates`
 
 `ConnectionLimit`::
 
-Limits the number of concurrent connections that can be opened to an endpoint. Defaults to `80` for all IConnection             implementations that are not based on `System.Net.Http.CurlHandler` . For those based on System.Net.Http.CurlHandler, defaults             to `Environment.ProcessorCount` .
+Limits the number of concurrent connections that can be opened to an endpoint. Defaults to 80 (see `DefaultConnectionLimit` ).
 +
 For Desktop CLR, this setting applies to the DefaultConnectionLimit property on the  ServicePointManager object when creating ServicePoint objects, affecting the default `IConnection` implementation.
 +
 For Core CLR, this setting applies to the MaxConnectionsPerServer property on the HttpClientHandler instances used by the HttpClient inside the default `IConnection` implementation
 
 `DeadTimeout`::
 
-Sets the default dead timeout factor when a node has been marked dead. Some connection pools may use a flat timeout whilst others take this factor and increase it exponentially
+The time to put dead nodes out of rotation (this will be multiplied by the number of times they've been dead)
 
 `DisableAutomaticProxyDetection`::
 
-Disables the automatic detection of a proxy
+Disabled proxy detection on the webrequest, in some cases this may speed up the first connection your appdomain makes, in other cases it will actually increase the time for the first connection. No silver bullet! use with care!
 
 `DisableDirectStreaming`::
 
-Ensures the response bytes are always available on the `ITransportResponse`
-+
-IMPORTANT: Depending on the registered serializer, this may cause the response to be buffered in memory first, potentially affecting performance.
+When set to true will disable (de)serializing directly to the request and response stream and return a byte[] copy of the raw request and response. Defaults to false
 
 `DisablePing`::
 
-When a node is used for the very first time or when it's used for the first time after it has been marked dead a ping with a very low timeout is send to the node to make sure that when it's still dead it reports it as fast as possible. You can disable these pings globally here if you rather have it fail on the possible slower original request
+This signals that we do not want to send initial pings to unknown/previously dead nodes and just send the call straightaway
+
+`DnsRefreshTimeout`::
+
+DnsRefreshTimeout for the connections. Defaults to 5 minutes.
 
 `EnableDebugMode`::
 
 Turns on settings that aid in debugging like DisableDirectStreaming() and PrettyJson() so that the original request and response JSON can be inspected. It also always asks the server for the full stack trace on errors
 
 `EnableHttpCompression`::
 
-Enables gzip compressed requests and responses.
+Enable gzip compressed requests and responses
 
 `EnableHttpPipelining`::
 
-Allows for requests to be pipelined. http://en.wikipedia.org/wiki/HTTP_pipelining
-+
-NOTE: HTTP pipelining must also be enabled in e.g Elasticsearch for this to work properly.
+Whether HTTP pipelining is enabled. The default is `true`
 
 `EnableTcpKeepAlive`::
 
 Sets the keep-alive option on a TCP connection.
 +
 For Desktop CLR, sets ServicePointManager.SetTcpKeepAlive
 
+`EnableTcpStats`::
+
+Enable statistics about TCP connections to be collected when making a request >
+
 `GlobalHeaders`::
 
-A collection of headers that will be sent with every request. Useful in situations where you always need to pass a header e.g. a custom auth header
+Try to send these headers for every request
 
 `GlobalQueryStringParameters`::
 
-A collection of query string parameters that will be sent with every request. Useful in situations where you always need to pass a parameter e.g. an API key.
+Append these query string parameters automatically to every request
 
 `MaxDeadTimeout`::
 
-Sets the maximum time a node can be marked dead. Different implementations of `IConnectionPool` may choose a different default.
+The maximum amount of time a node is allowed to marked dead
 
 `MaximumRetries`::
 
-The maximum number of retries for a given request
+When a retryable exception occurs or status code is returned this controls the maximum amount of times we should retry the call to Elasticsearch
 
 `MaxRetryTimeout`::
 
-Limits the total runtime, including retries, separately from `RequestTimeout`
-+
-When not specified, defaults to `RequestTimeout` , which itself defaults to `60` seconds
+Limits the total runtime including retries separately from `RequestTimeout` When not specified defaults to `RequestTimeout` which itself defaults to 60 seconds
+
+`MemoryStreamFactory`::
+
+Provides a memory stream factory
 
 `NodePredicate`::
 
 Register a predicate to select which nodes that you want to execute API calls on. Note that sniffing requests omit this predicate and always execute on all nodes. When using an `IConnectionPool` implementation that supports reseeding of nodes, this will default to omitting master only             node from regular API calls.             When using static or single node connection pooling it is assumed the list of node you instantiate the client with should be taken             verbatim.
 
 `OnRequestCompleted`::
 
-Registers an `Action<T>` that is called when a response is received.             This can be useful for implementing custom logging.             Multiple callbacks can be registered by calling this multiple times
+Allows you to register a callback every time a an API call is returned
 
 `OnRequestDataCreated`::
 
-Registers an `Action<T>` that is called when `RequestData` is created.             Multiple callbacks can be registered by calling this multiple times
+An action to run when the `RequestData` for a request has been             created.
 
 `PingTimeout`::
 
-Sets the default ping timeout in milliseconds for ping requests, which are used to determine whether a node is alive. Pings should fail as fast as possible.
+The timeout in milliseconds to use for ping requests, which are issued to determine whether a node is alive
 
 `PrettyJson`::
 
@@ -138,27 +146,27 @@ If your connection has to go through proxy, use this method to specify the proxy
 
 `RequestTimeout`::
 
-Sets the default timeout in milliseconds for each request. Defaults to `60` seconds.
+The timeout in milliseconds for each request to Elasticsearch
 
 `ServerCertificateValidationCallback`::
 
-Register a ServerCertificateValidationCallback, this is called per endpoint until it returns true. After this callback returns true that endpoint is validated for the lifetime of the ServiceEndpoint for that host.
+Register a ServerCertificateValidationCallback per request
 
 `SkipDeserializationForStatusCodes`::
 
-Configure the client to skip deserialization of certain status codes e.g: you run Elasticsearch behind a proxy that returns a HTML for 401, 500
+Configure the client to skip deserialization of certain status codes e.g: you run Elasticsearch behind a proxy that returns an unexpected json format
 
 `SniffLifeSpan`::
 
-Set the duration after which a cluster state is considered stale and a sniff should be performed again. An `IConnectionPool` has to signal it supports reseeding, otherwise sniffing will never happen.             Defaults to 1 hour.             Set to null to disable completely. Sniffing will only ever happen on ConnectionPools that return true for SupportsReseeding
+Force a new sniff for the cluster when the cluster state information is older than the specified timespan
 
 `SniffOnConnectionFault`::
 
-Enables resniffing of the cluster when a call fails, if the connection pool supports reseeding. Defaults to `true`
+Force a new sniff for the cluster state every time a connection dies
 
 `SniffOnStartup`::
 
-Enables sniffing on first usage of a connection pool if that pool supports reseeding. Defaults to `true`
+Sniff the cluster state immediately on startup
 
 `ThrowExceptions`::
 
@@ -168,7 +176,7 @@ Reasons for such exceptions could be search parser errors, index missing excepti
 
 `TransferEncodingChunked`::
 
-Whether the request should be sent with chunked Transfer-Encoding. Default is `false`
+Whether the request should be sent with chunked Transfer-Encoding.
 
 `UserAgent`::
 

docs/client-concepts/connection/modifying-default-connection.asciidoc

@@ -101,24 +101,22 @@ provides some examples
 ----
 public class MyCustomHttpConnection : HttpConnection
 {
-    protected override HttpRequestMessage CreateRequestMessage(RequestData requestData)
+    protected override void SetAuthenticationIfNeeded(HttpRequestMessage requestMessage, RequestData requestData)
+
     {
-        var message = base.CreateRequestMessage(requestData);
         var header = string.Empty;
-        message.Headers.Authorization = new AuthenticationHeaderValue("Negotiate", header);
-        return message;
+        requestMessage.Headers.Authorization = new AuthenticationHeaderValue("Negotiate", header);
     }
 }
 
 public class KerberosConnection : HttpConnection
 {
-    protected override HttpRequestMessage CreateRequestMessage(RequestData requestData)
+    protected override void SetAuthenticationIfNeeded(HttpRequestMessage requestMessage, RequestData requestData)
     {
-        var message = base.CreateRequestMessage(requestData);
         var header = string.Empty;
-        message.Headers.Authorization = new AuthenticationHeaderValue("Negotiate", header);
-        return message;
+        requestMessage.Headers.Authorization = new AuthenticationHeaderValue("Negotiate", header);
     }
+
 }
 ----
 

docs/x-pack/security/api-key/security-api-key-usage.asciidoc

@@ -25,7 +25,7 @@ TryGetExtendedValue<CreateApiKeyResponse>("response", out var response);
 if (response == null)
         return d => d;
 
-return d => d.RequestConfiguration(r => r.ApiKeyAuthentication(response.Id, response.ApiKey));
+return d => d.RequestConfiguration(r => r.Authentication(new Base64ApiKey(response.Id, response.ApiKey)));
 ----
 
 ==== Object Initializer syntax example
@@ -42,7 +42,7 @@ return new NodesInfoRequest
     {
         RequestConfiguration = new RequestConfiguration
         {
-            ApiKeyAuthenticationCredentials = new ApiKeyAuthenticationCredentials(response.Id, response.ApiKey)
+            AuthenticationHeader = new Base64ApiKey(response.Id, response.ApiKey)
         }
     };
 ----