Skip to content

platformassets_pb2_grpc

frequenz.api.platformassets.v1alpha1.platformassets_pb2_grpc ¤

Client and server classes corresponding to protobuf-defined services.

Classes¤

frequenz.api.platformassets.v1alpha1.platformassets_pb2_grpc.PlatformAssetsService ¤

Bases: object

PlatformAssetsService provides read-only access to platform asset and market-topology metadata.

The service exposes a platform-wide read model for resolving stable identifiers, asset inventories, and relationships managed by the Frequenz platform. This includes Gridpools, microgrids, Market Locations, market-topology relations, Gridpool energy schedules, electrical component inventories, sensor inventories, and the directed electrical component graph within a microgrid.

Gridpools represent virtual balancing-group structures used for market interactions, such as electricity trading, scheduled energy exchange, and flexibility or ancillary-service participation.

Market-topology relations describe how Gridpools, Microgrids, and Market Locations are connected. These relations define which market-facing metering points and technical Microgrids participate in a Gridpool context, and can also describe Microgrid-to-Market-Location relations that exist without market participation.

Microgrid asset metadata describes the technical structure of deployed or planned microgrids, including electrical components, sensors, and the directed electrical component graph.

Authentication

All requests to PlatformAssetsService must be signed. The key identifier and signature must be included in the request metadata (gRPC metadata / HTTP headers). The signature must be computed using the HMAC-SHA256 algorithm and secret key. All requests to this service must be made over TLS (HTTPS).

