PeanutButter
Loading...
Searching...
No Matches
PeanutButter.TempElasticsearch.TempElasticSearchOptions Class Reference

Properties

int Port = PortFinder.FindOpenPort(IPAddress.Loopback, 9200, 9300) [get, set]
 The desired port to listen on.
string User [get, set]
 The desired username for auth.
string Password [get, set]
 The desired password for auth.
int CPUs = 2 [get, set]
 The max number of cpus to let docker take over for this (default: 2).
int MaxMemoryMb = 1024 [get, set]
 The max memory, in megabytes, to allow for the docker container (default: 1024).
string Version = "9.2.1" [get, set]
 Sets the version of the elasticsearch docker image to start up (default: 9.2.1).
int MaxTimeAllowedToComeUpInSeconds = 45 [get, set]
 The maximum amount of time, in seconds, to allow for the dockerised elasticsearch to become available before giving up. When a connection cannot be established within this time, an UnableToStartTempElasticsearch exception is raised default: 45.
Action< string > DockerLogReceiver [get, set]
 Normally, docker output is discarded (there is a lot!) but if you want to debug the docker startup process, you may set an handler here to collect logs.

Property Documentation

◆ DockerLogReceiver

Action<string> PeanutButter.TempElasticsearch.TempElasticSearchOptions.DockerLogReceiver
getset

Normally, docker output is discarded (there is a lot!) but if you want to debug the docker startup process, you may set an handler here to collect logs.

  • when not set, logs are discarded

◆ Password

string PeanutButter.TempElasticsearch.TempElasticSearchOptions.Password
getset

The desired password for auth.

  • defaults to empty
  • when no username specified, is ignored

◆ Port

int PeanutButter.TempElasticsearch.TempElasticSearchOptions.Port = PortFinder.FindOpenPort(IPAddress.Loopback, 9200, 9300)
getset

The desired port to listen on.

  • default: is selected randomly from available open ports between 9200 and 9300 inclusive

◆ User

string PeanutButter.TempElasticsearch.TempElasticSearchOptions.User
getset

The desired username for auth.

  • defaults to empty (no auth)
The documentation for this class was generated from the following file:
  • source/TempDb/PeanutButter.TempElasticsearch/TempElasticSearchOptions.cs