Documentation Home Page OPAL-RT Dashboard Home Page
Pour la documentation en FRANÇAIS, utilisez l'outil de traduction de votre navigateur Chrome, Edge ou Safari. Voir un exemple.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Current »


class opalone._internal.ports.Port(port_id, model_id=None, port_type=None)

Bases: Resource

A port is a part of a Block which allows interconnecting multiple blocks together.

Parameters:
  • port_id (str) – The ID of the port.

  • model_id (str) – The ID of the model containing this port.

  • port_type (str) – The type of port.

delete()

Delete the current port.

This function does nothing for now, since a port deletion is not supported. To delete a port, the user must delete the Block owning the port.

to_json(fields, values)

Convert this resource to a serialized JSON representation.

Parameters:
  • fields (tuple[str] | list[str]) – Fields to include.

  • values (tuple[object] | list[object]) – The value of each field

Returns:

The serialized JSON representation.

Return type:

str

property id: str

The ID of the resource.

This property is read-only, it cannot be modified.

  • No labels