Source code in py/frequenz/api/platformassets/v1alpha1/platformassets_pb2_grpc.py 
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
class PlatformAssetsService(object):
    """PlatformAssetsService provides read-only access to platform asset and
    market-topology metadata.

    The service exposes a platform-wide read model for resolving stable
    identifiers, asset inventories, and relationships managed by the Frequenz
    platform. This includes Gridpools, microgrids, Market Locations,
    market-topology relations, Gridpool energy schedules, electrical component
    inventories, sensor inventories, and the directed electrical component graph
    within a microgrid.

    Gridpools represent virtual balancing-group structures used for market
    interactions, such as electricity trading, scheduled energy exchange, and
    flexibility or ancillary-service participation.

    Market-topology relations describe how Gridpools, Microgrids, and Market
    Locations are connected. These relations define which market-facing metering
    points and technical Microgrids participate in a Gridpool context, and can
    also describe Microgrid-to-Market-Location relations that exist without
    market participation.

    Microgrid asset metadata describes the technical structure of deployed or
    planned microgrids, including electrical components, sensors, and the
    directed electrical component graph.

    !!! important "Authentication"
    All requests to PlatformAssetsService must be signed. The key identifier
    and signature must be included in the request metadata (gRPC metadata /
    HTTP headers). The signature must be computed using the HMAC-SHA256
    algorithm and secret key. All requests to this service must be made
    over TLS (HTTPS).

    """

    @staticmethod
    def ListGridpools(request,
            target,
            options=(),
            channel_credentials=None,
            call_credentials=None,
            insecure=False,
            compression=None,
            wait_for_ready=None,
            timeout=None,
            metadata=None):
        return grpc.experimental.unary_unary(
            request,
            target,
            '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListGridpools',
            frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListGridpoolsRequest.SerializeToString,
            frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListGridpoolsResponse.FromString,
            options,
            channel_credentials,
            insecure,
            call_credentials,
            compression,
            wait_for_ready,
            timeout,
            metadata,
            _registered_method=True)

    @staticmethod
    def ListGridpoolEnergySchedules(request,
            target,
            options=(),
            channel_credentials=None,
            call_credentials=None,
            insecure=False,
            compression=None,
            wait_for_ready=None,
            timeout=None,
            metadata=None):
        return grpc.experimental.unary_unary(
            request,
            target,
            '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListGridpoolEnergySchedules',
            frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListGridpoolEnergySchedulesRequest.SerializeToString,
            frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListGridpoolEnergySchedulesResponse.FromString,
            options,
            channel_credentials,
            insecure,
            call_credentials,
            compression,
            wait_for_ready,
            timeout,
            metadata,
            _registered_method=True)

    @staticmethod
    def ListMarketTopologyRelations(request,
            target,
            options=(),
            channel_credentials=None,
            call_credentials=None,
            insecure=False,
            compression=None,
            wait_for_ready=None,
            timeout=None,
            metadata=None):
        return grpc.experimental.unary_unary(
            request,
            target,
            '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListMarketTopologyRelations',
            frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMarketTopologyRelationsRequest.SerializeToString,
            frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMarketTopologyRelationsResponse.FromString,
            options,
            channel_credentials,
            insecure,
            call_credentials,
            compression,
            wait_for_ready,
            timeout,
            metadata,
            _registered_method=True)

    @staticmethod
    def GetMicrogrid(request,
            target,
            options=(),
            channel_credentials=None,
            call_credentials=None,
            insecure=False,
            compression=None,
            wait_for_ready=None,
            timeout=None,
            metadata=None):
        return grpc.experimental.unary_unary(
            request,
            target,
            '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/GetMicrogrid',
            frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.GetMicrogridRequest.SerializeToString,
            frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.GetMicrogridResponse.FromString,
            options,
            channel_credentials,
            insecure,
            call_credentials,
            compression,
            wait_for_ready,
            timeout,
            metadata,
            _registered_method=True)

    @staticmethod
    def ListMicrogrids(request,
            target,
            options=(),
            channel_credentials=None,
            call_credentials=None,
            insecure=False,
            compression=None,
            wait_for_ready=None,
            timeout=None,
            metadata=None):
        return grpc.experimental.unary_unary(
            request,
            target,
            '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListMicrogrids',
            frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridsRequest.SerializeToString,
            frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridsResponse.FromString,
            options,
            channel_credentials,
            insecure,
            call_credentials,
            compression,
            wait_for_ready,
            timeout,
            metadata,
            _registered_method=True)

    @staticmethod
    def ListMicrogridElectricalComponents(request,
            target,
            options=(),
            channel_credentials=None,
            call_credentials=None,
            insecure=False,
            compression=None,
            wait_for_ready=None,
            timeout=None,
            metadata=None):
        return grpc.experimental.unary_unary(
            request,
            target,
            '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListMicrogridElectricalComponents',
            frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridElectricalComponentsRequest.SerializeToString,
            frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridElectricalComponentsResponse.FromString,
            options,
            channel_credentials,
            insecure,
            call_credentials,
            compression,
            wait_for_ready,
            timeout,
            metadata,
            _registered_method=True)

    @staticmethod
    def ListMicrogridElectricalComponentConnections(request,
            target,
            options=(),
            channel_credentials=None,
            call_credentials=None,
            insecure=False,
            compression=None,
            wait_for_ready=None,
            timeout=None,
            metadata=None):
        return grpc.experimental.unary_unary(
            request,
            target,
            '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListMicrogridElectricalComponentConnections',
            frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridElectricalComponentConnectionsRequest.SerializeToString,
            frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridElectricalComponentConnectionsResponse.FromString,
            options,
            channel_credentials,
            insecure,
            call_credentials,
            compression,
            wait_for_ready,
            timeout,
            metadata,
            _registered_method=True)

    @staticmethod
    def ListMicrogridSensors(request,
            target,
            options=(),
            channel_credentials=None,
            call_credentials=None,
            insecure=False,
            compression=None,
            wait_for_ready=None,
            timeout=None,
            metadata=None):
        return grpc.experimental.unary_unary(
            request,
            target,
            '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListMicrogridSensors',
            frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridSensorsRequest.SerializeToString,
            frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridSensorsResponse.FromString,
            options,
            channel_credentials,
            insecure,
            call_credentials,
            compression,
            wait_for_ready,
            timeout,
            metadata,
            _registered_method=True)

frequenz.api.platformassets.v1alpha1.platformassets_pb2_grpc.PlatformAssetsServiceAsyncStub ¤

Bases: PlatformAssetsServiceStub

PlatformAssetsService provides read-only access to platform asset and market-topology metadata.

The service exposes a platform-wide read model for resolving stable identifiers, asset inventories, and relationships managed by the Frequenz platform. This includes Gridpools, microgrids, Market Locations, market-topology relations, Gridpool energy schedules, electrical component inventories, sensor inventories, and the directed electrical component graph within a microgrid.

Gridpools represent virtual balancing-group structures used for market interactions, such as electricity trading, scheduled energy exchange, and flexibility or ancillary-service participation.

