Class CloudConnectionPool

An IConnectionPool implementation that can be seeded with a cloud id and will signal the right defaults for the client to use for OpenSearch Cloud to IConnectionConfigurationValues.

Read more about OpenSearch Cloud Id:

Inheritance

object

SingleNodeConnectionPool

CloudConnectionPool

Implements

IConnectionPool

IDisposable

Inherited Members

SingleNodeConnectionPool.LastUpdate

SingleNodeConnectionPool.MaxRetries

SingleNodeConnectionPool.Nodes

SingleNodeConnectionPool.SniffedOnStartup

SingleNodeConnectionPool.SupportsPinging

SingleNodeConnectionPool.SupportsReseeding

SingleNodeConnectionPool.UsingSsl

SingleNodeConnectionPool.CreateView(Action<AuditEvent, Node>)

SingleNodeConnectionPool.Reseed(IEnumerable<Node>)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net

Assembly: OpenSearch.Net.dll

Syntax

public class CloudConnectionPool : SingleNodeConnectionPool, IConnectionPool, IDisposable

Constructors

CloudConnectionPool(string, ApiKeyAuthenticationCredentials, IDateTimeProvider)

An IConnectionPool implementation that can be seeded with a cloud id and will signal the right defaults for the client to use for OpenSearch Cloud to IConnectionConfigurationValues.

Read more about OpenSearch Cloud Id here

Declaration

public CloudConnectionPool(string cloudId, ApiKeyAuthenticationCredentials credentials, IDateTimeProvider dateTimeProvider = null)

Parameters

Type	Name	Description
string	cloudId	The Cloud Id, this is available on your cluster's dashboard and is a string in the form of cluster_name:base_64_encoded_string Base64 encoded string contains the following tokens in order separated by $: * Host Name (mandatory) * OpenSearch UUID (mandatory) * OpenSearchDashboards UUID * APM UUID We then use these tokens to create the URI to your OpenSearch Cloud cluster! Read more here:
ApiKeyAuthenticationCredentials	credentials
IDateTimeProvider	dateTimeProvider

CloudConnectionPool(string, BasicAuthenticationCredentials, IDateTimeProvider)

An IConnectionPool implementation that can be seeded with a cloud id and will signal the right defaults for the client to use for OpenSearch Cloud to IConnectionConfigurationValues.

Read more about OpenSearch Cloud Id here

Declaration

public CloudConnectionPool(string cloudId, BasicAuthenticationCredentials credentials, IDateTimeProvider dateTimeProvider = null)

Parameters

Type	Name	Description
string	cloudId	The Cloud Id, this is available on your cluster's dashboard and is a string in the form of cluster_name:base_64_encoded_string Base64 encoded string contains the following tokens in order separated by $: * Host Name (mandatory) * OpenSearch UUID (mandatory) * OpenSearchDashboards UUID * APM UUID We then use these tokens to create the URI to your OpenSearch Cloud cluster! Read more here:
BasicAuthenticationCredentials	credentials
IDateTimeProvider	dateTimeProvider

Properties

ApiKeyCredentials

Declaration

public ApiKeyAuthenticationCredentials ApiKeyCredentials { get; }

Property Value

Type	Description
ApiKeyAuthenticationCredentials

BasicCredentials

Declaration

public BasicAuthenticationCredentials BasicCredentials { get; }

Property Value

Type	Description
BasicAuthenticationCredentials

Methods

DisposeManagedResources()

Declaration

protected override void DisposeManagedResources()

Overrides

SingleNodeConnectionPool.DisposeManagedResources()

Implements

IConnectionPool

IDisposable

Extension Methods

SuffixExtensions.Suffix(object, string)