Skip to content

dispatch_pb2_grpc

frequenz.api.dispatch.v1.dispatch_pb2_grpc ¤

Client and server classes corresponding to protobuf-defined services.

Classes¤

frequenz.api.dispatch.v1.dispatch_pb2_grpc.MicrogridDispatchService ¤

Bases: object

Service providing operations related to dispatching microgrid components.

Overview¤

The API serves to automate the process of electricity dispatches for microgrids. In the context of the energy industry, a 'dispatch' refers to the act of routing electrical power between different components within a microgrid or between a microgrid and the main grid. This could be for the purpose of supply (sending electricity to the grid or components within the microgrid), or demand (drawing electricity from the grid or from other components like batteries and solar arrays).

Objective¤

The primary objective of this API is to streamline and automate the complex task of electricity dispatching, making it easier to manage local electricity supply and demand efficiently.

Key Features¤
  • Dispatching Electricity: Comprehensive CRUD operations for dispatching microgrid components.
  • Automation: Support for one-time as well as recurring dispatches based on flexible recurrence rules.
  • Fine-grained control: Dispatch individual microgrid components or entire component categories.
Example Use Cases¤
  • Charging or discharging a battery based on optimal time-of-use rates.
  • Limiting the output of a Photovoltaic (PV) array during periods of low demand.
  • Invoking Frequency Containment Reserves (FCR) or Automatic Frequency Restoration Reserves (aFRR) to support grid operations.
  • Adjusting the output of electric vehicle charging stations to match grid availability or to avoid peak pricing.
Target Audience¤

This API is designed for application developers in the energy sector who focus on the tasks of optimizing microgrid electricity flows. Its design aims to be as developer-friendly as possible, requiring no prior knowledge in electrical engineering and systems.

Source code in frequenz/api/dispatch/v1/dispatch_pb2_grpc.py
class MicrogridDispatchService(object):
    """Service providing operations related to dispatching microgrid components.

    #### Overview

    The API serves to automate the process of electricity dispatches for microgrids.
    In the context of the energy industry, a 'dispatch' refers to the act of routing electrical power
    between different components within a microgrid or between a microgrid and the main grid.
    This could be for the purpose of supply (sending electricity to the grid or components within the microgrid),
    or demand (drawing electricity from the grid or from other components like batteries and solar arrays).

    #### Objective

    The primary objective of this API is to streamline and automate the complex task of electricity dispatching,
    making it easier to manage local electricity supply and demand efficiently.

    #### Key Features

    - Dispatching Electricity: Comprehensive CRUD operations for dispatching microgrid components.
    - Automation: Support for one-time as well as recurring dispatches based on flexible recurrence rules.
    - Fine-grained control: Dispatch individual microgrid components or entire component categories.

    #### Example Use Cases

    - Charging or discharging a battery based on optimal time-of-use rates.
    - Limiting the output of a Photovoltaic (PV) array during periods of low demand.
    - Invoking Frequency Containment Reserves (FCR) or Automatic Frequency Restoration Reserves (aFRR) to
    support grid operations.
    - Adjusting the output of electric vehicle charging stations to match grid availability or to avoid peak pricing.

    #### Target Audience

    This API is designed for application developers in the energy sector who focus on the tasks of optimizing microgrid
    electricity flows. Its design aims to be as developer-friendly as possible, requiring no prior knowledge in
    electrical engineering and systems.
    """

    @staticmethod
    def ListMicrogridDispatches(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.dispatch.v1.MicrogridDispatchService/ListMicrogridDispatches',
            frequenz_dot_api_dot_dispatch_dot_v1_dot_dispatch__pb2.DispatchListRequest.SerializeToString,
            frequenz_dot_api_dot_dispatch_dot_v1_dot_dispatch__pb2.DispatchList.FromString,
            options, channel_credentials,
            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)

    @staticmethod
    def CreateMicrogridDispatch(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.dispatch.v1.MicrogridDispatchService/CreateMicrogridDispatch',
            frequenz_dot_api_dot_dispatch_dot_v1_dot_dispatch__pb2.DispatchCreateRequest.SerializeToString,
            google_dot_protobuf_dot_empty__pb2.Empty.FromString,
            options, channel_credentials,
            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)

    @staticmethod
    def UpdateMicrogridDispatch(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.dispatch.v1.MicrogridDispatchService/UpdateMicrogridDispatch',
            frequenz_dot_api_dot_dispatch_dot_v1_dot_dispatch__pb2.DispatchUpdateRequest.SerializeToString,
            google_dot_protobuf_dot_empty__pb2.Empty.FromString,
            options, channel_credentials,
            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)

    @staticmethod
    def GetMicrogridDispatch(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.dispatch.v1.MicrogridDispatchService/GetMicrogridDispatch',
            frequenz_dot_api_dot_dispatch_dot_v1_dot_dispatch__pb2.DispatchGetRequest.SerializeToString,
            frequenz_dot_api_dot_dispatch_dot_v1_dot_dispatch__pb2.Dispatch.FromString,
            options, channel_credentials,
            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)

    @staticmethod
    def DeleteMicrogridDispatch(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.dispatch.v1.MicrogridDispatchService/DeleteMicrogridDispatch',
            frequenz_dot_api_dot_dispatch_dot_v1_dot_dispatch__pb2.DispatchDeleteRequest.SerializeToString,
            google_dot_protobuf_dot_empty__pb2.Empty.FromString,
            options, channel_credentials,
            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)

