circuit_group_assignment.py

"""
CircuitGroupAssignment entity examples for the Diode Python SDK.

This module demonstrates three patterns for ingesting CircuitGroupAssignment entities:
- circuit_group_assignment_minimal: Required fields only
- circuit_group_assignment_extended: Common optional fields
- circuit_group_assignment_explicit: Fully nested objects with all fields
"""

from netboxlabs.diode.sdk import DiodeClient
from netboxlabs.diode.sdk.ingester import (
    Circuit,
    CircuitGroup,
    CircuitGroupAssignment,
    CircuitType,
    Entity,
    Provider,
    ProviderNetwork,
    Tag,
    VirtualCircuit,
    VirtualCircuitType,
)

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


def main():
    """Main execution - demonstrates ingesting a CircuitGroupAssignment 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:
        circuit_group_assignment = circuit_group_assignment_minimal()
        # circuit_group_assignment = circuit_group_assignment_extended()
        # circuit_group_assignment = circuit_group_assignment_explicit()

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


def circuit_group_assignment_minimal() -> CircuitGroupAssignment:
    """Create a CircuitGroupAssignment with only required fields using flat strings."""
    return CircuitGroupAssignment(
        group="Example Group",  # flat string -> CircuitGroup
        metadata={"source": "example"},
    )


def circuit_group_assignment_extended() -> CircuitGroupAssignment:
    """Create a CircuitGroupAssignment with common optional fields."""
    return CircuitGroupAssignment(
        group="Example Group",
        metadata={"source": "example", "custom_key": "custom_value"},
        priority="inactive",
    )


def circuit_group_assignment_explicit() -> CircuitGroupAssignment:
    """Create a CircuitGroupAssignment with fully nested objects and all common fields."""
    return CircuitGroupAssignment(
        group=CircuitGroup(
            name="Example Name", slug="example-slug", metadata={"source": "example"}
        ),
        metadata={
            "source": "example",
            "custom_key": "custom_value",
            "collected_at": "2024-01-15T10:30:00Z",
        },
        priority="inactive",
        # Polymorphic 'member' — choose ONE of these mutually exclusive variants:
        member_circuit=Circuit(
            cid="CID-001",
            provider=Provider(
                name="Example Name", slug="example-slug", metadata={"source": "example"}
            ),
            type=CircuitType(
                name="Example Name",
                slug="example-slug",
                color="0000ff",
                metadata={"source": "example"},
            ),
            status="active",
            metadata={"source": "example"},
        ),
        # member_virtual_circuit=VirtualCircuit(cid="CID-001", provider_network=ProviderNetwork(provider=Provider(name="Example Name", slug="example-slug", metadata={"source": "example"}), name="Example Name", metadata={"source": "example"}), type=VirtualCircuitType(name="Example Name", slug="example-slug", color="0000ff", metadata={"source": "example"}), status="active", metadata={"source": "example"}),
        tags=[Tag(name="production")],
    )


if __name__ == "__main__":
    main()