docs.feldera.com/python/_modules/feldera/enums.html at main · feldera/docs.feldera.com

History

580 lines (456 loc) · 45.4 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

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

<!DOCTYPE html>

<head>

<title>feldera.enums — Feldera Python SDK 0.276.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.enums</li>

</li>

</ul>

<hr/>

</div>

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

from enum import Enum

from typing import Optional

class CompilationProfile(Enum):

"""

The compilation profile to use when compiling the program.

"""

SERVER_DEFAULT = None

"""

The compiler server default compilation profile.

"""

DEV = "dev"

"""

The development compilation profile.

"""

UNOPTIMIZED = "unoptimized"

"""

The unoptimized compilation profile.

"""

OPTIMIZED = "optimized"

"""

The optimized compilation profile, the default for this API.

"""

OPTIMIZED_SYMBOLS = "optimized_symbols"

"""

The optimized symbols compilation profile, good for profiling and debugging.

"""</div>

class BuildMode(Enum):

CREATE = 1

GET = 2

GET_OR_CREATE = 3</div>

class DeploymentDesiredStatus(Enum):

"""

Deployment desired status of the pipeline.

"""

STOPPED = 0

UNAVAILABLE = 1

STANDBY = 2

PAUSED = 3

RUNNING = 4

SUSPENDED = 5

@staticmethod

def from_str(value):

for member in DeploymentDesiredStatus:

if member.name.lower() == value.lower():

return member

raise ValueError(

f"Unknown value '{value}' for enum {DeploymentDesiredStatus.__name__}"

)</div>

</div>

class DeploymentResourcesDesiredStatus(Enum):

"""

The desired status of deployment resources of the pipeline.

"""

STOPPED = 0

PROVISIONED = 1

@staticmethod

def from_str(value):

for member in DeploymentResourcesDesiredStatus:

return member

raise ValueError(

f"Unknown value '{value}' for enum {DeploymentResourcesDesiredStatus.__name__}"

)</div>

</div>

class DeploymentResourcesStatus(Enum):

"""

The desired status of deployment resources of the pipeline.

"""

STOPPED = 0

PROVISIONING = 1

PROVISIONED = 2

STOPPING = 3

@staticmethod

def from_str(value):

for member in DeploymentResourcesStatus:

return member

raise ValueError(

f"Unknown value '{value}' for enum {DeploymentResourcesStatus.__name__}"

)</div>

</div>

class DeploymentRuntimeDesiredStatus(Enum):

"""

Deployment runtime desired status of the pipeline.

"""

UNAVAILABLE = 0

STANDBY = 1

PAUSED = 2

RUNNING = 3

SUSPENDED = 4

@staticmethod

def from_str(value):

for member in DeploymentRuntimeDesiredStatus:

return member

raise ValueError(

f"Unknown value '{value}' for enum {DeploymentRuntimeDesiredStatus.__name__}"

)</div>

</div>

class DeploymentRuntimeStatus(Enum):

"""

Deployment runtime status of the pipeline.

"""

UNAVAILABLE = 0

STANDBY = 1

AWAITINGAPPROVAL = 2

INITIALIZING = 3

BOOTSTRAPPING = 4

REPLAYING = 5

PAUSED = 6

RUNNING = 7

SUSPENDED = 8

@staticmethod

def from_str(value):

for member in DeploymentRuntimeStatus:

return member

raise ValueError(

f"Unknown value '{value}' for enum {DeploymentRuntimeStatus.__name__}"

)</div>

</div>

class PipelineStatus(Enum):

"""

Represents the state that this pipeline is currently in.

"""

NOT_FOUND = 0

STOPPED = 1

PROVISIONING = 2

UNAVAILABLE = 3

STANDBY = 4

AWAITINGAPPROVAL = 5

INITIALIZING = 6

BOOTSTRAPPING = 7

REPLAYING = 8

PAUSED = 9

RUNNING = 10

SUSPENDED = 11

STOPPING = 12

@staticmethod

def from_str(value):

for member in PipelineStatus:

return member

raise ValueError(f"Unknown value '{value}' for enum {PipelineStatus.__name__}")</div>

def __eq__(self, other):

return self.value == other.value</div>

