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 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
class PlatformAssetsService(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.

    !!! important "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).

    """

    @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 GetGridpool(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/GetGridpool',
            frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.GetGridpoolRequest.SerializeToString,
            frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.GetGridpoolResponse.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 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)

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
        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)


class PlatformAssetsServiceServicer(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.

    !!! important "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).

    """

    def ListMicrogrids(self, request, context):
        """Returns metadata for all microgrids visible to the caller.
        """
        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
        context.set_details('Method not implemented!')
        raise NotImplementedError('Method not implemented!')
Attributes¤
GetGridpool instance-attribute ¤

Returns metadata for a specific gridpool.

GetMicrogrid instance-attribute ¤

Returns metadata for a specific microgrid.

ListMicrogridElectricalComponentConnections instance-attribute ¤

Lists directed electrical connections between components in a specific microgrid.

ListMicrogridElectricalComponents instance-attribute ¤

Lists electrical components for a specific microgrid.

ListMicrogrids instance-attribute ¤

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
class PlatformAssetsServiceServicer(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.

    !!! important "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).

    """

    def ListMicrogrids(self, request, context):
        """Returns metadata for all microgrids visible to the caller.
        """
        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
        context.set_details('Method not implemented!')
        raise NotImplementedError('Method not implemented!')

    def GetGridpool(self, request, context):
        """Returns metadata for a specific gridpool.
        """
        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 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!')
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
def GetGridpool(self, request, context):
    """Returns metadata for a specific gridpool.
    """
    context.set_code(grpc.StatusCode.UNIMPLEMENTED)
    context.set_details('Method not implemented!')
    raise NotImplementedError('Method not implemented!')
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
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!')
ListMicrogridElectricalComponentConnections ¤

Lists directed electrical connections between components in a specific microgrid.

Source code in py/frequenz/api/platformassets/v1alpha1/platformassets_pb2_grpc.py
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 ¤

Lists electrical components for a specific microgrid.

Source code in py/frequenz/api/platformassets/v1alpha1/platformassets_pb2_grpc.py
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!')
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
def ListMicrogrids(self, request, context):
    """Returns metadata for all microgrids visible to the caller.
    """
    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 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
class PlatformAssetsServiceStub(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.

    !!! important "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).

    """

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

        Args:
            channel: A grpc.Channel.
        """
        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.GetGridpool = channel.unary_unary(
                '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/GetGridpool',
                request_serializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.GetGridpoolRequest.SerializeToString,
                response_deserializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.GetGridpoolResponse.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.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)
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__ ¤
__init__(channel)

Constructor.

PARAMETER DESCRIPTION
channel

A grpc.Channel.

Source code in py/frequenz/api/platformassets/v1alpha1/platformassets_pb2_grpc.py
def __init__(self, channel):
    """Constructor.

    Args:
        channel: A grpc.Channel.
    """
    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.GetGridpool = channel.unary_unary(
            '/frequenz.api.platformassets.v1alpha1.PlatformAssetsService/GetGridpool',
            request_serializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.GetGridpoolRequest.SerializeToString,
            response_deserializer=frequenz_dot_api_dot_platformassets_dot_v1alpha1_dot_platformassets__pb2.GetGridpoolResponse.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.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)