frequenz.api.dispatch.v1.dispatch_pb2_grpc.MicrogridDispatchServiceAsyncStub ¤

Service providing operations related to dispatching microgrid components.

Overview¤

The API serves to automate the process of electricity dispatches for microgrids. In the context of the energy industry, a 'dispatch' refers to the act of routing electrical power between different components within a microgrid or between a microgrid and the main grid. This could be for the purpose of supply (sending electricity to the grid or components within the microgrid), or demand (drawing electricity from the grid or from other components like batteries and solar arrays).

Objective¤

The primary objective of this API is to streamline and automate the complex task of electricity dispatching, making it easier to manage local electricity supply and demand efficiently.

Key Features¤
  • Dispatching Electricity: Comprehensive CRUD operations for dispatching microgrid components.
  • Automation: Support for one-time as well as recurring dispatches based on flexible recurrence rules.
  • Fine-grained control: Dispatch individual microgrid components or entire component categories.
Example Use Cases¤
  • Charging or discharging a battery based on optimal time-of-use rates.
  • Limiting the output of a Photovoltaic (PV) array during periods of low demand.
  • Invoking Frequency Containment Reserves (FCR) or Automatic Frequency Restoration Reserves (aFRR) to support grid operations.
  • Adjusting the output of electric vehicle charging stations to match grid availability or to avoid peak pricing.
Target Audience¤

This API is designed for application developers in the energy sector who focus on the tasks of optimizing microgrid electricity flows. Its design aims to be as developer-friendly as possible, requiring no prior knowledge in electrical engineering and systems.

