Skip to content

Commit 289bded

Browse files
fern-api[bot]fern-api[bot]
authored
SDK regeneration
1 parent 62f524f commit 289bded

22 files changed

+1373
-4
lines changed

‎reference.md‎

Lines changed: 224 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5419,6 +5419,230 @@ client.workspaces.delete(
54195419
</dl>
54205420

54215421

5422+
</dd>
5423+
</dl>
5424+
</details>
5425+
5426+
## Events
5427+
<details><summary><code>client.events.<a href="src/truefoundry_sdk/events/client.py">get</a>(...)</code></summary>
5428+
<dl>
5429+
<dd>
5430+
5431+
#### 📝 Description
5432+
5433+
<dl>
5434+
<dd>
5435+
5436+
<dl>
5437+
<dd>
5438+
5439+
Get Events for Pod, Job Run, Application. The events are sourced from Kubernetes as well as events captured by truefoundry. Optional query parameters include startTs, endTs for filtering.
5440+
</dd>
5441+
</dl>
5442+
</dd>
5443+
</dl>
5444+
5445+
#### 🔌 Usage
5446+
5447+
<dl>
5448+
<dd>
5449+
5450+
<dl>
5451+
<dd>
5452+
5453+
```python
5454+
from truefoundry_sdk import TrueFoundry
5455+
5456+
client = TrueFoundry(
5457+
api_key="YOUR_API_KEY",
5458+
base_url="https://yourhost.com/path/to/api",
5459+
)
5460+
client.events.get(
5461+
start_ts="startTs",
5462+
end_ts="endTs",
5463+
application_id="applicationId",
5464+
application_fqn="applicationFqn",
5465+
job_run_name="jobRunName",
5466+
)
5467+
5468+
```
5469+
</dd>
5470+
</dl>
5471+
</dd>
5472+
</dl>
5473+
5474+
#### ⚙️ Parameters
5475+
5476+
<dl>
5477+
<dd>
5478+
5479+
<dl>
5480+
<dd>
5481+
5482+
**start_ts:** `typing.Optional[str]` — Start timestamp (ISO format) for querying events
5483+
5484+
</dd>
5485+
</dl>
5486+
5487+
<dl>
5488+
<dd>
5489+
5490+
**end_ts:** `typing.Optional[str]` — End timestamp (ISO format) for querying events
5491+
5492+
</dd>
5493+
</dl>
5494+
5495+
<dl>
5496+
<dd>
5497+
5498+
**application_id:** `typing.Optional[str]` — Application ID
5499+
5500+
</dd>
5501+
</dl>
5502+
5503+
<dl>
5504+
<dd>
5505+
5506+
**application_fqn:** `typing.Optional[str]` — Application FQN
5507+
5508+
</dd>
5509+
</dl>
5510+
5511+
<dl>
5512+
<dd>
5513+
5514+
**pod_names:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Name of the pods
5515+
5516+
</dd>
5517+
</dl>
5518+
5519+
<dl>
5520+
<dd>
5521+
5522+
**job_run_name:** `typing.Optional[str]` — Job run name
5523+
5524+
</dd>
5525+
</dl>
5526+
5527+
<dl>
5528+
<dd>
5529+
5530+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
5531+
5532+
</dd>
5533+
</dl>
5534+
</dd>
5535+
</dl>
5536+
5537+
5538+
</dd>
5539+
</dl>
5540+
</details>
5541+
5542+
## Alerts
5543+
<details><summary><code>client.alerts.<a href="src/truefoundry_sdk/alerts/client.py">list</a>(...)</code></summary>
5544+
<dl>
5545+
<dd>
5546+
5547+
#### 📝 Description
5548+
5549+
<dl>
5550+
<dd>
5551+
5552+
<dl>
5553+
<dd>
5554+
5555+
Get alerts for a given application or cluster filtered by start and end timestamp
5556+
</dd>
5557+
</dl>
5558+
</dd>
5559+
</dl>
5560+
5561+
#### 🔌 Usage
5562+
5563+
<dl>
5564+
<dd>
5565+
5566+
<dl>
5567+
<dd>
5568+
5569+
```python
5570+
from truefoundry_sdk import AlertStatus, TrueFoundry
5571+
5572+
client = TrueFoundry(
5573+
api_key="YOUR_API_KEY",
5574+
base_url="https://yourhost.com/path/to/api",
5575+
)
5576+
client.alerts.list(
5577+
start_ts="startTs",
5578+
end_ts="endTs",
5579+
cluster_id="clusterId",
5580+
application_id="applicationId",
5581+
alert_status=AlertStatus.FIRING,
5582+
)
5583+
5584+
```
5585+
</dd>
5586+
</dl>
5587+
</dd>
5588+
</dl>
5589+
5590+
#### ⚙️ Parameters
5591+
5592+
<dl>
5593+
<dd>
5594+
5595+
<dl>
5596+
<dd>
5597+
5598+
**start_ts:** `typing.Optional[str]` — Start timestamp (ISO format) for querying events
5599+
5600+
</dd>
5601+
</dl>
5602+
5603+
<dl>
5604+
<dd>
5605+
5606+
**end_ts:** `typing.Optional[str]` — End timestamp (ISO format) for querying events
5607+
5608+
</dd>
5609+
</dl>
5610+
5611+
<dl>
5612+
<dd>
5613+
5614+
**cluster_id:** `typing.Optional[str]` — Cluster id
5615+
5616+
</dd>
5617+
</dl>
5618+
5619+
<dl>
5620+
<dd>
5621+
5622+
**application_id:** `typing.Optional[str]` — Application id
5623+
5624+
</dd>
5625+
</dl>
5626+
5627+
<dl>
5628+
<dd>
5629+
5630+
**alert_status:** `typing.Optional[AlertStatus]` — Alert status
5631+
5632+
</dd>
5633+
</dl>
5634+
5635+
<dl>
5636+
<dd>
5637+
5638+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
5639+
5640+
</dd>
5641+
</dl>
5642+
</dd>
5643+
</dl>
5644+
5645+
54225646
</dd>
54235647
</dl>
54245648
</details>

0 commit comments

Comments
 (0)