boulder-opal-scale-up-sdk 1.0.0__py3-none-any.whl

boulderopalscaleupsdk/protobuf/v1/device_pb2_grpc.py

@@ -0,0 +1,274 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+
+from boulderopalscaleupsdk.protobuf.v1 import device_pb2 as boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2
+
+
+class DeviceManagerServiceStub(object):
+    """Device manager service.
+    """
+
+    def __init__(self, channel):
+        """Constructor.
+
+        Args:
+            channel: A grpc.Channel.
+        """
+        self.Create = channel.unary_unary(
+                '/boulderopalscaleupsdk.protobuf.v1.DeviceManagerService/Create',
+                request_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.CreateRequest.SerializeToString,
+                response_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.CreateResponse.FromString,
+                )
+        self.Load = channel.unary_unary(
+                '/boulderopalscaleupsdk.protobuf.v1.DeviceManagerService/Load',
+                request_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.LoadRequest.SerializeToString,
+                response_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.LoadResponse.FromString,
+                )
+        self.Update = channel.unary_unary(
+                '/boulderopalscaleupsdk.protobuf.v1.DeviceManagerService/Update',
+                request_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.UpdateRequest.SerializeToString,
+                response_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.UpdateResponse.FromString,
+                )
+        self.Delete = channel.unary_unary(
+                '/boulderopalscaleupsdk.protobuf.v1.DeviceManagerService/Delete',
+                request_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.DeleteRequest.SerializeToString,
+                response_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.DeleteResponse.FromString,
+                )
+        self.ListJobs = channel.unary_unary(
+                '/boulderopalscaleupsdk.protobuf.v1.DeviceManagerService/ListJobs',
+                request_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.ListJobsRequest.SerializeToString,
+                response_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.ListJobsResponse.FromString,
+                )
+        self.GetJob = channel.unary_unary(
+                '/boulderopalscaleupsdk.protobuf.v1.DeviceManagerService/GetJob',
+                request_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.GetJobRequest.SerializeToString,
+                response_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.GetJobResponse.FromString,
+                )
+        self.GetJobSummary = channel.unary_unary(
+                '/boulderopalscaleupsdk.protobuf.v1.DeviceManagerService/GetJobSummary',
+                request_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.GetJobSummaryRequest.SerializeToString,
+                response_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.GetJobSummaryResponse.FromString,
+                )
+
+
+class DeviceManagerServiceServicer(object):
+    """Device manager service.
+    """
+
+    def Create(self, request, context):
+        """Create the device and controller states.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def Load(self, request, context):
+        """Load the device and controller states.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def Update(self, request, context):
+        """Update the device and controller states.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def Delete(self, request, context):
+        """Delete the device and controller states.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def ListJobs(self, request, context):
+        """Fetch all the experiments that have been run on the device.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def GetJob(self, request, context):
+        """Fetch the results of a specific job executed on the device previously.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def GetJobSummary(self, request, context):
+        """Fetch the results view of a previously executed job.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+
+def add_DeviceManagerServiceServicer_to_server(servicer, server):
+    rpc_method_handlers = {
+            'Create': grpc.unary_unary_rpc_method_handler(
+                    servicer.Create,
+                    request_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.CreateRequest.FromString,
+                    response_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.CreateResponse.SerializeToString,
+            ),
+            'Load': grpc.unary_unary_rpc_method_handler(
+                    servicer.Load,
+                    request_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.LoadRequest.FromString,
+                    response_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.LoadResponse.SerializeToString,
+            ),
+            'Update': grpc.unary_unary_rpc_method_handler(
+                    servicer.Update,
+                    request_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.UpdateRequest.FromString,
+                    response_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.UpdateResponse.SerializeToString,
+            ),
+            'Delete': grpc.unary_unary_rpc_method_handler(
+                    servicer.Delete,
+                    request_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.DeleteRequest.FromString,
+                    response_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.DeleteResponse.SerializeToString,
+            ),
+            'ListJobs': grpc.unary_unary_rpc_method_handler(
+                    servicer.ListJobs,
+                    request_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.ListJobsRequest.FromString,
+                    response_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.ListJobsResponse.SerializeToString,
+            ),
+            'GetJob': grpc.unary_unary_rpc_method_handler(
+                    servicer.GetJob,
+                    request_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.GetJobRequest.FromString,
+                    response_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.GetJobResponse.SerializeToString,
+            ),
+            'GetJobSummary': grpc.unary_unary_rpc_method_handler(
+                    servicer.GetJobSummary,
+                    request_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.GetJobSummaryRequest.FromString,
+                    response_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.GetJobSummaryResponse.SerializeToString,
+            ),
+    }
+    generic_handler = grpc.method_handlers_generic_handler(
+            'boulderopalscaleupsdk.protobuf.v1.DeviceManagerService', rpc_method_handlers)
+    server.add_generic_rpc_handlers((generic_handler,))
+
+
+ # This class is part of an EXPERIMENTAL API.
+class DeviceManagerService(object):
+    """Device manager service.
+    """
+
+    @staticmethod
+    def Create(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, '/boulderopalscaleupsdk.protobuf.v1.DeviceManagerService/Create',
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.CreateRequest.SerializeToString,
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.CreateResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+    def Load(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, '/boulderopalscaleupsdk.protobuf.v1.DeviceManagerService/Load',
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.LoadRequest.SerializeToString,
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.LoadResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+    def Update(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, '/boulderopalscaleupsdk.protobuf.v1.DeviceManagerService/Update',
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.UpdateRequest.SerializeToString,
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.UpdateResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+    def Delete(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, '/boulderopalscaleupsdk.protobuf.v1.DeviceManagerService/Delete',
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.DeleteRequest.SerializeToString,
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.DeleteResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+    def ListJobs(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, '/boulderopalscaleupsdk.protobuf.v1.DeviceManagerService/ListJobs',
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.ListJobsRequest.SerializeToString,
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.ListJobsResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+    def GetJob(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, '/boulderopalscaleupsdk.protobuf.v1.DeviceManagerService/GetJob',
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.GetJobRequest.SerializeToString,
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.GetJobResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+    def GetJobSummary(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, '/boulderopalscaleupsdk.protobuf.v1.DeviceManagerService/GetJobSummary',
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.GetJobSummaryRequest.SerializeToString,
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_device__pb2.GetJobSummaryResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)

boulderopalscaleupsdk/protobuf/v1/task_pb2.py

@@ -0,0 +1,53 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: boulderopalscaleupsdk/protobuf/v1/task.proto
+# Protobuf Python Version: 5.26.1
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+from google.api import annotations_pb2 as google_dot_api_dot_annotations__pb2
+from google.protobuf import any_pb2 as google_dot_protobuf_dot_any__pb2
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n,boulderopalscaleupsdk/protobuf/v1/task.proto\x12!boulderopalscaleupsdk.protobuf.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x19google/protobuf/any.proto\"\xc7\x01\n\x13StartSessionRequest\x12\x19\n\x08\x61gent_id\x18\x01 \x01(\tR\x07\x61gentId\x12\x19\n\x08\x61pp_name\x18\x02 \x01(\tR\x07\x61ppName\x12\x1f\n\x0b\x64\x65vice_name\x18\x03 \x01(\tR\ndeviceName\x12!\n\x0croutine_name\x18\x04 \x01(\tR\x0broutineName\x12-\n\x04\x64\x61ta\x18\x05 \x01(\x0b\x32\x14.google.protobuf.AnyH\x00R\x04\x64\x61ta\x88\x01\x01\x42\x07\n\x05_data\"\xfc\x01\n\x14UpdateSessionRequest\x12\x1d\n\nsession_id\x18\x01 \x01(\tR\tsessionId\x12R\n\rcurrent_state\x18\x02 \x01(\x0e\x32-.boulderopalscaleupsdk.protobuf.v1.AgentStateR\x0c\x63urrentState\x12G\n\x07results\x18\x03 \x03(\x0b\x32-.boulderopalscaleupsdk.protobuf.v1.TaskResultR\x07results\x12(\n\x10task_in_progress\x18\x04 \x03(\tR\x0etaskInProgress\"\xac\x03\n\x12\x41gentTasksResponse\x12\x1d\n\nsession_id\x18\x01 \x01(\tR\tsessionId\x12U\n\x0ctarget_state\x18\x02 \x01(\x0e\x32-.boulderopalscaleupsdk.protobuf.v1.AgentStateH\x00R\x0btargetState\x88\x01\x01\x12=\n\x05tasks\x18\x03 \x03(\x0b\x32\'.boulderopalscaleupsdk.protobuf.v1.TaskR\x05tasks\x12)\n\x10invalidate_tasks\x18\x04 \x03(\tR\x0finvalidateTasks\x12\x66\n\x0bretry_tasks\x18\x05 \x03(\x0b\x32\x45.boulderopalscaleupsdk.protobuf.v1.AgentTasksResponse.RetryTasksEntryR\nretryTasks\x1a=\n\x0fRetryTasksEntry\x12\x10\n\x03key\x18\x01 \x01(\tR\x03key\x12\x14\n\x05value\x18\x02 \x01(\tR\x05value:\x02\x38\x01\x42\x0f\n\r_target_state\"\x94\x02\n\x04Task\x12\x17\n\x07task_id\x18\x01 \x01(\tR\x06taskId\x12\x1d\n\nsession_id\x18\x02 \x01(\tR\tsessionId\x12\x1b\n\ttask_type\x18\x03 \x01(\tR\x08taskType\x12(\n\x04\x64\x61ta\x18\x04 \x01(\x0b\x32\x14.google.protobuf.AnyR\x04\x64\x61ta\x12,\n\x0ftimeout_seconds\x18\x05 \x01(\x05H\x00R\x0etimeoutSeconds\x88\x01\x01\x12\x1f\n\x08\x64\x65\x61\x64line\x18\x06 \x01(\x03H\x01R\x08\x64\x65\x61\x64line\x88\x01\x01\x12\x1d\n\ndepends_on\x18\x07 \x03(\tR\tdependsOnB\x12\n\x10_timeout_secondsB\x0b\n\t_deadline\"\xed\x01\n\nTaskResult\x12\x17\n\x07task_id\x18\x01 \x01(\tR\x06taskId\x12\x1d\n\nsession_id\x18\x03 \x01(\tR\tsessionId\x12\x1f\n\x0bresult_type\x18\x04 \x01(\tR\nresultType\x12.\n\x06result\x18\x05 \x01(\x0b\x32\x14.google.protobuf.AnyH\x00R\x06result\x12J\n\x05\x65rror\x18\x06 \x01(\x0b\x32\x32.boulderopalscaleupsdk.protobuf.v1.TaskErrorDetailH\x00R\x05\x65rrorB\n\n\x08response\"{\n\x0fTaskErrorDetail\x12@\n\x04\x63ode\x18\x01 \x01(\x0e\x32,.boulderopalscaleupsdk.protobuf.v1.TaskErrorR\x04\x63ode\x12\x1b\n\x06\x64\x65tail\x18\x02 \x01(\tH\x00R\x06\x64\x65tail\x88\x01\x01\x42\t\n\x07_detail*\xdd\x01\n\nAgentState\x12\x1b\n\x17\x41GENT_STATE_UNSPECIFIED\x10\x00\x12\x1e\n\x1a\x41GENT_STATE_ACTIVE_SESSION\x10\x01\x12\x1b\n\x17\x41GENT_STATE_ACTIVE_IDLE\x10\x02\x12)\n%AGENT_STATE_SHUTDOWN_CLIENT_INITIATED\x10\x03\x12*\n&AGENT_STATE_SHUTDOWN_MANAGER_INITIATED\x10\x04\x12\x1e\n\x1a\x41GENT_STATE_SHUTDOWN_FAULT\x10\x05*G\n\tTaskError\x12\x1a\n\x16TASK_ERROR_UNSPECIFIED\x10\x00\x12\x1e\n\x1aTASK_ERROR_NOT_IMPLEMENTED\x10\x01\x32\xe0\x02\n\x13\x41gentManagerService\x12\xa1\x01\n\x0cStartSession\x12\x36.boulderopalscaleupsdk.protobuf.v1.StartSessionRequest\x1a\x35.boulderopalscaleupsdk.protobuf.v1.AgentTasksResponse\"\"\x82\xd3\xe4\x93\x02\x1c\"\x17/v1/agent/start_session:\x01*\x12\xa4\x01\n\rUpdateSession\x12\x37.boulderopalscaleupsdk.protobuf.v1.UpdateSessionRequest\x1a\x35.boulderopalscaleupsdk.protobuf.v1.AgentTasksResponse\"#\x82\xd3\xe4\x93\x02\x1d\"\x18/v1/agent/update_session:\x01*B\xa8\x02\n%com.boulderopalscaleupsdk.protobuf.v1B\tTaskProtoP\x01ZNgithub.com/qctrl/boulder-opal-scale-up/proto/boulderopalscaleupsdk/protobuf/v1\xa2\x02\x03\x42PX\xaa\x02!Boulderopalscaleupsdk.Protobuf.V1\xca\x02!Boulderopalscaleupsdk\\Protobuf\\V1\xe2\x02-Boulderopalscaleupsdk\\Protobuf\\V1\\GPBMetadata\xea\x02#Boulderopalscaleupsdk::Protobuf::V1b\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'boulderopalscaleupsdk.protobuf.v1.task_pb2', _globals)
+if not _descriptor._USE_C_DESCRIPTORS:
+  _globals['DESCRIPTOR']._loaded_options = None
+  _globals['DESCRIPTOR']._serialized_options = b'\n%com.boulderopalscaleupsdk.protobuf.v1B\tTaskProtoP\001ZNgithub.com/qctrl/boulder-opal-scale-up/proto/boulderopalscaleupsdk/protobuf/v1\242\002\003BPX\252\002!Boulderopalscaleupsdk.Protobuf.V1\312\002!Boulderopalscaleupsdk\\Protobuf\\V1\342\002-Boulderopalscaleupsdk\\Protobuf\\V1\\GPBMetadata\352\002#Boulderopalscaleupsdk::Protobuf::V1'
+  _globals['_AGENTTASKSRESPONSE_RETRYTASKSENTRY']._loaded_options = None
+  _globals['_AGENTTASKSRESPONSE_RETRYTASKSENTRY']._serialized_options = b'8\001'
+  _globals['_AGENTMANAGERSERVICE'].methods_by_name['StartSession']._loaded_options = None
+  _globals['_AGENTMANAGERSERVICE'].methods_by_name['StartSession']._serialized_options = b'\202\323\344\223\002\034\"\027/v1/agent/start_session:\001*'
+  _globals['_AGENTMANAGERSERVICE'].methods_by_name['UpdateSession']._loaded_options = None
+  _globals['_AGENTMANAGERSERVICE'].methods_by_name['UpdateSession']._serialized_options = b'\202\323\344\223\002\035\"\030/v1/agent/update_session:\001*'
+  _globals['_AGENTSTATE']._serialized_start=1673
+  _globals['_AGENTSTATE']._serialized_end=1894
+  _globals['_TASKERROR']._serialized_start=1896
+  _globals['_TASKERROR']._serialized_end=1967
+  _globals['_STARTSESSIONREQUEST']._serialized_start=141
+  _globals['_STARTSESSIONREQUEST']._serialized_end=340
+  _globals['_UPDATESESSIONREQUEST']._serialized_start=343
+  _globals['_UPDATESESSIONREQUEST']._serialized_end=595
+  _globals['_AGENTTASKSRESPONSE']._serialized_start=598
+  _globals['_AGENTTASKSRESPONSE']._serialized_end=1026
+  _globals['_AGENTTASKSRESPONSE_RETRYTASKSENTRY']._serialized_start=948
+  _globals['_AGENTTASKSRESPONSE_RETRYTASKSENTRY']._serialized_end=1009
+  _globals['_TASK']._serialized_start=1029
+  _globals['_TASK']._serialized_end=1305
+  _globals['_TASKRESULT']._serialized_start=1308
+  _globals['_TASKRESULT']._serialized_end=1545
+  _globals['_TASKERRORDETAIL']._serialized_start=1547
+  _globals['_TASKERRORDETAIL']._serialized_end=1670
+  _globals['_AGENTMANAGERSERVICE']._serialized_start=1970
+  _globals['_AGENTMANAGERSERVICE']._serialized_end=2322
+# @@protoc_insertion_point(module_scope)

boulderopalscaleupsdk/protobuf/v1/task_pb2.pyi

@@ -0,0 +1,118 @@
+from google.api import annotations_pb2 as _annotations_pb2
+from google.protobuf import any_pb2 as _any_pb2
+from google.protobuf.internal import containers as _containers
+from google.protobuf.internal import enum_type_wrapper as _enum_type_wrapper
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import message as _message
+from typing import ClassVar as _ClassVar, Iterable as _Iterable, Mapping as _Mapping, Optional as _Optional, Union as _Union
+
+DESCRIPTOR: _descriptor.FileDescriptor
+
+class AgentState(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
+    __slots__ = ()
+    AGENT_STATE_UNSPECIFIED: _ClassVar[AgentState]
+    AGENT_STATE_ACTIVE_SESSION: _ClassVar[AgentState]
+    AGENT_STATE_ACTIVE_IDLE: _ClassVar[AgentState]
+    AGENT_STATE_SHUTDOWN_CLIENT_INITIATED: _ClassVar[AgentState]
+    AGENT_STATE_SHUTDOWN_MANAGER_INITIATED: _ClassVar[AgentState]
+    AGENT_STATE_SHUTDOWN_FAULT: _ClassVar[AgentState]
+
+class TaskError(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
+    __slots__ = ()
+    TASK_ERROR_UNSPECIFIED: _ClassVar[TaskError]
+    TASK_ERROR_NOT_IMPLEMENTED: _ClassVar[TaskError]
+AGENT_STATE_UNSPECIFIED: AgentState
+AGENT_STATE_ACTIVE_SESSION: AgentState
+AGENT_STATE_ACTIVE_IDLE: AgentState
+AGENT_STATE_SHUTDOWN_CLIENT_INITIATED: AgentState
+AGENT_STATE_SHUTDOWN_MANAGER_INITIATED: AgentState
+AGENT_STATE_SHUTDOWN_FAULT: AgentState
+TASK_ERROR_UNSPECIFIED: TaskError
+TASK_ERROR_NOT_IMPLEMENTED: TaskError
+
+class StartSessionRequest(_message.Message):
+    __slots__ = ("agent_id", "app_name", "device_name", "routine_name", "data")
+    AGENT_ID_FIELD_NUMBER: _ClassVar[int]
+    APP_NAME_FIELD_NUMBER: _ClassVar[int]
+    DEVICE_NAME_FIELD_NUMBER: _ClassVar[int]
+    ROUTINE_NAME_FIELD_NUMBER: _ClassVar[int]
+    DATA_FIELD_NUMBER: _ClassVar[int]
+    agent_id: str
+    app_name: str
+    device_name: str
+    routine_name: str
+    data: _any_pb2.Any
+    def __init__(self, agent_id: _Optional[str] = ..., app_name: _Optional[str] = ..., device_name: _Optional[str] = ..., routine_name: _Optional[str] = ..., data: _Optional[_Union[_any_pb2.Any, _Mapping]] = ...) -> None: ...
+
+class UpdateSessionRequest(_message.Message):
+    __slots__ = ("session_id", "current_state", "results", "task_in_progress")
+    SESSION_ID_FIELD_NUMBER: _ClassVar[int]
+    CURRENT_STATE_FIELD_NUMBER: _ClassVar[int]
+    RESULTS_FIELD_NUMBER: _ClassVar[int]
+    TASK_IN_PROGRESS_FIELD_NUMBER: _ClassVar[int]
+    session_id: str
+    current_state: AgentState
+    results: _containers.RepeatedCompositeFieldContainer[TaskResult]
+    task_in_progress: _containers.RepeatedScalarFieldContainer[str]
+    def __init__(self, session_id: _Optional[str] = ..., current_state: _Optional[_Union[AgentState, str]] = ..., results: _Optional[_Iterable[_Union[TaskResult, _Mapping]]] = ..., task_in_progress: _Optional[_Iterable[str]] = ...) -> None: ...
+
+class AgentTasksResponse(_message.Message):
+    __slots__ = ("session_id", "target_state", "tasks", "invalidate_tasks", "retry_tasks")
+    class RetryTasksEntry(_message.Message):
+        __slots__ = ("key", "value")
+        KEY_FIELD_NUMBER: _ClassVar[int]
+        VALUE_FIELD_NUMBER: _ClassVar[int]
+        key: str
+        value: str
+        def __init__(self, key: _Optional[str] = ..., value: _Optional[str] = ...) -> None: ...
+    SESSION_ID_FIELD_NUMBER: _ClassVar[int]
+    TARGET_STATE_FIELD_NUMBER: _ClassVar[int]
+    TASKS_FIELD_NUMBER: _ClassVar[int]
+    INVALIDATE_TASKS_FIELD_NUMBER: _ClassVar[int]
+    RETRY_TASKS_FIELD_NUMBER: _ClassVar[int]
+    session_id: str
+    target_state: AgentState
+    tasks: _containers.RepeatedCompositeFieldContainer[Task]
+    invalidate_tasks: _containers.RepeatedScalarFieldContainer[str]
+    retry_tasks: _containers.ScalarMap[str, str]
+    def __init__(self, session_id: _Optional[str] = ..., target_state: _Optional[_Union[AgentState, str]] = ..., tasks: _Optional[_Iterable[_Union[Task, _Mapping]]] = ..., invalidate_tasks: _Optional[_Iterable[str]] = ..., retry_tasks: _Optional[_Mapping[str, str]] = ...) -> None: ...
+
+class Task(_message.Message):
+    __slots__ = ("task_id", "session_id", "task_type", "data", "timeout_seconds", "deadline", "depends_on")
+    TASK_ID_FIELD_NUMBER: _ClassVar[int]
+    SESSION_ID_FIELD_NUMBER: _ClassVar[int]
+    TASK_TYPE_FIELD_NUMBER: _ClassVar[int]
+    DATA_FIELD_NUMBER: _ClassVar[int]
+    TIMEOUT_SECONDS_FIELD_NUMBER: _ClassVar[int]
+    DEADLINE_FIELD_NUMBER: _ClassVar[int]
+    DEPENDS_ON_FIELD_NUMBER: _ClassVar[int]
+    task_id: str
+    session_id: str
+    task_type: str
+    data: _any_pb2.Any
+    timeout_seconds: int
+    deadline: int
+    depends_on: _containers.RepeatedScalarFieldContainer[str]
+    def __init__(self, task_id: _Optional[str] = ..., session_id: _Optional[str] = ..., task_type: _Optional[str] = ..., data: _Optional[_Union[_any_pb2.Any, _Mapping]] = ..., timeout_seconds: _Optional[int] = ..., deadline: _Optional[int] = ..., depends_on: _Optional[_Iterable[str]] = ...) -> None: ...
+
+class TaskResult(_message.Message):
+    __slots__ = ("task_id", "session_id", "result_type", "result", "error")
+    TASK_ID_FIELD_NUMBER: _ClassVar[int]
+    SESSION_ID_FIELD_NUMBER: _ClassVar[int]
+    RESULT_TYPE_FIELD_NUMBER: _ClassVar[int]
+    RESULT_FIELD_NUMBER: _ClassVar[int]
+    ERROR_FIELD_NUMBER: _ClassVar[int]
+    task_id: str
+    session_id: str
+    result_type: str
+    result: _any_pb2.Any
+    error: TaskErrorDetail
+    def __init__(self, task_id: _Optional[str] = ..., session_id: _Optional[str] = ..., result_type: _Optional[str] = ..., result: _Optional[_Union[_any_pb2.Any, _Mapping]] = ..., error: _Optional[_Union[TaskErrorDetail, _Mapping]] = ...) -> None: ...
+
+class TaskErrorDetail(_message.Message):
+    __slots__ = ("code", "detail")
+    CODE_FIELD_NUMBER: _ClassVar[int]
+    DETAIL_FIELD_NUMBER: _ClassVar[int]
+    code: TaskError
+    detail: str
+    def __init__(self, code: _Optional[_Union[TaskError, str]] = ..., detail: _Optional[str] = ...) -> None: ...

boulderopalscaleupsdk/protobuf/v1/task_pb2_grpc.py

@@ -0,0 +1,119 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+
+from boulderopalscaleupsdk.protobuf.v1 import task_pb2 as boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_task__pb2
+
+
+class AgentManagerServiceStub(object):
+    """Agents are responsible for communicating with the remote AgentManager service
+    to determine a set of tasks to perform (generally, QPU tasks such as
+    execution of quantum circuits / configuration). Importantly, to both simplify
+    and ensure the security of the QPU adjacent host that the agent will run on,
+    the agent must initiate all communications (as opposed to opening a port on
+    the host).
+    """
+
+    def __init__(self, channel):
+        """Constructor.
+
+        Args:
+            channel: A grpc.Channel.
+        """
+        self.StartSession = channel.unary_unary(
+                '/boulderopalscaleupsdk.protobuf.v1.AgentManagerService/StartSession',
+                request_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_task__pb2.StartSessionRequest.SerializeToString,
+                response_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_task__pb2.AgentTasksResponse.FromString,
+                )
+        self.UpdateSession = channel.unary_unary(
+                '/boulderopalscaleupsdk.protobuf.v1.AgentManagerService/UpdateSession',
+                request_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_task__pb2.UpdateSessionRequest.SerializeToString,
+                response_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_task__pb2.AgentTasksResponse.FromString,
+                )
+
+
+class AgentManagerServiceServicer(object):
+    """Agents are responsible for communicating with the remote AgentManager service
+    to determine a set of tasks to perform (generally, QPU tasks such as
+    execution of quantum circuits / configuration). Importantly, to both simplify
+    and ensure the security of the QPU adjacent host that the agent will run on,
+    the agent must initiate all communications (as opposed to opening a port on
+    the host).
+    """
+
+    def StartSession(self, request, context):
+        """Start the session.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def UpdateSession(self, request, context):
+        """Update the session.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+
+def add_AgentManagerServiceServicer_to_server(servicer, server):
+    rpc_method_handlers = {
+            'StartSession': grpc.unary_unary_rpc_method_handler(
+                    servicer.StartSession,
+                    request_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_task__pb2.StartSessionRequest.FromString,
+                    response_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_task__pb2.AgentTasksResponse.SerializeToString,
+            ),
+            'UpdateSession': grpc.unary_unary_rpc_method_handler(
+                    servicer.UpdateSession,
+                    request_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_task__pb2.UpdateSessionRequest.FromString,
+                    response_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_task__pb2.AgentTasksResponse.SerializeToString,
+            ),
+    }
+    generic_handler = grpc.method_handlers_generic_handler(
+            'boulderopalscaleupsdk.protobuf.v1.AgentManagerService', rpc_method_handlers)
+    server.add_generic_rpc_handlers((generic_handler,))
+
+
+ # This class is part of an EXPERIMENTAL API.
+class AgentManagerService(object):
+    """Agents are responsible for communicating with the remote AgentManager service
+    to determine a set of tasks to perform (generally, QPU tasks such as
+    execution of quantum circuits / configuration). Importantly, to both simplify
+    and ensure the security of the QPU adjacent host that the agent will run on,
+    the agent must initiate all communications (as opposed to opening a port on
+    the host).
+    """
+
+    @staticmethod
+    def StartSession(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, '/boulderopalscaleupsdk.protobuf.v1.AgentManagerService/StartSession',
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_task__pb2.StartSessionRequest.SerializeToString,
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_task__pb2.AgentTasksResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+    def UpdateSession(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, '/boulderopalscaleupsdk.protobuf.v1.AgentManagerService/UpdateSession',
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_task__pb2.UpdateSessionRequest.SerializeToString,
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_task__pb2.AgentTasksResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)

boulderopalscaleupsdk/routines/__init__.py

@@ -0,0 +1,9 @@
+"""Routine library."""
+
+__all__ = [
+    "ResonatorMapping",
+    "Routine",
+]
+
+from .common import Routine
+from .resonator_mapping import ResonatorMapping

boulderopalscaleupsdk/routines/common.py

@@ -0,0 +1,10 @@
+from pydantic import BaseModel, ConfigDict
+
+
+class Routine(BaseModel):
+    model_config = ConfigDict(extra="forbid")
+    _routine_name: str
+
+    @property
+    def routine_name(self) -> str:
+        return self._routine_name

boulderopalscaleupsdk/routines/resonator_mapping.py

@@ -0,0 +1,13 @@
+from pydantic import PrivateAttr
+
+from boulderopalscaleupsdk.routines.common import Routine
+
+
+class ResonatorMapping(Routine):
+    """
+    Parameters for running a resonator mapping routine.
+    """
+
+    _routine_name: str = PrivateAttr("resonator_mapping")
+
+    feedlines: list[str]

boulderopalscaleupsdk/third_party/__init__.py

@@ -0,0 +1,14 @@
+# Copyright 2025 Q-CTRL. All rights reserved.
+#
+# Licensed under the Q-CTRL Terms of service (the "License"). Unauthorized
+# copying or use of this file, via any medium, is strictly prohibited.
+# Proprietary and confidential. You may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+#    https://q-ctrl.com/terms
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS. See the
+# License for the specific language.
+
+"""Third party imports and configuration."""