Skip to content

platformassets_pb2

frequenz.api.platformassets.v1alpha1.platformassets_pb2 ¤

Generated protocol buffer code.

Classes¤

frequenz.api.platformassets.v1alpha1.platformassets_pb2.GetGridpoolRequest ¤

Bases: Message

Request message for retrieving metadata for a specific gridpool.

Attributes¤
gridpool_id instance-attribute ¤
gridpool_id: int

The unique identifier of the gridpool for which to fetch details.

frequenz.api.platformassets.v1alpha1.platformassets_pb2.GetGridpoolResponse ¤

Bases: Message

Response message containing metadata for a specific gridpool.

Functions¤
gridpool ¤
gridpool() -> Gridpool

Details of the requested gridpool.

microgrids ¤
microgrids() -> RepeatedCompositeFieldContainer[Microgrid]

Microgrids belonging to the requested gridpool.

frequenz.api.platformassets.v1alpha1.platformassets_pb2.GetMicrogridRequest ¤

Bases: Message

Request message for retrieving metadata for a specific microgrid.

Attributes¤
microgrid_id instance-attribute ¤
microgrid_id: int

The unique identifier of the microgrid for which to fetch details.

frequenz.api.platformassets.v1alpha1.platformassets_pb2.GetMicrogridResponse ¤

Bases: Message

Response message containing metadata for a specific microgrid.

Functions¤
microgrid ¤
microgrid() -> Microgrid

Details of the requested microgrid.

frequenz.api.platformassets.v1alpha1.platformassets_pb2.ListMicrogridElectricalComponentConnectionsRequest ¤

Bases: Message

Request message for listing directed electrical connections between components in a microgrid.

Connections define the directed electrical component graph of a microgrid. The source component is closer to the grid-connection point or logical root, while the destination component is further downstream.

Component Graph

A component graph in the context of a microgrid refers to a directed graph where the nodes represent electrical components (like generators, batteries, or loads) and the edges represent electrical connections between them. The edges are directional, pointing away from the grid-connection point (or the root point for island microgrids). This means that for each edge, the source component is towards the grid connection point, and the destination component is pointing towards an underlying component. This graph provides a structured view of how electrical energy flows within the microgrid.

Attributes¤
microgrid_id instance-attribute ¤
microgrid_id: int

The unique identifier of the microgrid whose electrical component connections should be listed.

Functions¤
filter ¤
filter() -> (
    Global___MicrogridElectricalComponentConnectionsFilter
)

Optional filtering criteria for narrowing the returned connections.

If omitted, all known electrical connections in the microgrid are returned.

frequenz.api.platformassets.v1alpha1.platformassets_pb2.ListMicrogridElectricalComponentConnectionsResponse ¤

Bases: Message

Response message containing directed electrical connections for a microgrid.

The response contains all connections matching the requested filters. If no connection matches the filters, connections is empty.

Attributes¤
microgrid_id instance-attribute ¤
microgrid_id: int

The unique identifier of the microgrid the returned connections belong to.

Functions¤
connections ¤
connections() -> (
    RepeatedCompositeFieldContainer[
        ElectricalComponentConnection
    ]
)

Electrical component connections matching the request filters.

frequenz.api.platformassets.v1alpha1.platformassets_pb2.ListMicrogridElectricalComponentsRequest ¤

Bases: Message

Request parameters for the RPC ListMicrogridElectricalComponents.

Attributes¤
microgrid_id instance-attribute ¤
microgrid_id: int

Mandatory field. The ID of the microgrid for which components are to be listed.

Functions¤
filter ¤
filter() -> Global___MicrogridElectricalComponentsFilter

Optional. Filtering criteria for narrowing the returned components.

If omitted, all electrical components in the microgrid are returned.

frequenz.api.platformassets.v1alpha1.platformassets_pb2.ListMicrogridElectricalComponentsResponse ¤

Bases: Message

Response message containing electrical components for a microgrid.

Attributes¤
microgrid_id instance-attribute ¤
microgrid_id: int

The unique identifier of the microgrid the returned components belong to.

Functions¤
components ¤
components() -> (
    RepeatedCompositeFieldContainer[ElectricalComponent]
)

Electrical components matching the request filters.

frequenz.api.platformassets.v1alpha1.platformassets_pb2.ListMicrogridsRequest ¤

Bases: Message

Request message for listing all visible microgrids.