Source code in frequenz/api/dispatch/v1/dispatch_pb2_grpc.py
    - Dispatching Electricity: Comprehensive CRUD operations for dispatching microgrid components.
    - Automation: Support for one-time as well as recurring dispatches based on flexible recurrence rules.
    - Fine-grained control: Dispatch individual microgrid components or entire component categories.

    #### Example Use Cases

    - Charging or discharging a battery based on optimal time-of-use rates.
    - Limiting the output of a Photovoltaic (PV) array during periods of low demand.
    - Invoking Frequency Containment Reserves (FCR) or Automatic Frequency Restoration Reserves (aFRR) to
    support grid operations.
    - Adjusting the output of electric vehicle charging stations to match grid availability or to avoid peak pricing.

    #### Target Audience

    This API is designed for application developers in the energy sector who focus on the tasks of optimizing microgrid
    electricity flows. Its design aims to be as developer-friendly as possible, requiring no prior knowledge in
    electrical engineering and systems.
    """

    def ListMicrogridDispatches(self, request, context):
        """Returns a list of all dispatches
        """
        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
        context.set_details('Method not implemented!')
        raise NotImplementedError('Method not implemented!')

    def CreateMicrogridDispatch(self, request, context):
        """Create a new dispatch
        """
        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
        context.set_details('Method not implemented!')
        raise NotImplementedError('Method not implemented!')

    def UpdateMicrogridDispatch(self, request, context):
        """Update a dispatch
        """
        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
        context.set_details('Method not implemented!')
        raise NotImplementedError('Method not implemented!')

    def GetMicrogridDispatch(self, request, context):
        """Get a single dispatch
        """
        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
        context.set_details('Method not implemented!')
        raise NotImplementedError('Method not implemented!')

    def DeleteMicrogridDispatch(self, request, context):
        """Delete a given dispatch
        """
        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
        context.set_details('Method not implemented!')
        raise NotImplementedError('Method not implemented!')


def add_MicrogridDispatchServiceServicer_to_server(servicer, server):
    rpc_method_handlers = {
            'ListMicrogridDispatches': grpc.unary_unary_rpc_method_handler(
                    servicer.ListMicrogridDispatches,
                    request_deserializer=frequenz_dot_api_dot_dispatch_dot_v1_dot_dispatch__pb2.DispatchListRequest.FromString,
                    response_serializer=frequenz_dot_api_dot_dispatch_dot_v1_dot_dispatch__pb2.DispatchList.SerializeToString,
            ),
            'CreateMicrogridDispatch': grpc.unary_unary_rpc_method_handler(
                    servicer.CreateMicrogridDispatch,
                    request_deserializer=frequenz_dot_api_dot_dispatch_dot_v1_dot_dispatch__pb2.DispatchCreateRequest.FromString,
Attributes¤
CreateMicrogridDispatch instance-attribute ¤
CreateMicrogridDispatch: UnaryUnaryMultiCallable[
    DispatchCreateRequest, Empty
]

Create a new dispatch

DeleteMicrogridDispatch instance-attribute ¤
DeleteMicrogridDispatch: UnaryUnaryMultiCallable[
    DispatchDeleteRequest, Empty
]

Delete a given dispatch

GetMicrogridDispatch instance-attribute ¤

Get a single dispatch

ListMicrogridDispatches instance-attribute ¤

Returns a list of all dispatches

UpdateMicrogridDispatch instance-attribute ¤
UpdateMicrogridDispatch: UnaryUnaryMultiCallable[
    DispatchUpdateRequest, Empty
]

Update a dispatch

frequenz.api.dispatch.v1.dispatch_pb2_grpc.MicrogridDispatchServiceServicer ¤

Bases: object

Service providing operations related to dispatching microgrid components.

Overview¤

The API serves to automate the process of electricity dispatches for microgrids. In the context of the energy industry, a 'dispatch' refers to the act of routing electrical power between different components within a microgrid or between a microgrid and the main grid. This could be for the purpose of supply (sending electricity to the grid or components within the microgrid), or demand (drawing electricity from the grid or from other components like batteries and solar arrays).

Objective¤

The primary objective of this API is to streamline and automate the complex task of electricity dispatching, making it easier to manage local electricity supply and demand efficiently.

Key Features¤
  • Dispatching Electricity: Comprehensive CRUD operations for dispatching microgrid components.
  • Automation: Support for one-time as well as recurring dispatches based on flexible recurrence rules.
  • Fine-grained control: Dispatch individual microgrid components or entire component categories.
Example Use Cases¤
  • Charging or discharging a battery based on optimal time-of-use rates.
  • Limiting the output of a Photovoltaic (PV) array during periods of low demand.
  • Invoking Frequency Containment Reserves (FCR) or Automatic Frequency Restoration Reserves (aFRR) to support grid operations.
  • Adjusting the output of electric vehicle charging stations to match grid availability or to avoid peak pricing.
Target Audience¤

This API is designed for application developers in the energy sector who focus on the tasks of optimizing microgrid electricity flows. Its design aims to be as developer-friendly as possible, requiring no prior knowledge in electrical engineering and systems.

Source code in frequenz/api/dispatch/v1/dispatch_pb2_grpc.py
class MicrogridDispatchServiceServicer(object):
    """Service providing operations related to dispatching microgrid components.

    #### Overview

    The API serves to automate the process of electricity dispatches for microgrids.
    In the context of the energy industry, a 'dispatch' refers to the act of routing electrical power
    between different components within a microgrid or between a microgrid and the main grid.
    This could be for the purpose of supply (sending electricity to the grid or components within the microgrid),
    or demand (drawing electricity from the grid or from other components like batteries and solar arrays).

    #### Objective

    The primary objective of this API is to streamline and automate the complex task of electricity dispatching,
    making it easier to manage local electricity supply and demand efficiently.

    #### Key Features

    - Dispatching Electricity: Comprehensive CRUD operations for dispatching microgrid components.
    - Automation: Support for one-time as well as recurring dispatches based on flexible recurrence rules.
    - Fine-grained control: Dispatch individual microgrid components or entire component categories.

    #### Example Use Cases

    - Charging or discharging a battery based on optimal time-of-use rates.
    - Limiting the output of a Photovoltaic (PV) array during periods of low demand.
    - Invoking Frequency Containment Reserves (FCR) or Automatic Frequency Restoration Reserves (aFRR) to
    support grid operations.
    - Adjusting the output of electric vehicle charging stations to match grid availability or to avoid peak pricing.

    #### Target Audience

    This API is designed for application developers in the energy sector who focus on the tasks of optimizing microgrid
    electricity flows. Its design aims to be as developer-friendly as possible, requiring no prior knowledge in
    electrical engineering and systems.
    """

    def ListMicrogridDispatches(self, request, context):
        """Returns a list of all dispatches
        """
        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
        context.set_details('Method not implemented!')
        raise NotImplementedError('Method not implemented!')

    def CreateMicrogridDispatch(self, request, context):
        """Create a new dispatch
        """
        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
        context.set_details('Method not implemented!')
        raise NotImplementedError('Method not implemented!')

    def UpdateMicrogridDispatch(self, request, context):
        """Update a dispatch
        """
        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
        context.set_details('Method not implemented!')
        raise NotImplementedError('Method not implemented!')

    def GetMicrogridDispatch(self, request, context):
        """Get a single dispatch
        """
        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
        context.set_details('Method not implemented!')
        raise NotImplementedError('Method not implemented!')

    def DeleteMicrogridDispatch(self, request, context):
        """Delete a given dispatch
        """
        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
        context.set_details('Method not implemented!')
        raise NotImplementedError('Method not implemented!')
Functions¤
CreateMicrogridDispatch ¤
CreateMicrogridDispatch(
    request: DispatchCreateRequest,
    context: _ServicerContext,
) -> Union[Empty, Awaitable[Empty]]

Create a new dispatch

Source code in frequenz/api/dispatch/v1/dispatch_pb2_grpc.py
def CreateMicrogridDispatch(self, request, context):
    """Create a new dispatch
    """
    context.set_code(grpc.StatusCode.UNIMPLEMENTED)
    context.set_details('Method not implemented!')
    raise NotImplementedError('Method not implemented!')
DeleteMicrogridDispatch ¤
DeleteMicrogridDispatch(
    request: DispatchDeleteRequest,
    context: _ServicerContext,
) -> Union[Empty, Awaitable[Empty]]

Delete a given dispatch

Source code in frequenz/api/dispatch/v1/dispatch_pb2_grpc.py
def DeleteMicrogridDispatch(self, request, context):
    """Delete a given dispatch
    """
    context.set_code(grpc.StatusCode.UNIMPLEMENTED)
    context.set_details('Method not implemented!')
    raise NotImplementedError('Method not implemented!')
GetMicrogridDispatch ¤
GetMicrogridDispatch(
    request: DispatchGetRequest, context: _ServicerContext
) -> Union[Dispatch, Awaitable[Dispatch]]

Get a single dispatch

Source code in frequenz/api/dispatch/v1/dispatch_pb2_grpc.py
def GetMicrogridDispatch(self, request, context):
    """Get a single dispatch
    """
    context.set_code(grpc.StatusCode.UNIMPLEMENTED)
    context.set_details('Method not implemented!')
    raise NotImplementedError('Method not implemented!')
ListMicrogridDispatches ¤
ListMicrogridDispatches(
    request: DispatchListRequest, context: _ServicerContext
) -> Union[DispatchList, Awaitable[DispatchList]]

Returns a list of all dispatches

Source code in frequenz/api/dispatch/v1/dispatch_pb2_grpc.py
def ListMicrogridDispatches(self, request, context):
    """Returns a list of all dispatches
    """
    context.set_code(grpc.StatusCode.UNIMPLEMENTED)
    context.set_details('Method not implemented!')
    raise NotImplementedError('Method not implemented!')
UpdateMicrogridDispatch ¤
UpdateMicrogridDispatch(
    request: DispatchUpdateRequest,
    context: _ServicerContext,
) -> Union[Empty, Awaitable[Empty]]

Update a dispatch

Source code in frequenz/api/dispatch/v1/dispatch_pb2_grpc.py
def UpdateMicrogridDispatch(self, request, context):
    """Update a dispatch
    """
    context.set_code(grpc.StatusCode.UNIMPLEMENTED)
    context.set_details('Method not implemented!')
    raise NotImplementedError('Method not implemented!')

frequenz.api.dispatch.v1.dispatch_pb2_grpc.MicrogridDispatchServiceStub ¤

Bases: object

Service providing operations related to dispatching microgrid components.

Overview¤

The API serves to automate the process of electricity dispatches for microgrids. In the context of the energy industry, a 'dispatch' refers to the act of routing electrical power between different components within a microgrid or between a microgrid and the main grid. This could be for the purpose of supply (sending electricity to the grid or components within the microgrid), or demand (drawing electricity from the grid or from other components like batteries and solar arrays).

Objective¤

The primary objective of this API is to streamline and automate the complex task of electricity dispatching, making it easier to manage local electricity supply and demand efficiently.

Key Features¤
  • Dispatching Electricity: Comprehensive CRUD operations for dispatching microgrid components.
  • Automation: Support for one-time as well as recurring dispatches based on flexible recurrence rules.
  • Fine-grained control: Dispatch individual microgrid components or entire component categories.
Example Use Cases¤
  • Charging or discharging a battery based on optimal time-of-use rates.
  • Limiting the output of a Photovoltaic (PV) array during periods of low demand.
  • Invoking Frequency Containment Reserves (FCR) or Automatic Frequency Restoration Reserves (aFRR) to support grid operations.
  • Adjusting the output of electric vehicle charging stations to match grid availability or to avoid peak pricing.
Target Audience¤

This API is designed for application developers in the energy sector who focus on the tasks of optimizing microgrid electricity flows. Its design aims to be as developer-friendly as possible, requiring no prior knowledge in electrical engineering and systems.

Source code in frequenz/api/dispatch/v1/dispatch_pb2_grpc.py
class MicrogridDispatchServiceStub(object):
    """Service providing operations related to dispatching microgrid components.

    #### Overview

    The API serves to automate the process of electricity dispatches for microgrids.
    In the context of the energy industry, a 'dispatch' refers to the act of routing electrical power
    between different components within a microgrid or between a microgrid and the main grid.
    This could be for the purpose of supply (sending electricity to the grid or components within the microgrid),
    or demand (drawing electricity from the grid or from other components like batteries and solar arrays).

    #### Objective

    The primary objective of this API is to streamline and automate the complex task of electricity dispatching,
    making it easier to manage local electricity supply and demand efficiently.

    #### Key Features

    - Dispatching Electricity: Comprehensive CRUD operations for dispatching microgrid components.
    - Automation: Support for one-time as well as recurring dispatches based on flexible recurrence rules.
    - Fine-grained control: Dispatch individual microgrid components or entire component categories.

    #### Example Use Cases

    - Charging or discharging a battery based on optimal time-of-use rates.
    - Limiting the output of a Photovoltaic (PV) array during periods of low demand.
    - Invoking Frequency Containment Reserves (FCR) or Automatic Frequency Restoration Reserves (aFRR) to
    support grid operations.
    - Adjusting the output of electric vehicle charging stations to match grid availability or to avoid peak pricing.

    #### Target Audience

    This API is designed for application developers in the energy sector who focus on the tasks of optimizing microgrid
    electricity flows. Its design aims to be as developer-friendly as possible, requiring no prior knowledge in
    electrical engineering and systems.
    """

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

        Args:
            channel: A grpc.Channel.
        """
        self.ListMicrogridDispatches = channel.unary_unary(
                '/frequenz.api.dispatch.v1.MicrogridDispatchService/ListMicrogridDispatches',
                request_serializer=frequenz_dot_api_dot_dispatch_dot_v1_dot_dispatch__pb2.DispatchListRequest.SerializeToString,
                response_deserializer=frequenz_dot_api_dot_dispatch_dot_v1_dot_dispatch__pb2.DispatchList.FromString,
                )
        self.CreateMicrogridDispatch = channel.unary_unary(
                '/frequenz.api.dispatch.v1.MicrogridDispatchService/CreateMicrogridDispatch',
                request_serializer=frequenz_dot_api_dot_dispatch_dot_v1_dot_dispatch__pb2.DispatchCreateRequest.SerializeToString,
                response_deserializer=google_dot_protobuf_dot_empty__pb2.Empty.FromString,
                )
        self.UpdateMicrogridDispatch = channel.unary_unary(
                '/frequenz.api.dispatch.v1.MicrogridDispatchService/UpdateMicrogridDispatch',
                request_serializer=frequenz_dot_api_dot_dispatch_dot_v1_dot_dispatch__pb2.DispatchUpdateRequest.SerializeToString,
                response_deserializer=google_dot_protobuf_dot_empty__pb2.Empty.FromString,
                )
        self.GetMicrogridDispatch = channel.unary_unary(
                '/frequenz.api.dispatch.v1.MicrogridDispatchService/GetMicrogridDispatch',
                request_serializer=frequenz_dot_api_dot_dispatch_dot_v1_dot_dispatch__pb2.DispatchGetRequest.SerializeToString,
                response_deserializer=frequenz_dot_api_dot_dispatch_dot_v1_dot_dispatch__pb2.Dispatch.FromString,
                )
        self.DeleteMicrogridDispatch = channel.unary_unary(
                '/frequenz.api.dispatch.v1.MicrogridDispatchService/DeleteMicrogridDispatch',
                request_serializer=frequenz_dot_api_dot_dispatch_dot_v1_dot_dispatch__pb2.DispatchDeleteRequest.SerializeToString,
                response_deserializer=google_dot_protobuf_dot_empty__pb2.Empty.FromString,
                )
