Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -522,6 +522,10 @@ These attributes are added alongside standard OTLP resource attributes (`service
* Contact Assignment
* Contact Group
* Contact Role
* Cooling Feed
* Cooling Intake
* Cooling Outflow
* Cooling Source
* Custom Field
* Custom Field Choice Set
* Custom Link
Expand Down Expand Up @@ -551,6 +555,7 @@ These attributes are added alongside standard OTLP resource attributes (`service
* Manufacturer
* Module
* Module Bay
* Module Bay Type
* Module Type
* Module Type Profile
* Owner
Expand Down
9 changes: 7 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Diode Python SDK - Entity Examples

Source: NetBox v4.6.0
Generated: 2026-07-03 00:59:24Z
Source: NetBox v4.7.0
Generated: 2026-09-02 20:52:39Z

## Prerequisites

Expand Down Expand Up @@ -127,7 +127,12 @@ Switch between patterns by uncommenting the desired function call in `main()`.
### Other

- [CableBundle](examples/cable_bundle.py)
- [CoolingFeed](examples/cooling_feed.py)
- [CoolingIntake](examples/cooling_intake.py)
- [CoolingOutflow](examples/cooling_outflow.py)
- [CoolingSource](examples/cooling_source.py)
- [DeviceConfig](examples/device_config.py)
- [ModuleBayType](examples/module_bay_type.py)
- [RackGroup](examples/rack_group.py)
- [ScriptModule](examples/script_module.py)
- [VirtualMachineType](examples/virtual_machine_type.py)
Expand Down
128 changes: 128 additions & 0 deletions docs/examples/cooling_feed.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
"""
CoolingFeed entity examples for the Diode Python SDK.

This module demonstrates three patterns for ingesting CoolingFeed entities:
- cooling_feed_minimal: Required fields only
- cooling_feed_extended: Common optional fields
- cooling_feed_explicit: Fully nested objects with all fields
"""

from netboxlabs.diode.sdk import DiodeClient
from netboxlabs.diode.sdk.ingester import (
CoolingFeed,
CoolingSource,
Entity,
Owner,
OwnerGroup,
Rack,
Site,
Tag,
Tenant,
)

TARGET = "grpc://localhost:8080/diode"
APP_NAME = "cooling_feed-example"
APP_VERSION = "1.0.0"
CLIENT_ID = "diode"
CLIENT_SECRET = "changeme"


def main():
"""Main execution - demonstrates ingesting a CoolingFeed entity."""
with DiodeClient(
target=TARGET,
app_name=APP_NAME,
app_version=APP_VERSION,
client_id=CLIENT_ID,
client_secret=CLIENT_SECRET,
) as client:
# Choose one of the three patterns:
cooling_feed = cooling_feed_minimal()
# cooling_feed = cooling_feed_extended()
# cooling_feed = cooling_feed_explicit()

response = client.ingest(entities=[Entity(cooling_feed=cooling_feed)])
if response.errors:
print(f"Errors: {response.errors}")
else:
print("CoolingFeed ingested successfully")


def cooling_feed_minimal() -> CoolingFeed:
"""Create a CoolingFeed with only required fields using flat strings."""
return CoolingFeed(
cooling_source="Example Cooling Source", # flat string -> CoolingSource
name="Example Name",
metadata={"source": "example"},
)


def cooling_feed_extended() -> CoolingFeed:
"""Create a CoolingFeed with common optional fields."""
return CoolingFeed(
cooling_source="Example Cooling Source",
name="Example Name",
metadata={"source": "example", "custom_key": "custom_value"},
status="active",
description="Example description",
rack="Example Rack",
cooling_capacity=1.0,
max_flow=1.0,
max_flow_unit="gpm",
tenant="Example Tenant",
comments="Example comments",
)


def cooling_feed_explicit() -> CoolingFeed:
"""Create a CoolingFeed with fully nested objects and all common fields."""
return CoolingFeed(
cooling_source=CoolingSource(
site=Site(
name="Example Name",
slug="example-slug",
status="active",
metadata={"source": "example"},
),
name="Example Name",
type="chiller",
status="active",
metadata={"source": "example"},
),
name="Example Name",
metadata={
"source": "example",
"custom_key": "custom_value",
"collected_at": "2024-01-15T10:30:00Z",
},
status="active",
description="Example description",
comments="Example comments",
cooling_capacity=1.0,
max_flow=1.0,
max_flow_unit="gpm",
rack=Rack(
name="Example Name",
site=Site(
name="Example Name",
slug="example-slug",
status="active",
metadata={"source": "example"},
),
status="active",
metadata={"source": "example"},
),
tenant=Tenant(
name="Example Name", slug="example-slug", metadata={"source": "example"}
),
owner=Owner(
name="Example Name",
group=OwnerGroup(name="Example Name", metadata={"source": "example"}),
metadata={"source": "example"},
),
tags=[Tag(name="production")],
)


if __name__ == "__main__":
main()
Loading
Loading