Market-topology relations describe how Gridpools, Microgrids, and Market Locations are connected. These relations define which market-facing metering points and technical Microgrids participate in a Gridpool context, and can also describe Microgrid-to-Market-Location relations that exist without market participation.

Microgrid asset metadata describes the technical structure of deployed or planned microgrids, including electrical components, sensors, and the directed electrical component graph.

Authentication

All requests to PlatformAssetsService must be signed. The key identifier and signature must be included in the request metadata (gRPC metadata / HTTP headers). The signature must be computed using the HMAC-SHA256 algorithm and secret key. All requests to this service must be made over TLS (HTTPS).

Source code in py/frequenz/api/platformassets/v1alpha1/platformassets_pb2_grpc.py 
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
                '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListMicrogridElectricalComponents',
                request_serializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridElectricalComponentsRequest.SerializeToString,
                response_deserializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridElectricalComponentsResponse.FromString,
                _registered_method=True)
        self.ListMicrogridElectricalComponentConnections = channel.unary_unary(
                '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListMicrogridElectricalComponentConnections',
                request_serializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridElectricalComponentConnectionsRequest.SerializeToString,
                response_deserializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridElectricalComponentConnectionsResponse.FromString,
                _registered_method=True)
        self.ListMicrogridSensors = channel.unary_unary(
                '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListMicrogridSensors',
                request_serializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridSensorsRequest.SerializeToString,
                response_deserializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridSensorsResponse.FromString,
                _registered_method=True)


class PlatformAssetsServiceServicer(object):
    """PlatformAssetsService provides read-only access to platform asset and
    market-topology metadata.

    The service exposes a platform-wide read model for resolving stable
    identifiers, asset inventories, and relationships managed by the Frequenz
    platform. This includes Gridpools, microgrids, Market Locations,
    market-topology relations, Gridpool energy schedules, electrical component
    inventories, sensor inventories, and the directed electrical component graph
    within a microgrid.

    Gridpools represent virtual balancing-group structures used for market
    interactions, such as electricity trading, scheduled energy exchange, and
    flexibility or ancillary-service participation.

    Market-topology relations describe how Gridpools, Microgrids, and Market
    Locations are connected. These relations define which market-facing metering
    points and technical Microgrids participate in a Gridpool context, and can
    also describe Microgrid-to-Market-Location relations that exist without
    market participation.

    Microgrid asset metadata describes the technical structure of deployed or
    planned microgrids, including electrical components, sensors, and the
    directed electrical component graph.

    !!! important "Authentication"
    All requests to PlatformAssetsService must be signed. The key identifier
    and signature must be included in the request metadata (gRPC metadata /
    HTTP headers). The signature must be computed using the HMAC-SHA256
    algorithm and secret key. All requests to this service must be made
    over TLS (HTTPS).

    """

    def ListGridpools(self, request, context):
        """Lists Gridpools within the current enterprise scope.
        """
Attributes¤
GetMicrogrid instance-attribute ¤
GetMicrogrid: UnaryUnaryMultiCallable[
    GetMicrogridRequest, GetMicrogridResponse
]

Returns metadata for a specific microgrid.

ListGridpoolEnergySchedules instance-attribute ¤
ListGridpoolEnergySchedules: UnaryUnaryMultiCallable[
    ListGridpoolEnergySchedulesRequest,
    ListGridpoolEnergySchedulesResponse,
]

Lists energy schedules for a specific Gridpool.

ListGridpools instance-attribute ¤
ListGridpools: UnaryUnaryMultiCallable[
    ListGridpoolsRequest, ListGridpoolsResponse
]

Lists Gridpools within the current enterprise scope.

ListMarketTopologyRelations instance-attribute ¤
ListMarketTopologyRelations: UnaryUnaryMultiCallable[
    ListMarketTopologyRelationsRequest,
    ListMarketTopologyRelationsResponse,
]

Lists market-topology relations within the current enterprise scope.

ListMicrogridElectricalComponentConnections instance-attribute ¤
ListMicrogridElectricalComponentConnections: (
    UnaryUnaryMultiCallable[
        ListMicrogridElectricalComponentConnectionsRequest,
        ListMicrogridElectricalComponentConnectionsResponse,
    ]
)

Lists directed electrical connections between components in a specific microgrid.

