Skip to content

assets_pb2_grpc

frequenz.api.assets.v1.assets_pb2_grpc ¤

Client and server classes corresponding to protobuf-defined services.

Classes¤

frequenz.api.assets.v1.assets_pb2_grpc.PlatformAssets ¤

Bases: object

Service providing access to manage and retrieve information related to gridpools and microgrids, and other platform assets.

Source code in frequenz/api/assets/v1/assets_pb2_grpc.py 
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
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
class PlatformAssets(object):
    """Service providing access to manage and retrieve information
    related to gridpools and microgrids, and other platform assets.
    """

    @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.assets.v1.PlatformAssets/GetMicrogrid',
            frequenz_dot_api_dot_assets_dot_v1_dot_assets__pb2.GetMicrogridRequest.SerializeToString,
            frequenz_dot_api_dot_assets_dot_v1_dot_assets__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.assets.v1.PlatformAssets/ListMicrogridElectricalComponents',
            frequenz_dot_api_dot_assets_dot_v1_dot_assets__pb2.ListMicrogridElectricalComponentsRequest.SerializeToString,
            frequenz_dot_api_dot_assets_dot_v1_dot_assets__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.assets.v1.PlatformAssets/ListMicrogridElectricalComponentConnections',
            frequenz_dot_api_dot_assets_dot_v1_dot_assets__pb2.ListMicrogridElectricalComponentConnectionsRequest.SerializeToString,
            frequenz_dot_api_dot_assets_dot_v1_dot_assets__pb2.ListMicrogridElectricalComponentConnectionsResponse.FromString,
            options,
            channel_credentials,
            insecure,
            call_credentials,
            compression,
            wait_for_ready,
            timeout,
            metadata,
            _registered_method=True)

frequenz.api.assets.v1.assets_pb2_grpc.PlatformAssetsAsyncStub ¤

Service providing access to manage and retrieve information related to gridpools and microgrids, and other platform assets.

Source code in frequenz/api/assets/v1/assets_pb2_grpc.py 
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
class PlatformAssetsServicer(object):
    """Service providing access to manage and retrieve information
    related to gridpools and microgrids, and other platform assets.
    """

    def GetMicrogrid(self, request, context):
        """Returns details of 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):
        """Returns list of a 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):
        """Returns a list of the connections between electrical components for a
        specific microgrid.
        """
Attributes¤
GetMicrogrid instance-attribute ¤
GetMicrogrid: UnaryUnaryMultiCallable[
    GetMicrogridRequest, GetMicrogridResponse
]

Returns details of a specific microgrid.

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

Returns a list of the connections between electrical components for a specific microgrid.

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

Returns list of a electrical components for a specific microgrid.

frequenz.api.assets.v1.assets_pb2_grpc.PlatformAssetsServicer ¤

Bases: object

Service providing access to manage and retrieve information related to gridpools and microgrids, and other platform assets.

Source code in frequenz/api/assets/v1/assets_pb2_grpc.py 
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
class PlatformAssetsServicer(object):
    """Service providing access to manage and retrieve information
    related to gridpools and microgrids, and other platform assets.
    """

    def GetMicrogrid(self, request, context):
        """Returns details of 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):
        """Returns list of a 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):
        """Returns a list of the connections between electrical components 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 details of a specific microgrid.

Source code in frequenz/api/assets/v1/assets_pb2_grpc.py 
61
62
63
64
65
66
def GetMicrogrid(self, request, context):
    """Returns details of a specific microgrid.
    """
    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
    ],
]

Returns a list of the connections between electrical components for a specific microgrid.

Source code in frequenz/api/assets/v1/assets_pb2_grpc.py 
75
76
77
78
79
80
81
def ListMicrogridElectricalComponentConnections(self, request, context):
    """Returns a list of the connections between electrical components for 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],
]

Returns list of a electrical components for a specific microgrid.

Source code in frequenz/api/assets/v1/assets_pb2_grpc.py 
68
69
70
71
72
73
def ListMicrogridElectricalComponents(self, request, context):
    """Returns list of a electrical components for a specific microgrid.
    """
    context.set_code(grpc.StatusCode.UNIMPLEMENTED)
    context.set_details('Method not implemented!')
    raise NotImplementedError('Method not implemented!')

frequenz.api.assets.v1.assets_pb2_grpc.PlatformAssetsStub ¤

Bases: object

