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 metadata.
The service exposes technical asset information required by downstream services and applications, including microgrid metadata, electrical component inventories, and the directed electrical component graph within a microgrid.
Platform assets describe the technical structure of a deployed or planned microgrid. They are commonly used by reporting, forecasting, monitoring, trading, optimization, and operational tooling to resolve stable asset identifiers into their associated metadata.
Authentication
All requests to FlexMarketService 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
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 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 | |
frequenz.api.platformassets.v1alpha1.platformassets_pb2_grpc.PlatformAssetsServiceAsyncStub ¤
Bases: PlatformAssetsServiceStub
PlatformAssetsService provides read-only access to platform asset metadata.
The service exposes technical asset information required by downstream services and applications, including microgrid metadata, electrical component inventories, and the directed electrical component graph within a microgrid.
Platform assets describe the technical structure of a deployed or planned microgrid. They are commonly used by reporting, forecasting, monitoring, trading, optimization, and operational tooling to resolve stable asset identifiers into their associated metadata.
Authentication
All requests to FlexMarketService 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
Attributes¤
GetGridpool
instance-attribute
¤
GetGridpool: UnaryUnaryMultiCallable[
GetGridpoolRequest, GetGridpoolResponse
]
Returns metadata for a specific gridpool.
GetMicrogrid
instance-attribute
¤
GetMicrogrid: UnaryUnaryMultiCallable[
GetMicrogridRequest, GetMicrogridResponse
]
Returns metadata for a specific microgrid.
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.
ListMicrogrids
instance-attribute
¤
ListMicrogrids: UnaryUnaryMultiCallable[
ListMicrogridsRequest, ListMicrogridsResponse
]
Returns metadata for all microgrids visible to the caller.
frequenz.api.platformassets.v1alpha1.platformassets_pb2_grpc.PlatformAssetsServiceServicer ¤
Bases: object
PlatformAssetsService provides read-only access to platform asset metadata.
The service exposes technical asset information required by downstream services and applications, including microgrid metadata, electrical component inventories, and the directed electrical component graph within a microgrid.
Platform assets describe the technical structure of a deployed or planned microgrid. They are commonly used by reporting, forecasting, monitoring, trading, optimization, and operational tooling to resolve stable asset identifiers into their associated metadata.
Authentication
All requests to FlexMarketService 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
Functions¤
GetGridpool ¤
GetGridpool(
request: GetGridpoolRequest, context: _ServicerContext
) -> Union[
GetGridpoolResponse, Awaitable[GetGridpoolResponse]
]
Returns metadata for a specific gridpool.
Source code in py/frequenz/api/platformassets/v1alpha1/platformassets_pb2_grpc.py
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
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
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
ListMicrogrids ¤
ListMicrogrids(
request: ListMicrogridsRequest,
context: _ServicerContext,
) -> Union[
ListMicrogridsResponse,
Awaitable[ListMicrogridsResponse],
]
Returns metadata for all microgrids visible to the caller.
Source code in py/frequenz/api/platformassets/v1alpha1/platformassets_pb2_grpc.py
frequenz.api.platformassets.v1alpha1.platformassets_pb2_grpc.PlatformAssetsServiceStub ¤
Bases: object
PlatformAssetsService provides read-only access to platform asset metadata.
The service exposes technical asset information required by downstream services and applications, including microgrid metadata, electrical component inventories, and the directed electrical component graph within a microgrid.
Platform assets describe the technical structure of a deployed or planned microgrid. They are commonly used by reporting, forecasting, monitoring, trading, optimization, and operational tooling to resolve stable asset identifiers into their associated metadata.
Authentication
All requests to FlexMarketService 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
Attributes¤
GetGridpool
instance-attribute
¤
GetGridpool: UnaryUnaryMultiCallable[
GetGridpoolRequest, GetGridpoolResponse
] = unary_unary(
"/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/GetGridpool",
request_serializer=SerializeToString,
response_deserializer=FromString,
_registered_method=True,
)
Returns metadata for a specific gridpool.
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.
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.
ListMicrogrids
instance-attribute
¤
ListMicrogrids: UnaryUnaryMultiCallable[
ListMicrogridsRequest, ListMicrogridsResponse
] = unary_unary(
"/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/ListMicrogrids",
request_serializer=SerializeToString,
response_deserializer=FromString,
_registered_method=True,
)
Returns metadata for all microgrids visible to the caller.
Functions¤
__init__ ¤
Constructor.
| PARAMETER | DESCRIPTION |
|---|---|
channel
|
A grpc.Channel.
|