ListMicrogridElectricalComponents instance-attribute ¤
ListMicrogridElectricalComponents: UnaryUnaryMultiCallable[
    ListMicrogridElectricalComponentsRequest,
    ListMicrogridElectricalComponentsResponse,
]

Lists electrical components for a specific microgrid.

ListMicrogridSensors instance-attribute ¤
ListMicrogridSensors: UnaryUnaryMultiCallable[
    ListMicrogridSensorsRequest,
    ListMicrogridSensorsResponse,
]

Lists sensors for a specific microgrid.

ListMicrogrids instance-attribute ¤
ListMicrogrids: UnaryUnaryMultiCallable[
    ListMicrogridsRequest, ListMicrogridsResponse
]

Lists microgrids within the current enterprise scope.

frequenz.api.platformassets.v1alpha1.platformassets_pb2_grpc.PlatformAssetsServiceServicer ¤

Bases: object

PlatformAssetsService provides read-only access to platform asset and market-topology metadata.

The service exposes a platform-wide read model for resolving stable identifiers, asset inventories, and relationships managed by the Frequenz platform. This includes Gridpools, microgrids, Market Locations, market-topology relations, Gridpool energy schedules, electrical component inventories, sensor inventories, and the directed electrical component graph within a microgrid.

Gridpools represent virtual balancing-group structures used for market interactions, such as electricity trading, scheduled energy exchange, and flexibility or ancillary-service participation.

Market-topology relations describe how Gridpools, Microgrids, and Market Locations are connected. These relations define which market-facing metering points and technical Microgrids participate in a Gridpool context, and can also describe Microgrid-to-Market-Location relations that exist without market participation.

Microgrid asset metadata describes the technical structure of deployed or planned microgrids, including electrical components, sensors, and the directed electrical component graph.

Authentication

All requests to PlatformAssetsService must be signed. The key identifier and signature must be included in the request metadata (gRPC metadata / HTTP headers). The signature must be computed using the HMAC-SHA256 algorithm and secret key. All requests to this service must be made over TLS (HTTPS).

Source code in py/frequenz/api/platformassets/v1alpha1/platformassets_pb2_grpc.py 
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
class PlatformAssetsServiceServicer(object):
    """PlatformAssetsService provides read-only access to platform asset and
    market-topology metadata.

    The service exposes a platform-wide read model for resolving stable
    identifiers, asset inventories, and relationships managed by the Frequenz
    platform. This includes Gridpools, microgrids, Market Locations,
    market-topology relations, Gridpool energy schedules, electrical component
    inventories, sensor inventories, and the directed electrical component graph
    within a microgrid.

    Gridpools represent virtual balancing-group structures used for market
    interactions, such as electricity trading, scheduled energy exchange, and
    flexibility or ancillary-service participation.

    Market-topology relations describe how Gridpools, Microgrids, and Market
    Locations are connected. These relations define which market-facing metering
    points and technical Microgrids participate in a Gridpool context, and can
    also describe Microgrid-to-Market-Location relations that exist without
    market participation.

    Microgrid asset metadata describes the technical structure of deployed or
    planned microgrids, including electrical components, sensors, and the
    directed electrical component graph.

    !!! important "Authentication"
    All requests to PlatformAssetsService must be signed. The key identifier
    and signature must be included in the request metadata (gRPC metadata /
    HTTP headers). The signature must be computed using the HMAC-SHA256
    algorithm and secret key. All requests to this service must be made
    over TLS (HTTPS).

    """

    def ListGridpools(self, request, context):
        """Lists Gridpools within the current enterprise scope.
        """
        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
        context.set_details('Method not implemented!')
        raise NotImplementedError('Method not implemented!')

    def ListGridpoolEnergySchedules(self, request, context):
        """Lists energy schedules for a specific Gridpool.
        """
        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
        context.set_details('Method not implemented!')
        raise NotImplementedError('Method not implemented!')

    def ListMarketTopologyRelations(self, request, context):
        """Lists market-topology relations within the current enterprise scope.
        """
        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
        context.set_details('Method not implemented!')
        raise NotImplementedError('Method not implemented!')

    def GetMicrogrid(self, request, context):
        """Returns metadata for a specific microgrid.
        """
        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
        context.set_details('Method not implemented!')
        raise NotImplementedError('Method not implemented!')

    def ListMicrogrids(self, request, context):
        """Lists microgrids within the current enterprise scope.
        """
        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
        context.set_details('Method not implemented!')
        raise NotImplementedError('Method not implemented!')

    def ListMicrogridElectricalComponents(self, request, context):
        """Lists electrical components for a specific microgrid.
        """
        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
        context.set_details('Method not implemented!')
        raise NotImplementedError('Method not implemented!')

    def ListMicrogridElectricalComponentConnections(self, request, context):
        """Lists directed electrical connections between components in a specific
        microgrid.
        """
        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
        context.set_details('Method not implemented!')
        raise NotImplementedError('Method not implemented!')

    def ListMicrogridSensors(self, request, context):
        """Lists sensors for a specific microgrid.
        """
        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
        context.set_details('Method not implemented!')
        raise NotImplementedError('Method not implemented!')