Service providing access to manage and retrieve information related to gridpools and microgrids, and other platform assets.

Source code in frequenz/api/assets/v1/assets_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
class PlatformAssetsStub(object):
    """Service providing access to manage and retrieve information
    related to gridpools and microgrids, and other platform assets.
    """

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

        Args:
            channel: A grpc.Channel.
        """
        self.GetMicrogrid = channel.unary_unary(
                '/frequenz.api.assets.v1.PlatformAssets/GetMicrogrid',
                request_serializer=frequenz_dot_api_dot_assets_dot_v1_dot_assets__pb2.GetMicrogridRequest.SerializeToString,
                response_deserializer=frequenz_dot_api_dot_assets_dot_v1_dot_assets__pb2.GetMicrogridResponse.FromString,
                _registered_method=True)
        self.ListMicrogridElectricalComponents = channel.unary_unary(
                '/frequenz.api.assets.v1.PlatformAssets/ListMicrogridElectricalComponents',
                request_serializer=frequenz_dot_api_dot_assets_dot_v1_dot_assets__pb2.ListMicrogridElectricalComponentsRequest.SerializeToString,
                response_deserializer=frequenz_dot_api_dot_assets_dot_v1_dot_assets__pb2.ListMicrogridElectricalComponentsResponse.FromString,
                _registered_method=True)
        self.ListMicrogridElectricalComponentConnections = channel.unary_unary(
                '/frequenz.api.assets.v1.PlatformAssets/ListMicrogridElectricalComponentConnections',
                request_serializer=frequenz_dot_api_dot_assets_dot_v1_dot_assets__pb2.ListMicrogridElectricalComponentConnectionsRequest.SerializeToString,
                response_deserializer=frequenz_dot_api_dot_assets_dot_v1_dot_assets__pb2.ListMicrogridElectricalComponentConnectionsResponse.FromString,
                _registered_method=True)
Attributes¤
GetMicrogrid instance-attribute ¤
GetMicrogrid: UnaryUnaryMultiCallable[
    GetMicrogridRequest, GetMicrogridResponse
] = unary_unary(
    "/frequenz.api.assets.v1.PlatformAssets/GetMicrogrid",
    request_serializer=SerializeToString,
    response_deserializer=FromString,
    _registered_method=True,
)

Returns details of a specific microgrid.

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

Returns a list of the connections between electrical components for a specific microgrid.

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

Returns list of a electrical components for a specific microgrid.

Functions¤
__init__ ¤
__init__(channel: Union[Channel, Channel]) -> None

Constructor.

PARAMETER DESCRIPTION
channel

A grpc.Channel.

TYPE: Union[Channel, Channel]

Source code in frequenz/api/assets/v1/assets_pb2_grpc.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
def __init__(self, channel):
    """Constructor.

    Args:
        channel: A grpc.Channel.
    """
    self.GetMicrogrid = channel.unary_unary(
            '/frequenz.api.assets.v1.PlatformAssets/GetMicrogrid',
            request_serializer=frequenz_dot_api_dot_assets_dot_v1_dot_assets__pb2.GetMicrogridRequest.SerializeToString,
            response_deserializer=frequenz_dot_api_dot_assets_dot_v1_dot_assets__pb2.GetMicrogridResponse.FromString,
            _registered_method=True)
    self.ListMicrogridElectricalComponents = channel.unary_unary(
            '/frequenz.api.assets.v1.PlatformAssets/ListMicrogridElectricalComponents',
            request_serializer=frequenz_dot_api_dot_assets_dot_v1_dot_assets__pb2.ListMicrogridElectricalComponentsRequest.SerializeToString,
            response_deserializer=frequenz_dot_api_dot_assets_dot_v1_dot_assets__pb2.ListMicrogridElectricalComponentsResponse.FromString,
            _registered_method=True)
    self.ListMicrogridElectricalComponentConnections = channel.unary_unary(
            '/frequenz.api.assets.v1.PlatformAssets/ListMicrogridElectricalComponentConnections',
            request_serializer=frequenz_dot_api_dot_assets_dot_v1_dot_assets__pb2.ListMicrogridElectricalComponentConnectionsRequest.SerializeToString,
            response_deserializer=frequenz_dot_api_dot_assets_dot_v1_dot_assets__pb2.ListMicrogridElectricalComponentConnectionsResponse.FromString,
            _registered_method=True)