docs.feldera.com/python/_modules/feldera/rest/config.html at main · feldera/docs.feldera.com

History

159 lines (134 loc) · 11.2 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

<!DOCTYPE html>

<head>

<title>feldera.rest.config — Feldera Python SDK 0.277.0 documentation</title>

<!--[if lt IE 9]>

<![endif]-->

</head>

Feldera Python SDK

</a>

</form>

</div>

</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">

Contents:

<ul>

<li class="toctree-l1"><a class="reference internal" href="../../../introduction.html">Introduction</a></li>

<li class="toctree-l1"><a class="reference internal" href="../../../pandas.html">Pandas Compatibility</a></li>

<li class="toctree-l1"><a class="reference internal" href="../../../examples.html">Examples</a></li>

</ul>

API Reference:

<ul>

<li class="toctree-l1"><a class="reference internal" href="../../../modules.html">feldera</a></li>

</ul>

</div>

</nav>

<a href="../../../index.html">Feldera Python SDK</a>

</nav>

<li class="breadcrumb-item"><a href="../../index.html">Module code</a></li>

<li class="breadcrumb-item active">feldera.rest.config</li>

</li>

</ul>

<hr/>

</div>

<h1>Source code for feldera.rest.config</h1><div class="highlight"><pre>

import logging

import os

from typing import Optional

from feldera.rest._helpers import requests_verify_from_env

class Config:

"""

:class:`.FelderaClient` configuration, which includes authentication information

and the address of the Feldera API the client will interact with.

"""

def __init__(

self,

url: Optional[str] = None,

api_key: Optional[str] = None,

version: Optional[str] = None,

timeout: Optional[float] = None,

connection_timeout: Optional[float] = None,

requests_verify: Optional[bool | str] = None,

health_recovery_timeout: Optional[int] = None,

) -> None:

"""

See documentation of the `FelderaClient` constructor for the other arguments.

:param version: (Optional) Version of the API to use.

Default: `v0`.

:param health_recovery_timeout: (Optional) Maximum time in seconds to wait for cluster health recovery after a 502 error.

Default: `300` (5 minutes).

"""

self.url: str = url or os.environ.get("FELDERA_HOST") or "http://localhost:8080"

self.api_key: Optional[str] = api_key or os.environ.get("FELDERA_API_KEY")

self.version: str = version or "v0"

self.timeout: Optional[float] = timeout

self.connection_timeout: Optional[float] = connection_timeout

self.health_recovery_timeout: int = health_recovery_timeout or 300

env_verify = requests_verify_from_env()

self.requests_verify: bool | str = (

requests_verify if requests_verify is not None else env_verify

)

if self.requests_verify is False:

logging.warning("Feldera client: TLS verification is disabled!")</div>

</div>

</pre></div>

</div>

<hr/>

</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>

provided by <a href="https://readthedocs.org">Read the Docs</a>.

</footer>

</div>

</section>

</div>

jQuery(function () {

SphinxRtdTheme.Navigation.enable(true);

});

</script>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

config.html

Latest commit

History

config.html

File metadata and controls