Functions¤
GetMicrogrid ¤
GetMicrogrid(
    request: GetMicrogridRequest, context: _ServicerContext
) -> Union[
    GetMicrogridResponse, Awaitable[GetMicrogridResponse]
]

Returns metadata for a specific microgrid.

Source code in py/frequenz/api/platformassets/v1alpha1/platformassets_pb2_grpc.py 
165
166
167
168
169
170
def GetMicrogrid(self, request, context):
    """Returns metadata for a specific microgrid.
    """
    context.set_code(grpc.StatusCode.UNIMPLEMENTED)
    context.set_details('Method not implemented!')
    raise NotImplementedError('Method not implemented!')
ListGridpoolEnergySchedules ¤
ListGridpoolEnergySchedules(
    request: ListGridpoolEnergySchedulesRequest,
    context: _ServicerContext,
) -> Union[
    ListGridpoolEnergySchedulesResponse,
    Awaitable[ListGridpoolEnergySchedulesResponse],
]

Lists energy schedules for a specific Gridpool.

Source code in py/frequenz/api/platformassets/v1alpha1/platformassets_pb2_grpc.py 
151
152
153
154
155
156
def ListGridpoolEnergySchedules(self, request, context):
    """Lists energy schedules for a specific Gridpool.
    """
    context.set_code(grpc.StatusCode.UNIMPLEMENTED)
    context.set_details('Method not implemented!')
    raise NotImplementedError('Method not implemented!')
ListGridpools ¤
ListGridpools(
    request: ListGridpoolsRequest, context: _ServicerContext
) -> Union[
    ListGridpoolsResponse, Awaitable[ListGridpoolsResponse]
]

Lists Gridpools within the current enterprise scope.

Source code in py/frequenz/api/platformassets/v1alpha1/platformassets_pb2_grpc.py 
144
145
146
147
148
149
def ListGridpools(self, request, context):
    """Lists Gridpools within the current enterprise scope.
    """
    context.set_code(grpc.StatusCode.UNIMPLEMENTED)
    context.set_details('Method not implemented!')
    raise NotImplementedError('Method not implemented!')
ListMarketTopologyRelations ¤
ListMarketTopologyRelations(
    request: ListMarketTopologyRelationsRequest,
    context: _ServicerContext,
) -> Union[
    ListMarketTopologyRelationsResponse,
    Awaitable[ListMarketTopologyRelationsResponse],
]

Lists market-topology relations within the current enterprise scope.

Source code in py/frequenz/api/platformassets/v1alpha1/platformassets_pb2_grpc.py 
158
159
160
161
162
163
def ListMarketTopologyRelations(self, request, context):
    """Lists market-topology relations within the current enterprise scope.
    """
    context.set_code(grpc.StatusCode.UNIMPLEMENTED)
    context.set_details('Method not implemented!')
    raise NotImplementedError('Method not implemented!')
ListMicrogridElectricalComponentConnections ¤
ListMicrogridElectricalComponentConnections(
    request: ListMicrogridElectricalComponentConnectionsRequest,
    context: _ServicerContext,
) -> Union[
    ListMicrogridElectricalComponentConnectionsResponse,
    Awaitable[
        ListMicrogridElectricalComponentConnectionsResponse
    ],
]

Lists directed electrical connections between components in a specific microgrid.

Source code in py/frequenz/api/platformassets/v1alpha1/platformassets_pb2_grpc.py 
186
187
188
189
190
191
192
def ListMicrogridElectricalComponentConnections(self, request, context):
    """Lists directed electrical connections between components in a specific
    microgrid.
    """
    context.set_code(grpc.StatusCode.UNIMPLEMENTED)
    context.set_details('Method not implemented!')
    raise NotImplementedError('Method not implemented!')