Attributes¤
CreateMicrogridDispatch instance-attribute ¤
CreateMicrogridDispatch: UnaryUnaryMultiCallable[
    DispatchCreateRequest, Empty
] = unary_unary(
    "/frequenz.api.dispatch.v1.MicrogridDispatchService/CreateMicrogridDispatch",
    request_serializer=SerializeToString,
    response_deserializer=FromString,
)

Create a new dispatch

DeleteMicrogridDispatch instance-attribute ¤
DeleteMicrogridDispatch: UnaryUnaryMultiCallable[
    DispatchDeleteRequest, Empty
] = unary_unary(
    "/frequenz.api.dispatch.v1.MicrogridDispatchService/DeleteMicrogridDispatch",
    request_serializer=SerializeToString,
    response_deserializer=FromString,
)

Delete a given dispatch

GetMicrogridDispatch instance-attribute ¤
GetMicrogridDispatch: UnaryUnaryMultiCallable[
    DispatchGetRequest, Dispatch
] = unary_unary(
    "/frequenz.api.dispatch.v1.MicrogridDispatchService/GetMicrogridDispatch",
    request_serializer=SerializeToString,
    response_deserializer=FromString,
)

Get a single dispatch

ListMicrogridDispatches instance-attribute ¤
ListMicrogridDispatches: UnaryUnaryMultiCallable[
    DispatchListRequest, DispatchList
] = unary_unary(
    "/frequenz.api.dispatch.v1.MicrogridDispatchService/ListMicrogridDispatches",
    request_serializer=SerializeToString,
    response_deserializer=FromString,
)

