@@ -634,7 +634,11 @@ def schedule_new_orchestration(self, orchestrator: task.Orchestrator[TInput, TOu
634634 reuse_id_policy : pb .OrchestrationIdReusePolicy | None = None ,
635635 tags : dict [str , str ] | None = None ,
636636 version : str | None = None ) -> str :
637+ """Schedule a new orchestration instance for execution.
637638
639+ If instance_id is not specified, a random UUID hex string is generated upfront
640+ and shared across both the OpenTelemetry producer span and the CreateInstanceRequest.
641+ """
638642 name = orchestrator if isinstance (orchestrator , str ) else task .get_name (orchestrator )
639643 resolved_instance_id = instance_id if instance_id else uuid .uuid4 ().hex
640644 resolved_version = version if version else self .default_version
@@ -1182,7 +1186,11 @@ async def schedule_new_orchestration(self, orchestrator: task.Orchestrator[TInpu
11821186 reuse_id_policy : pb .OrchestrationIdReusePolicy | None = None ,
11831187 tags : dict [str , str ] | None = None ,
11841188 version : str | None = None ) -> str :
1189+ """Schedule a new orchestration instance for execution asynchronously.
11851190
1191+ If instance_id is not specified, a random UUID hex string is generated upfront
1192+ and shared across both the OpenTelemetry producer span and the CreateInstanceRequest.
1193+ """
11861194 name = orchestrator if isinstance (orchestrator , str ) else task .get_name (orchestrator )
11871195 resolved_instance_id = instance_id if instance_id else uuid .uuid4 ().hex
11881196 resolved_version = version if version else self .default_version
0 commit comments