ListMicrogridElectricalComponents ¤
ListMicrogridElectricalComponents(
    request: ListMicrogridElectricalComponentsRequest,
    context: _ServicerContext,
) -> Union[
    ListMicrogridElectricalComponentsResponse,
    Awaitable[ListMicrogridElectricalComponentsResponse],
]

Lists electrical components for a specific microgrid.

Source code in py/frequenz/api/platformassets/v1alpha1/platformassets_pb2_grpc.py 
179
180
181
182
183
184
def ListMicrogridElectricalComponents(self, request, context):
    """Lists electrical components for a specific microgrid.
    """
    context.set_code(grpc.StatusCode.UNIMPLEMENTED)
    context.set_details('Method not implemented!')
    raise NotImplementedError('Method not implemented!')
ListMicrogridSensors ¤
ListMicrogridSensors(
    request: ListMicrogridSensorsRequest,
    context: _ServicerContext,
) -> Union[
    ListMicrogridSensorsResponse,
    Awaitable[ListMicrogridSensorsResponse],
]

Lists sensors for a specific microgrid.

Source code in py/frequenz/api/platformassets/v1alpha1/platformassets_pb2_grpc.py 
194
195
196
197
198
199
def ListMicrogridSensors(self, request, context):
    """Lists sensors for a specific microgrid.
    """
    context.set_code(grpc.StatusCode.UNIMPLEMENTED)
    context.set_details('Method not implemented!')
    raise NotImplementedError('Method not implemented!')
ListMicrogrids ¤
ListMicrogrids(
    request: ListMicrogridsRequest,
    context: _ServicerContext,
) -> Union[
    ListMicrogridsResponse,
    Awaitable[ListMicrogridsResponse],
]

Lists microgrids within the current enterprise scope.

Source code in py/frequenz/api/platformassets/v1alpha1/platformassets_pb2_grpc.py 
172
173
174
175
176
177
def ListMicrogrids(self, request, context):
    """Lists microgrids within the current enterprise scope.
    """
    context.set_code(grpc.StatusCode.UNIMPLEMENTED)
    context.set_details('Method not implemented!')
    raise NotImplementedError('Method not implemented!')

frequenz.api.platformassets.v1alpha1.platformassets_pb2_grpc.PlatformAssetsServiceStub ¤

Bases: object

PlatformAssetsService provides read-only access to platform asset and market-topology metadata.

The service exposes a platform-wide read model for resolving stable identifiers, asset inventories, and relationships managed by the Frequenz platform. This includes Gridpools, microgrids, Market Locations, market-topology relations, Gridpool energy schedules, electrical component inventories, sensor inventories, and the directed electrical component graph within a microgrid.

Gridpools represent virtual balancing-group structures used for market interactions, such as electricity trading, scheduled energy exchange, and flexibility or ancillary-service participation.

Market-topology relations describe how Gridpools, Microgrids, and Market Locations are connected. These relations define which market-facing metering points and technical Microgrids participate in a Gridpool context, and can also describe Microgrid-to-Market-Location relations that exist without market participation.

Microgrid asset metadata describes the technical structure of deployed or planned microgrids, including electrical components, sensors, and the directed electrical component graph.

Authentication

All requests to PlatformAssetsService must be signed. The key identifier and signature must be included in the request metadata (gRPC metadata / HTTP headers). The signature must be computed using the HMAC-SHA256 algorithm and secret key. All requests to this service must be made over TLS (HTTPS).