Returns a list of all dispatches

UpdateMicrogridDispatch instance-attribute ¤
UpdateMicrogridDispatch: UnaryUnaryMultiCallable[
    DispatchUpdateRequest, Empty
] = unary_unary(
    "/frequenz.api.dispatch.v1.MicrogridDispatchService/UpdateMicrogridDispatch",
    request_serializer=SerializeToString,
    response_deserializer=FromString,
)

Update a dispatch

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

Constructor.

PARAMETER DESCRIPTION
channel

A grpc.Channel.

TYPE: Union[Channel, Channel]

Source code in frequenz/api/dispatch/v1/dispatch_pb2_grpc.py
def __init__(self, channel):
    """Constructor.

    Args:
        channel: A grpc.Channel.
    """
    self.ListMicrogridDispatches = channel.unary_unary(
            '/frequenz.api.dispatch.v1.MicrogridDispatchService/ListMicrogridDispatches',
            request_serializer=frequenz_dot_api_dot_dispatch_dot_v1_dot_dispatch__pb2.DispatchListRequest.SerializeToString,
            response_deserializer=frequenz_dot_api_dot_dispatch_dot_v1_dot_dispatch__pb2.DispatchList.FromString,
            )
    self.CreateMicrogridDispatch = channel.unary_unary(
            '/frequenz.api.dispatch.v1.MicrogridDispatchService/CreateMicrogridDispatch',
            request_serializer=frequenz_dot_api_dot_dispatch_dot_v1_dot_dispatch__pb2.DispatchCreateRequest.SerializeToString,
            response_deserializer=google_dot_protobuf_dot_empty__pb2.Empty.FromString,
            )
    self.UpdateMicrogridDispatch = channel.unary_unary(
            '/frequenz.api.dispatch.v1.MicrogridDispatchService/UpdateMicrogridDispatch',
            request_serializer=frequenz_dot_api_dot_dispatch_dot_v1_dot_dispatch__pb2.DispatchUpdateRequest.SerializeToString,
            response_deserializer=google_dot_protobuf_dot_empty__pb2.Empty.FromString,
            )
    self.GetMicrogridDispatch = channel.unary_unary(
            '/frequenz.api.dispatch.v1.MicrogridDispatchService/GetMicrogridDispatch',
            request_serializer=frequenz_dot_api_dot_dispatch_dot_v1_dot_dispatch__pb2.DispatchGetRequest.SerializeToString,
            response_deserializer=frequenz_dot_api_dot_dispatch_dot_v1_dot_dispatch__pb2.Dispatch.FromString,
            )
    self.DeleteMicrogridDispatch = channel.unary_unary(
            '/frequenz.api.dispatch.v1.MicrogridDispatchService/DeleteMicrogridDispatch',
            request_serializer=frequenz_dot_api_dot_dispatch_dot_v1_dot_dispatch__pb2.DispatchDeleteRequest.SerializeToString,
            response_deserializer=google_dot_protobuf_dot_empty__pb2.Empty.FromString,
            )