Source code in py/frequenz/api/platformassets/v1alpha1/platformassets_pb2.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
46
_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'frequenz.api.platformassets.v1alpha1.platformassets_pb2', _globals)
if not _descriptor._USE_C_DESCRIPTORS:
  DESCRIPTOR._loaded_options = None
  _globals['_LISTMICROGRIDSREQUEST']._serialized_start=299
  _globals['_LISTMICROGRIDSREQUEST']._serialized_end=322
  _globals['_LISTMICROGRIDSRESPONSE']._serialized_start=324
  _globals['_LISTMICROGRIDSRESPONSE']._serialized_end=419
  _globals['_GETGRIDPOOLREQUEST']._serialized_start=421
  _globals['_GETGRIDPOOLREQUEST']._serialized_end=462
  _globals['_GETGRIDPOOLRESPONSE']._serialized_start=465
  _globals['_GETGRIDPOOLRESPONSE']._serialized_end=624
  _globals['_MICROGRIDELECTRICALCOMPONENTCONNECTIONSFILTER']._serialized_start=626
  _globals['_MICROGRIDELECTRICALCOMPONENTCONNECTIONSFILTER']._serialized_end=738

frequenz.api.platformassets.v1alpha1.platformassets_pb2.ListMicrogridsResponse ¤

Bases: Message

Response message containing all visible microgrids.

Source code in py/frequenz/api/platformassets/v1alpha1/platformassets_pb2.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
  _globals['_GETMICROGRIDREQUEST']._serialized_end=957
  _globals['_GETMICROGRIDRESPONSE']._serialized_start=959
  _globals['_GETMICROGRIDRESPONSE']._serialized_end=1051
  _globals['_LISTMICROGRIDELECTRICALCOMPONENTSREQUEST']._serialized_start=1054
  _globals['_LISTMICROGRIDELECTRICALCOMPONENTSREQUEST']._serialized_end=1209
  _globals['_LISTMICROGRIDELECTRICALCOMPONENTSRESPONSE']._serialized_start=1212
  _globals['_LISTMICROGRIDELECTRICALCOMPONENTSRESPONSE']._serialized_end=1380
  _globals['_LISTMICROGRIDELECTRICALCOMPONENTCONNECTIONSREQUEST']._serialized_start=1383
  _globals['_LISTMICROGRIDELECTRICALCOMPONENTCONNECTIONSREQUEST']._serialized_end=1558
  _globals['_LISTMICROGRIDELECTRICALCOMPONENTCONNECTIONSRESPONSE']._serialized_start=1561
  _globals['_LISTMICROGRIDELECTRICALCOMPONENTCONNECTIONSRESPONSE']._serialized_end=1750
  _globals['_PLATFORMASSETSSERVICE']._serialized_start=1753
  _globals['_PLATFORMASSETSSERVICE']._serialized_end=2615
# @@protoc_insertion_point(module_scope)
Functions¤
microgrids ¤
microgrids() -> RepeatedCompositeFieldContainer[Microgrid]

Microgrids visible to the caller.

Source code in py/frequenz/api/platformassets/v1alpha1/platformassets_pb2.py 
57
58
59
_globals['_LISTMICROGRIDELECTRICALCOMPONENTCONNECTIONSREQUEST']._serialized_start=1383
_globals['_LISTMICROGRIDELECTRICALCOMPONENTCONNECTIONSREQUEST']._serialized_end=1558
_globals['_LISTMICROGRIDELECTRICALCOMPONENTCONNECTIONSRESPONSE']._serialized_start=1561

frequenz.api.platformassets.v1alpha1.platformassets_pb2.MicrogridElectricalComponentConnectionsFilter ¤

Bases: Message

Filters for selecting electrical component connections in a microgrid.

A connection must match all specified filter fields to be included in the response.

Filter Semantics

Each repeated field is evaluated using logical OR.

Different filter fields are combined using logical AND.

If no filters are provided, all known electrical connections in the microgrid are returned.

Functions¤
destination_component_ids ¤
destination_component_ids() -> (
    RepeatedScalarFieldContainer[int]
)

Optional. Return only connections whose destination component ID is included in this list.

If empty, connections to any destination component are returned.

source_component_ids ¤
source_component_ids() -> RepeatedScalarFieldContainer[int]

Optional. Return only connections whose source component ID is included in this list.

If empty, connections from any source component are returned.

frequenz.api.platformassets.v1alpha1.platformassets_pb2.MicrogridElectricalComponentsFilter ¤

Bases: Message

Filters for selecting electrical components in a microgrid.

An electrical component must match all specified filter fields to be included in the response.

Filter Semantics

Each repeated field is evaluated using logical OR.

Different filter fields are combined using logical AND.

If no filters are provided, all electrical components in the microgrid are returned.

Functions¤
categories ¤
categories() -> RepeatedScalarFieldContainer[ValueType]

Optional. Return only components whose categories are included in this list.

If empty, no category filtering is applied.

component_ids ¤
component_ids() -> RepeatedScalarFieldContainer[int]

Optional. Return only components whose IDs are included in this list.

If empty, no component-ID filtering is applied.