Source code in py/frequenz/api/platformassets/v1alpha1/platformassets_pb2_grpc.py 
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
class PlatformAssetsServiceStub(object):
    """PlatformAssetsService provides read-only access to platform asset and
    market-topology metadata.

    The service exposes a platform-wide read model for resolving stable
    identifiers, asset inventories, and relationships managed by the Frequenz
    platform. This includes Gridpools, microgrids, Market Locations,
    market-topology relations, Gridpool energy schedules, electrical component
    inventories, sensor inventories, and the directed electrical component graph
    within a microgrid.

    Gridpools represent virtual balancing-group structures used for market
    interactions, such as electricity trading, scheduled energy exchange, and
    flexibility or ancillary-service participation.

    Market-topology relations describe how Gridpools, Microgrids, and Market
    Locations are connected. These relations define which market-facing metering
    points and technical Microgrids participate in a Gridpool context, and can
    also describe Microgrid-to-Market-Location relations that exist without
    market participation.

    Microgrid asset metadata describes the technical structure of deployed or
    planned microgrids, including electrical components, sensors, and the
    directed electrical component graph.

    !!! important "Authentication"
    All requests to PlatformAssetsService must be signed. The key identifier
    and signature must be included in the request metadata (gRPC metadata /
    HTTP headers). The signature must be computed using the HMAC-SHA256
    algorithm and secret key. All requests to this service must be made
    over TLS (HTTPS).

    """

    def __init__(self, channel):
        """Constructor.

        Args:
            channel: A grpc.Channel.
        """
        self.ListGridpools = channel.unary_unary(
                '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListGridpools',
                request_serializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListGridpoolsRequest.SerializeToString,
                response_deserializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListGridpoolsResponse.FromString,
                _registered_method=True)
        self.ListGridpoolEnergySchedules = channel.unary_unary(
                '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListGridpoolEnergySchedules',
                request_serializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListGridpoolEnergySchedulesRequest.SerializeToString,
                response_deserializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListGridpoolEnergySchedulesResponse.FromString,
                _registered_method=True)
        self.ListMarketTopologyRelations = channel.unary_unary(
                '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListMarketTopologyRelations',
                request_serializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMarketTopologyRelationsRequest.SerializeToString,
                response_deserializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMarketTopologyRelationsResponse.FromString,
                _registered_method=True)
        self.GetMicrogrid = channel.unary_unary(
                '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/GetMicrogrid',
                request_serializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.GetMicrogridRequest.SerializeToString,
                response_deserializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.GetMicrogridResponse.FromString,
                _registered_method=True)
        self.ListMicrogrids = channel.unary_unary(
                '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListMicrogrids',
                request_serializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridsRequest.SerializeToString,
                response_deserializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridsResponse.FromString,
                _registered_method=True)
        self.ListMicrogridElectricalComponents = channel.unary_unary(
                '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListMicrogridElectricalComponents',
                request_serializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridElectricalComponentsRequest.SerializeToString,
                response_deserializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridElectricalComponentsResponse.FromString,
                _registered_method=True)
        self.ListMicrogridElectricalComponentConnections = channel.unary_unary(
                '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListMicrogridElectricalComponentConnections',
                request_serializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridElectricalComponentConnectionsRequest.SerializeToString,
                response_deserializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridElectricalComponentConnectionsResponse.FromString,
                _registered_method=True)
        self.ListMicrogridSensors = channel.unary_unary(
                '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListMicrogridSensors',
                request_serializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridSensorsRequest.SerializeToString,
                response_deserializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridSensorsResponse.FromString,
                _registered_method=True)
Attributes¤
GetMicrogrid instance-attribute ¤
GetMicrogrid: UnaryUnaryMultiCallable[
    GetMicrogridRequest, GetMicrogridResponse
] = unary_unary(
    "/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/GetMicrogrid",
    request_serializer=SerializeToString,
    response_deserializer=FromString,
    _registered_method=True,
)

Returns metadata for a specific microgrid.

ListGridpoolEnergySchedules instance-attribute ¤
ListGridpoolEnergySchedules: UnaryUnaryMultiCallable[
    ListGridpoolEnergySchedulesRequest,
    ListGridpoolEnergySchedulesResponse,
] = unary_unary(
    "/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListGridpoolEnergySchedules",
    request_serializer=SerializeToString,
    response_deserializer=FromString,
    _registered_method=True,
)

Lists energy schedules for a specific Gridpool.

ListGridpools instance-attribute ¤
ListGridpools: UnaryUnaryMultiCallable[
    ListGridpoolsRequest, ListGridpoolsResponse
] = unary_unary(
    "/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListGridpools",
    request_serializer=SerializeToString,
    response_deserializer=FromString,
    _registered_method=True,
)

Lists Gridpools within the current enterprise scope.

ListMarketTopologyRelations instance-attribute ¤
ListMarketTopologyRelations: UnaryUnaryMultiCallable[
    ListMarketTopologyRelationsRequest,
    ListMarketTopologyRelationsResponse,
] = unary_unary(
    "/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListMarketTopologyRelations",
    request_serializer=SerializeToString,
    response_deserializer=FromString,
    _registered_method=True,
)