class TransactionStatus(Enum):

"""

Represents the transaction handling status of a pipeline.

"""

NoTransaction = 1

"""There is currently no active transaction."""

TransactionInProgress = 2

"""There is an active transaction in progress."""

CommitInProgress = 3

"""A commit is currently in progress."""

@staticmethod

def from_str(value):

for member in TransactionStatus:

return member

raise ValueError(

f"Unknown value '{value}' for enum {TransactionStatus.__name__}"

)</div>

class ProgramStatus(Enum):

Pending = 1

CompilingSql = 2

SqlCompiled = 3

CompilingRust = 4

Success = 5

SqlError = 6

RustError = 7

SystemError = 8

def __init__(self, value):

self.error: Optional[dict] = None

self._value_ = value</div>

@staticmethod

def from_value(value):

error = None

if isinstance(value, dict):

error = value

value = list(value.keys())[0]

for member in ProgramStatus:

member.error = error

return member

raise ValueError(f"Unknown value '{value}' for enum {ProgramStatus.__name__}")</div>

def __str__(self):

return self.name + (f": ({self.error})" if self.error else "")

def get_error(self) -> Optional[dict]:

"""

Returns the compilation error, if any.

"""

return self.error</div>

</div>

class CheckpointStatus(Enum):

Success = 1

Failure = 2

InProgress = 3

Unknown = 4

self.error: Optional[str] = None

self._value_ = value</div>

"""

Returns the error, if any.

"""

return self.error</div>

</div>

class StorageStatus(Enum):

"""

Represents the current storage usage status of the pipeline.

"""

CLEARED = 0

"""

The pipeline has not been started before, or the user has cleared storage.

In this state, the pipeline has no storage resources bound to it.

"""

INUSE = 1

"""

The pipeline was (attempted to be) started before, transitioning from `STOPPED`

to `PROVISIONING`, which caused the storage status to become `INUSE`.

Being in the `INUSE` state restricts certain edits while the pipeline is `STOPPED`.

The pipeline remains in this state until the user invokes `/clear`, transitioning

it to `CLEARING`.

"""

CLEARING = 2

"""

The pipeline is in the process of becoming unbound from its storage resources.

If storage resources are configured to be deleted upon clearing, their deletion

occurs before transitioning to `CLEARED`. Otherwise, no actual work is required,

and the transition happens immediately.

If storage is not deleted during clearing, the responsibility to manage or delete

those resources lies with the user.

"""

@staticmethod

def from_str(value):

for member in StorageStatus:

return member

raise ValueError(f"Unknown value '{value}' for enum {StorageStatus.__name__}")</div>

class FaultToleranceModel(Enum):

"""

The fault tolerance model.

"""

AtLeastOnce = 1

"""

Each record is output at least once. Crashes may duplicate output, but

no input or output is dropped.

"""

ExactlyOnce = 2

"""

Each record is output exactly once. Crashes do not drop or duplicate

input or output.

"""

def __str__(self) -> str:

match self:

case FaultToleranceModel.AtLeastOnce:

return "at_least_once"

case FaultToleranceModel.ExactlyOnce:

return "exactly_once"

@staticmethod

def from_str(value):

for member in FaultToleranceModel:

if str(member) == value.lower():

return member

raise ValueError(

f"Unknown value '{value}' for enum {FaultToleranceModel.__name__}"

)</div>

</div>

class PipelineFieldSelector(Enum):

ALL = "all"

"""Select all fields of a pipeline."""

STATUS = "status"

"""Select only the fields required to know the status of a pipeline."""</div>

class BootstrapPolicy(Enum):

AWAIT_APPROVAL = "await_approval"

ALLOW = "allow"

REJECT = "reject"

@staticmethod

def from_str(value):

for member in BootstrapPolicy:

return member

raise ValueError(f"Unknown value '{value}' for enum {BootstrapPolicy.__name__}")</div>

</div>

class CompletionTokenStatus(Enum):

COMPLETE = "complete"

"""

Feldera has completed processing all inputs represented by this token.

"""

IN_PROGRESS = "inprogress"

"""

Feldera is still processing the inputs represented by this token.

"""</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

enums.html

Latest commit

History

enums.html

File metadata and controls