Add a CloudConnectionPool #4005
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ettings constructors to ease connecting to Elastic Cloud
russcam
approved these changes
Aug 7, 2019
| * [[cloud-connection-pool]] | ||
| * ==== CloudConnectionPool | ||
| * | ||
| * A specialized subclass of `SingleNodeConnectionPool that accepts a Cloud Id and credentials. |
There was a problem hiding this comment.
link to Cloud docs for Cloud Id
There was a problem hiding this comment.
I can't use {ref_current} for https://www.elastic.co/guide/en/cloud/current/ec-cloud-id.html would need to add a new block I think.
Is my assumption correct @russcam ?
| * ==== CloudConnectionPool | ||
| * | ||
| * A specialized subclass of `SingleNodeConnectionPool that accepts a Cloud Id and credentials. | ||
| * When used the client will also pick Elastic Cloud optmized defaults for the connection settings. |
src/Tests/Tests/ClientConcepts/ConnectionPooling/BuildingBlocks/ConnectionPooling.doc.cs
Outdated
Show resolved
Hide resolved
| */ | ||
| var credentials = new BasicAuthenticationCredentials("username", "password"); | ||
| var pool = new CloudConnectionPool(cloudId, credentials); | ||
| pool.UsingSsl.Should().BeTrue(); |
There was a problem hiding this comment.
I think we should start steering away from emitting test assertions in documentation. I think it adds noise to the signal we're trying to display to users, in this case, how to configure the client for user with Elasticsearch Service on Elastic Cloud. We can prefix and assertions with // hide, and introduce a block scope {} and prefix, if needing to hide more.
| public BasicAuthenticationCredentials() | ||
| { | ||
| } | ||
| //TODO remove this constructor in 8.0 |
| { | ||
| } | ||
| //TODO remove this constructor in 8.0 | ||
| public ApiKeyAuthenticationCredentials() { } |
Co-Authored-By: Russ Cam <russ.cam@elastic.co>
|
Merging this in, will follow up with linking to the cloud id docs. |
Mpdreamz
added a commit
that referenced
this pull request
Aug 9, 2019
* Add CloudConnectionPool and overloads to the high/low level clients settings constructors to ease connecting to Elastic Cloud * Add tests for the CloudConnectionPool * Apply suggestions from code review Co-Authored-By: Russ Cam <russ.cam@elastic.co> * fix failing tests due to updated exception message (cherry picked from commit fdb1933)
russcam
pushed a commit
that referenced
this pull request
Aug 13, 2019
* Add CloudConnectionPool and overloads to the high/low level clients settings constructors to ease connecting to Elastic Cloud * Add tests for the CloudConnectionPool * Apply suggestions from code review Co-Authored-By: Russ Cam <russ.cam@elastic.co> * fix failing tests due to updated exception message (cherry picked from commit fdb1933) (cherry picked from commit fd5716f)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR allows Elastic Cloud users to use their Cloud Id to configure the client much like they would Logstash / Beats see: https://www.elastic.co/guide/en/cloud/current/ec-cloud-id.html
This also allows us to set some specific
ConnectionSettingsdefaults.