Struct opensearch_testcontainer::OpenSearch

pub struct OpenSearch { /* private fields */ }

Implementations

impl OpenSearch

pub fn with_name(self, name: &str) -> Self

pub fn with_tag(self, tag: &str) -> Self

pub fn with_cluster_name(self, name: &str) -> Self

pub fn with_env_var(self, key: &str, value: &str) -> Self

pub fn username(&self) -> String

pub fn password(&self) -> String

Trait Implementations

impl Clone for OpenSearch

fn clone(&self) -> OpenSearch

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OpenSearch

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OpenSearch

fn default() -> Self

Returns the “default value” for a type.

impl Image for OpenSearch

type Args = ()

A type representing the arguments for an Image.

fn name(&self) -> String

The name of the docker image to pull from the Docker Hub registry.

fn tag(&self) -> String

Implementations are encouraged to include a tag that will not change (i.e. NOT latest) in order to prevent test code from randomly breaking because the underlying docker suddenly changed.

fn ready_conditions(&self) -> Vec<WaitFor>

Returns a list of conditions that need to be met before a started container is considered ready.

fn env_vars(&self) -> Box<dyn Iterator<Item = (&String, &String)> + '_>

There are a couple of things regarding the environment variables of images:

fn expose_ports(&self) -> Vec<u16>

Returns the ports that needs to be exposed when a container is created.

fn volumes(&self) -> Box<dyn Iterator<Item = (&String, &String)> + '_>

There are a couple of things regarding the volumes of images:

fn entrypoint(&self) -> Option<String>

Returns the entrypoint this instance was created with.

fn exec_after_start(&self, cs: ContainerState) -> Vec<ExecCommand>

Returns the commands that needs to be executed after a container is started i.e. commands to be run in a running container.