Lists market-topology relations within the current enterprise scope.

ListMicrogridElectricalComponentConnections instance-attribute ¤
ListMicrogridElectricalComponentConnections: (
    UnaryUnaryMultiCallable[
        ListMicrogridElectricalComponentConnectionsRequest,
        ListMicrogridElectricalComponentConnectionsResponse,
    ]
) = unary_unary(
    "/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListMicrogridElectricalComponentConnections",
    request_serializer=SerializeToString,
    response_deserializer=FromString,
    _registered_method=True,
)

Lists directed electrical connections between components in a specific microgrid.

ListMicrogridElectricalComponents instance-attribute ¤
ListMicrogridElectricalComponents: UnaryUnaryMultiCallable[
    ListMicrogridElectricalComponentsRequest,
    ListMicrogridElectricalComponentsResponse,
] = unary_unary(
    "/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListMicrogridElectricalComponents",
    request_serializer=SerializeToString,
    response_deserializer=FromString,
    _registered_method=True,
)

Lists electrical components for a specific microgrid.

ListMicrogridSensors instance-attribute ¤
ListMicrogridSensors: UnaryUnaryMultiCallable[
    ListMicrogridSensorsRequest,
    ListMicrogridSensorsResponse,
] = unary_unary(
    "/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListMicrogridSensors",
    request_serializer=SerializeToString,
    response_deserializer=FromString,
    _registered_method=True,
)

Lists sensors for a specific microgrid.

ListMicrogrids instance-attribute ¤
ListMicrogrids: UnaryUnaryMultiCallable[
    ListMicrogridsRequest, ListMicrogridsResponse
] = unary_unary(
    "/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListMicrogrids",
    request_serializer=SerializeToString,
    response_deserializer=FromString,
    _registered_method=True,
)

Lists microgrids within the current enterprise scope.

Functions¤
__init__ ¤
__init__(channel)

Constructor.

PARAMETER DESCRIPTION
channel

A grpc.Channel.
Source code in py/frequenz/api/platformassets/v1alpha1/platformassets_pb2_grpc.py 
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def __init__(self, channel):
    """Constructor.

    Args:
        channel: A grpc.Channel.
    """
    self.ListGridpools = channel.unary_unary(
            '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListGridpools',
            request_serializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListGridpoolsRequest.SerializeToString,
            response_deserializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListGridpoolsResponse.FromString,
            _registered_method=True)
    self.ListGridpoolEnergySchedules = channel.unary_unary(
            '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListGridpoolEnergySchedules',
            request_serializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListGridpoolEnergySchedulesRequest.SerializeToString,
            response_deserializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListGridpoolEnergySchedulesResponse.FromString,
            _registered_method=True)
    self.ListMarketTopologyRelations = channel.unary_unary(
            '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListMarketTopologyRelations',
            request_serializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMarketTopologyRelationsRequest.SerializeToString,
            response_deserializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMarketTopologyRelationsResponse.FromString,
            _registered_method=True)
    self.GetMicrogrid = channel.unary_unary(
            '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/GetMicrogrid',
            request_serializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.GetMicrogridRequest.SerializeToString,
            response_deserializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.GetMicrogridResponse.FromString,
            _registered_method=True)
    self.ListMicrogrids = channel.unary_unary(
            '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListMicrogrids',
            request_serializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridsRequest.SerializeToString,
            response_deserializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridsResponse.FromString,
            _registered_method=True)
    self.ListMicrogridElectricalComponents = channel.unary_unary(
            '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListMicrogridElectricalComponents',
            request_serializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridElectricalComponentsRequest.SerializeToString,
            response_deserializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridElectricalComponentsResponse.FromString,
            _registered_method=True)
    self.ListMicrogridElectricalComponentConnections = channel.unary_unary(
            '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListMicrogridElectricalComponentConnections',
            request_serializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridElectricalComponentConnectionsRequest.SerializeToString,
            response_deserializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridElectricalComponentConnectionsResponse.FromString,
            _registered_method=True)
    self.ListMicrogridSensors = channel.unary_unary(
            '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListMicrogridSensors',
            request_serializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridSensorsRequest.SerializeToString,
            response_deserializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.ListMicrogridSensorsResponse.FromString,
            _registered_method=True)