Skip to content

weather_pb2_grpc

frequenz.api.weather.weather_pb2_grpc ¤

Client and server classes corresponding to protobuf-defined services.

Classes¤

frequenz.api.weather.weather_pb2_grpc.WeatherForecastService ¤

Bases: object

Service provides operations related to retrieving weather forecasts for locations.

The forecasts are updated regularly, and the service will stream the latest available data unless a specific time range is requested.

Note

Weather forecasts are inherently uncertain and actual conditions may vary. Use the data responsibly.

Source code in frequenz/api/weather/weather_pb2_grpc.py 
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 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
class WeatherForecastService(object):
    """Service provides operations related to retrieving weather forecasts for
    locations.

    The forecasts are updated regularly, and the service will stream the latest
    available data unless a specific time range is requested.
    !!! note
    Weather forecasts are inherently uncertain and actual conditions may
    vary. Use the data responsibly.
    """

    @staticmethod
    def GetHistoricalWeatherForecast(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.weatherforecast.v1.WeatherForecastService/GetHistoricalWeatherForecast',
            frequenz_dot_api_dot_weather_dot_weather__pb2.GetHistoricalWeatherForecastRequest.SerializeToString,
            frequenz_dot_api_dot_weather_dot_weather__pb2.GetHistoricalWeatherForecastResponse.FromString,
            options, channel_credentials,
            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)

    @staticmethod
    def ReceiveLiveWeatherForecast(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_stream(request, target, '/frequenz.api.weatherforecast.v1.WeatherForecastService/ReceiveLiveWeatherForecast',
            frequenz_dot_api_dot_weather_dot_weather__pb2.ReceiveLiveWeatherForecastRequest.SerializeToString,
            frequenz_dot_api_dot_weather_dot_weather__pb2.ReceiveLiveWeatherForecastResponse.FromString,
            options, channel_credentials,
            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)

frequenz.api.weather.weather_pb2_grpc.WeatherForecastServiceAsyncStub ¤

Service provides operations related to retrieving weather forecasts for locations.

The forecasts are updated regularly, and the service will stream the latest available data unless a specific time range is requested.

Note

Weather forecasts are inherently uncertain and actual conditions may vary. Use the data responsibly.

Source code in frequenz/api/weather/weather_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
78
79
    def ReceiveLiveWeatherForecast(self, request, context):
        """Streams live weather forecast features for a geo location as they become
        available. Initially, the most recent forecast will be streamed.
        """
        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
        context.set_details('Method not implemented!')
        raise NotImplementedError('Method not implemented!')


def add_WeatherForecastServiceServicer_to_server(servicer, server):
    rpc_method_handlers = {
            'GetHistoricalWeatherForecast': grpc.unary_unary_rpc_method_handler(
                    servicer.GetHistoricalWeatherForecast,
                    request_deserializer=frequenz_dot_api_dot_weather_dot_weather__pb2.GetHistoricalWeatherForecastRequest.FromString,
                    response_serializer=frequenz_dot_api_dot_weather_dot_weather__pb2.GetHistoricalWeatherForecastResponse.SerializeToString,
            ),
            'ReceiveLiveWeatherForecast': grpc.unary_stream_rpc_method_handler(
                    servicer.ReceiveLiveWeatherForecast,
                    request_deserializer=frequenz_dot_api_dot_weather_dot_weather__pb2.ReceiveLiveWeatherForecastRequest.FromString,
                    response_serializer=frequenz_dot_api_dot_weather_dot_weather__pb2.ReceiveLiveWeatherForecastResponse.SerializeToString,
            ),
    }
    generic_handler = grpc.method_handlers_generic_handler(
            'frequenz.api.weatherforecast.v1.WeatherForecastService', rpc_method_handlers)
    server.add_generic_rpc_handlers((generic_handler,))
Attributes¤
GetHistoricalWeatherForecast instance-attribute ¤
GetHistoricalWeatherForecast: UnaryUnaryMultiCallable[
    GetHistoricalWeatherForecastRequest,
    GetHistoricalWeatherForecastResponse,
]

Returns historical weather forecast features for a geo location for a specified time range.

ReceiveLiveWeatherForecast instance-attribute ¤
ReceiveLiveWeatherForecast: UnaryStreamMultiCallable[
    ReceiveLiveWeatherForecastRequest,
    ReceiveLiveWeatherForecastResponse,
]

Streams live weather forecast features for a geo location as they become available. Initially, the most recent forecast will be streamed.

frequenz.api.weather.weather_pb2_grpc.WeatherForecastServiceServicer ¤

Bases: object

Service provides operations related to retrieving weather forecasts for locations.

The forecasts are updated regularly, and the service will stream the latest available data unless a specific time range is requested.

Note

Weather forecasts are inherently uncertain and actual conditions may vary. Use the data responsibly.

Source code in frequenz/api/weather/weather_pb2_grpc.py 
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
class WeatherForecastServiceServicer(object):
    """Service provides operations related to retrieving weather forecasts for
    locations.

    The forecasts are updated regularly, and the service will stream the latest
    available data unless a specific time range is requested.
    !!! note
    Weather forecasts are inherently uncertain and actual conditions may
    vary. Use the data responsibly.
    """

    def GetHistoricalWeatherForecast(self, request, context):
        """Returns historical weather forecast features for a geo location for a
        specified time range.
        """
        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
        context.set_details('Method not implemented!')
        raise NotImplementedError('Method not implemented!')

    def ReceiveLiveWeatherForecast(self, request, context):
        """Streams live weather forecast features for a geo location as they become
        available. Initially, the most recent forecast will be streamed.
        """
        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
        context.set_details('Method not implemented!')
        raise NotImplementedError('Method not implemented!')
Functions¤
GetHistoricalWeatherForecast ¤
GetHistoricalWeatherForecast(
    request: GetHistoricalWeatherForecastRequest,
    context: _ServicerContext,
) -> Union[
    GetHistoricalWeatherForecastResponse,
    Awaitable[GetHistoricalWeatherForecastResponse],
]

Returns historical weather forecast features for a geo location for a specified time range.

Source code in frequenz/api/weather/weather_pb2_grpc.py 
48
49
50
51
52
53
54
def GetHistoricalWeatherForecast(self, request, context):
    """Returns historical weather forecast features for a geo location for a
    specified time range.
    """
    context.set_code(grpc.StatusCode.UNIMPLEMENTED)
    context.set_details('Method not implemented!')
    raise NotImplementedError('Method not implemented!')
ReceiveLiveWeatherForecast ¤
ReceiveLiveWeatherForecast(
    request: ReceiveLiveWeatherForecastRequest,
    context: _ServicerContext,
) -> Union[
    Iterator[ReceiveLiveWeatherForecastResponse],
    AsyncIterator[ReceiveLiveWeatherForecastResponse],
]

Streams live weather forecast features for a geo location as they become available. Initially, the most recent forecast will be streamed.

Source code in frequenz/api/weather/weather_pb2_grpc.py 
56
57
58
59
60
61
62
def ReceiveLiveWeatherForecast(self, request, context):
    """Streams live weather forecast features for a geo location as they become
    available. Initially, the most recent forecast will be streamed.
    """
    context.set_code(grpc.StatusCode.UNIMPLEMENTED)
    context.set_details('Method not implemented!')
    raise NotImplementedError('Method not implemented!')

frequenz.api.weather.weather_pb2_grpc.WeatherForecastServiceStub ¤

Bases: object

Service provides operations related to retrieving weather forecasts for locations.

The forecasts are updated regularly, and the service will stream the latest available data unless a specific time range is requested.

Note

Weather forecasts are inherently uncertain and actual conditions may vary. Use the data responsibly.

Source code in frequenz/api/weather/weather_pb2_grpc.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class WeatherForecastServiceStub(object):
    """Service provides operations related to retrieving weather forecasts for
    locations.

    The forecasts are updated regularly, and the service will stream the latest
    available data unless a specific time range is requested.
    !!! note
    Weather forecasts are inherently uncertain and actual conditions may
    vary. Use the data responsibly.
    """

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

        Args:
            channel: A grpc.Channel.
        """
        self.GetHistoricalWeatherForecast = channel.unary_unary(
                '/frequenz.api.weatherforecast.v1.WeatherForecastService/GetHistoricalWeatherForecast',
                request_serializer=frequenz_dot_api_dot_weather_dot_weather__pb2.GetHistoricalWeatherForecastRequest.SerializeToString,
                response_deserializer=frequenz_dot_api_dot_weather_dot_weather__pb2.GetHistoricalWeatherForecastResponse.FromString,
                )
        self.ReceiveLiveWeatherForecast = channel.unary_stream(
                '/frequenz.api.weatherforecast.v1.WeatherForecastService/ReceiveLiveWeatherForecast',
                request_serializer=frequenz_dot_api_dot_weather_dot_weather__pb2.ReceiveLiveWeatherForecastRequest.SerializeToString,
                response_deserializer=frequenz_dot_api_dot_weather_dot_weather__pb2.ReceiveLiveWeatherForecastResponse.FromString,
                )
Attributes¤
GetHistoricalWeatherForecast instance-attribute ¤
GetHistoricalWeatherForecast: UnaryUnaryMultiCallable[
    GetHistoricalWeatherForecastRequest,
    GetHistoricalWeatherForecastResponse,
] = unary_unary(
    "/frequenz.api.weatherforecast.v1.WeatherForecastService/GetHistoricalWeatherForecast",
    request_serializer=SerializeToString,
    response_deserializer=FromString,
)

Returns historical weather forecast features for a geo location for a specified time range.

ReceiveLiveWeatherForecast instance-attribute ¤
ReceiveLiveWeatherForecast: UnaryStreamMultiCallable[
    ReceiveLiveWeatherForecastRequest,
    ReceiveLiveWeatherForecastResponse,
] = unary_stream(
    "/frequenz.api.weatherforecast.v1.WeatherForecastService/ReceiveLiveWeatherForecast",
    request_serializer=SerializeToString,
    response_deserializer=FromString,
)

Streams live weather forecast features for a geo location as they become available. Initially, the most recent forecast will be streamed.

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

Constructor.

PARAMETER DESCRIPTION
channel

A grpc.Channel.

TYPE: Union[Channel, Channel]

Source code in frequenz/api/weather/weather_pb2_grpc.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
def __init__(self, channel):
    """Constructor.

    Args:
        channel: A grpc.Channel.
    """
    self.GetHistoricalWeatherForecast = channel.unary_unary(
            '/frequenz.api.weatherforecast.v1.WeatherForecastService/GetHistoricalWeatherForecast',
            request_serializer=frequenz_dot_api_dot_weather_dot_weather__pb2.GetHistoricalWeatherForecastRequest.SerializeToString,
            response_deserializer=frequenz_dot_api_dot_weather_dot_weather__pb2.GetHistoricalWeatherForecastResponse.FromString,
            )
    self.ReceiveLiveWeatherForecast = channel.unary_stream(
            '/frequenz.api.weatherforecast.v1.WeatherForecastService/ReceiveLiveWeatherForecast',
            request_serializer=frequenz_dot_api_dot_weather_dot_weather__pb2.ReceiveLiveWeatherForecastRequest.SerializeToString,
            response_deserializer=frequenz_dot_api_dot_weather_dot_weather__pb2.ReceiveLiveWeatherForecastResponse.FromString,
            )