docs: update Python SDK API reference (next)#8144
Open
camunda-docs-pr-automation[bot] wants to merge 1 commit intomainfrom
Open
docs: update Python SDK API reference (next)#8144camunda-docs-pr-automation[bot] wants to merge 1 commit intomainfrom
camunda-docs-pr-automation[bot] wants to merge 1 commit intomainfrom
Conversation
camunda-docs-pr-automation
bot
added
the
deploy
Contributor
|
👋 🤖 🤔 Hello, @camunda-docs-pr-automation[bot]! Did you make your changes in all the right places? These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.8/.
You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines. |
camunda-docs-pr-automation
bot
force-pushed
the
update-python-sdk-docs
branch
from
777e62f to
a6914a4
Compare
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Comment on lines
1151
to
1158
| * **Parameters:** | ||
| * **config** ([*WorkerConfig*](runtime.md#camunda_orchestration_sdk.runtime.job_worker.WorkerConfig)) | ||
| * **callback** (*Callable* *[* *[*[*JobContext*](runtime.md#camunda_orchestration_sdk.runtime.job_worker.JobContext) *]* *,* *Coroutine* *[**Any* *,* *Any* *,* *dict* *[**str* *,* *Any* *]* *|* *JobCompletionRequest* *|* *None* *]* *]* *|* *Callable* *[* *[*[*JobContext*](runtime.md#camunda_orchestration_sdk.runtime.job_worker.JobContext) *]* *,* *dict* *[**str* *,* *Any* *]* *|* *None* *]* *|* [*HintedCallable*](runtime.md#camunda_orchestration_sdk.runtime.job_worker.HintedCallable)) | ||
| * **callback** (*Callable* *[* *[*[*ConnectedJobContext*](runtime.md#camunda_orchestration_sdk.runtime.job_worker.ConnectedJobContext) *]* *,* *Coroutine* *[**Any* *,* *Any* *,* *dict* *[**str* *,* *Any* *]* *|* *JobCompletionRequest* *|* *None* *]* *]* *|* *Callable* *[* *[*[*ConnectedJobContext*](runtime.md#camunda_orchestration_sdk.runtime.job_worker.ConnectedJobContext) *]* *,* *dict* *[**str* *,* *Any* *]* *|* *None* *]* *|* *Callable* *[* *[*[*JobContext*](runtime.md#camunda_orchestration_sdk.runtime.job_worker.JobContext) *]* *,* *Coroutine* *[**Any* *,* *Any* *,* *dict* *[**str* *,* *Any* *]* *|* *JobCompletionRequest* *|* *None* *]* *]* *|* *Callable* *[* *[*[*JobContext*](runtime.md#camunda_orchestration_sdk.runtime.job_worker.JobContext) *]* *,* *dict* *[**str* *,* *Any* *]* *|* *None* *]*) | ||
| * **auto_start** (*bool*) | ||
| * **execution_strategy** (*Literal* *[* *'auto'* *,* *'async'* *,* *'thread'* *,* *'process'* *]*) | ||
| * **startup_jitter_max_seconds** (*float*) | ||
| * **Return type:** | ||
| [*JobWorker*](runtime.md#camunda_orchestration_sdk.runtime.job_worker.JobWorker) |
Contributor
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
Suggested change
| * **Parameters:** | |
| * **config** ([*WorkerConfig*](runtime.md#camunda_orchestration_sdk.runtime.job_worker.WorkerConfig)) | |
| * **callback** (*Callable* *[* *[*[*JobContext*](runtime.md#camunda_orchestration_sdk.runtime.job_worker.JobContext) *]* *,* *Coroutine* *[**Any* *,* *Any* *,* *dict* *[**str* *,* *Any* *]* *|* *JobCompletionRequest* *|* *None* *]* *]* *|* *Callable* *[* *[*[*JobContext*](runtime.md#camunda_orchestration_sdk.runtime.job_worker.JobContext) *]* *,* *dict* *[**str* *,* *Any* *]* *|* *None* *]* *|* [*HintedCallable*](runtime.md#camunda_orchestration_sdk.runtime.job_worker.HintedCallable)) | |
| * **callback** (*Callable* *[* *[*[*ConnectedJobContext*](runtime.md#camunda_orchestration_sdk.runtime.job_worker.ConnectedJobContext) *]* *,* *Coroutine* *[**Any* *,* *Any* *,* *dict* *[**str* *,* *Any* *]* *|* *JobCompletionRequest* *|* *None* *]* *]* *|* *Callable* *[* *[*[*ConnectedJobContext*](runtime.md#camunda_orchestration_sdk.runtime.job_worker.ConnectedJobContext) *]* *,* *dict* *[**str* *,* *Any* *]* *|* *None* *]* *|* *Callable* *[* *[*[*JobContext*](runtime.md#camunda_orchestration_sdk.runtime.job_worker.JobContext) *]* *,* *Coroutine* *[**Any* *,* *Any* *,* *dict* *[**str* *,* *Any* *]* *|* *JobCompletionRequest* *|* *None* *]* *]* *|* *Callable* *[* *[*[*JobContext*](runtime.md#camunda_orchestration_sdk.runtime.job_worker.JobContext) *]* *,* *dict* *[**str* *,* *Any* *]* *|* *None* *]*) | |
| * **auto_start** (*bool*) | |
| * **execution_strategy** (*Literal* *[* *'auto'* *,* *'async'* *,* *'thread'* *,* *'process'* *]*) | |
| * **startup_jitter_max_seconds** (*float*) | |
| * **Return type:** | |
| [*JobWorker*](runtime.md#camunda_orchestration_sdk.runtime.job_worker.JobWorker) | |
| - **Parameters:** | |
| - **config** ([_WorkerConfig_](runtime.md#camunda_orchestration_sdk.runtime.job_worker.WorkerConfig)) | |
| - **callback** (_Callable_ _[_ _[_[_ConnectedJobContext_](runtime.md#camunda_orchestration_sdk.runtime.job_worker.ConnectedJobContext) _]_ _,_ _Coroutine_ _[\*\*Any_ _,_ _Any_ _,_ _dict_ _[\*\*str_ _,_ _Any_ _]_ _|_ _JobCompletionRequest_ _|_ _None_ _]_ _]_ _|_ _Callable_ _[_ _[_[_ConnectedJobContext_](runtime.md#camunda_orchestration_sdk.runtime.job_worker.ConnectedJobContext) _]_ _,_ _dict_ _[\*\*str_ _,_ _Any_ _]_ _|_ _None_ _]_ _|_ _Callable_ _[_ _[_[_JobContext_](runtime.md#camunda_orchestration_sdk.runtime.job_worker.JobContext) _]_ _,_ _Coroutine_ _[\*\*Any_ _,_ _Any_ _,_ _dict_ _[\*\*str_ _,_ _Any_ _]_ _|_ _JobCompletionRequest_ _|_ _None_ _]_ _]_ _|_ _Callable_ _[_ _[_[_JobContext_](runtime.md#camunda_orchestration_sdk.runtime.job_worker.JobContext) _]_ _,_ _dict_ _[\*\*str_ _,_ _Any_ _]_ _|_ _None_ _]_) | |
| - **auto_start** (_bool_) | |
| - **execution_strategy** (_Literal_ _[_ _'auto'_ _,_ _'async'_ _,_ _'thread'_ _,_ _'process'_ _]_) | |
| - **startup_jitter_max_seconds** (_float_) | |
| - **Return type:** | |
| [_JobWorker_](runtime.md#camunda_orchestration_sdk.runtime.job_worker.JobWorker) |
Comment on lines
+2358
to
+2368
| * **Parameters:** | ||
| * **id** (*str*) – The user-defined id for the global listener Example: GlobalListener_1. | ||
| * **kwargs** (*Any*) | ||
| * **Raises:** | ||
| * **errors.GetGlobalTaskListenerUnauthorized** – If the response status code is 401. The request lacks valid authentication credentials. | ||
| * **errors.GetGlobalTaskListenerForbidden** – If the response status code is 403. Forbidden. The request is not allowed. | ||
| * **errors.GetGlobalTaskListenerNotFound** – If the response status code is 404. The global user task listener with the given id was not found. | ||
| * **errors.GetGlobalTaskListenerInternalServerError** – If the response status code is 500. An internal error occurred while processing the request. | ||
| * **errors.UnexpectedStatus** – If the response status code is not documented. | ||
| * **httpx.TimeoutException** – If the request takes longer than Client.timeout. | ||
| * **Returns:** |
Contributor
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
Suggested change
| * **Parameters:** | |
| * **id** (*str*) – The user-defined id for the global listener Example: GlobalListener_1. | |
| * **kwargs** (*Any*) | |
| * **Raises:** | |
| * **errors.GetGlobalTaskListenerUnauthorized** – If the response status code is 401. The request lacks valid authentication credentials. | |
| * **errors.GetGlobalTaskListenerForbidden** – If the response status code is 403. Forbidden. The request is not allowed. | |
| * **errors.GetGlobalTaskListenerNotFound** – If the response status code is 404. The global user task listener with the given id was not found. | |
| * **errors.GetGlobalTaskListenerInternalServerError** – If the response status code is 500. An internal error occurred while processing the request. | |
| * **errors.UnexpectedStatus** – If the response status code is not documented. | |
| * **httpx.TimeoutException** – If the request takes longer than Client.timeout. | |
| * **Returns:** | |
| - **Parameters:** | |
| - **id** (_str_) – The user-defined id for the global listener Example: GlobalListener_1. | |
| - **kwargs** (_Any_) | |
| - **Raises:** | |
| - **errors.GetGlobalTaskListenerUnauthorized** – If the response status code is 401. The request lacks valid authentication credentials. | |
| - **errors.GetGlobalTaskListenerForbidden** – If the response status code is 403. Forbidden. The request is not allowed. | |
| - **errors.GetGlobalTaskListenerNotFound** – If the response status code is 404. The global user task listener with the given id was not found. | |
| - **errors.GetGlobalTaskListenerInternalServerError** – If the response status code is 500. An internal error occurred while processing the request. | |
| - **errors.UnexpectedStatus** – If the response status code is not documented. | |
| - **httpx.TimeoutException** – If the request takes longer than Client.timeout. | |
| - **Returns:** |
| * **httpx.TimeoutException** – If the request takes longer than Client.timeout. | ||
| * **Returns:** | ||
| GlobalTaskListenerResult | ||
| * **Return type:** |
Contributor
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
Suggested change
| * **Return type:** | |
| - **Return type:** |
Comment on lines
+2444
to
+2455
| * **Parameters:** | ||
| * **body** (*JobTypeStatisticsQuery*) – Job type statistics query. | ||
| * **data** (*JobTypeStatisticsQuery*) | ||
| * **kwargs** (*Any*) | ||
| * **Raises:** | ||
| * **errors.GetJobTypeStatisticsBadRequest** – If the response status code is 400. The provided data is not valid. | ||
| * **errors.GetJobTypeStatisticsUnauthorized** – If the response status code is 401. The request lacks valid authentication credentials. | ||
| * **errors.GetJobTypeStatisticsForbidden** – If the response status code is 403. Forbidden. The request is not allowed. | ||
| * **errors.GetJobTypeStatisticsInternalServerError** – If the response status code is 500. An internal error occurred while processing the request. | ||
| * **errors.UnexpectedStatus** – If the response status code is not documented. | ||
| * **httpx.TimeoutException** – If the request takes longer than Client.timeout. | ||
| * **Returns:** |
Contributor
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
Suggested change
| * **Parameters:** | |
| * **body** (*JobTypeStatisticsQuery*) – Job type statistics query. | |
| * **data** (*JobTypeStatisticsQuery*) | |
| * **kwargs** (*Any*) | |
| * **Raises:** | |
| * **errors.GetJobTypeStatisticsBadRequest** – If the response status code is 400. The provided data is not valid. | |
| * **errors.GetJobTypeStatisticsUnauthorized** – If the response status code is 401. The request lacks valid authentication credentials. | |
| * **errors.GetJobTypeStatisticsForbidden** – If the response status code is 403. Forbidden. The request is not allowed. | |
| * **errors.GetJobTypeStatisticsInternalServerError** – If the response status code is 500. An internal error occurred while processing the request. | |
| * **errors.UnexpectedStatus** – If the response status code is not documented. | |
| * **httpx.TimeoutException** – If the request takes longer than Client.timeout. | |
| * **Returns:** | |
| - **Parameters:** | |
| - **body** (_JobTypeStatisticsQuery_) – Job type statistics query. | |
| - **data** (_JobTypeStatisticsQuery_) | |
| - **kwargs** (_Any_) | |
| - **Raises:** | |
| - **errors.GetJobTypeStatisticsBadRequest** – If the response status code is 400. The provided data is not valid. | |
| - **errors.GetJobTypeStatisticsUnauthorized** – If the response status code is 401. The request lacks valid authentication credentials. | |
| - **errors.GetJobTypeStatisticsForbidden** – If the response status code is 403. Forbidden. The request is not allowed. | |
| - **errors.GetJobTypeStatisticsInternalServerError** – If the response status code is 500. An internal error occurred while processing the request. | |
| - **errors.UnexpectedStatus** – If the response status code is not documented. | |
| - **httpx.TimeoutException** – If the request takes longer than Client.timeout. | |
| - **Returns:** |
| * **httpx.TimeoutException** – If the request takes longer than Client.timeout. | ||
| * **Returns:** | ||
| JobTypeStatisticsQueryResult | ||
| * **Return type:** |
Contributor
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
Suggested change
| * **Return type:** | |
| - **Return type:** |
| ``` | ||
|
|
||
| Bases: `Protocol` | ||
| ### *classmethod* create(job, client, logger=None) |
Contributor
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
Suggested change
| ### *classmethod* create(job, client, logger=None) | |
| ### _classmethod_ create(job, client, logger=None) |
Comment on lines
+527
to
+531
| * **Parameters:** | ||
| * **job** (*ActivatedJobResult*) | ||
| * **client** ([*CamundaAsyncClient*](async-client.md#camunda_orchestration_sdk.CamundaAsyncClient)) | ||
| * **logger** ([*SdkLogger*](#sdklogger) *|* *None*) | ||
| * **Return type:** |
Contributor
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
Suggested change
| * **Parameters:** | |
| * **job** (*ActivatedJobResult*) | |
| * **client** ([*CamundaAsyncClient*](async-client.md#camunda_orchestration_sdk.CamundaAsyncClient)) | |
| * **logger** ([*SdkLogger*](#sdklogger) *|* *None*) | |
| * **Return type:** | |
| - **Parameters:** | |
| - **job** (_ActivatedJobResult_) | |
| - **client** ([_CamundaAsyncClient_](async-client.md#camunda_orchestration_sdk.CamundaAsyncClient)) | |
| - **logger** ([_SdkLogger_](#sdklogger) _|_ _None_) | |
| - **Return type:** |
Comment on lines
+61
to
+64
| * **Parameters:** | ||
| **value** (*Any*) | ||
| * **Return type:** | ||
| *BusinessId* |
Contributor
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
Suggested change
| * **Parameters:** | |
| **value** (*Any*) | |
| * **Return type:** | |
| *BusinessId* | |
| - **Parameters:** | |
| **value** (_Any_) | |
| - **Return type:** | |
| _BusinessId_ |
Comment on lines
+446
to
+449
| * **Parameters:** | ||
| **value** (*Any*) | ||
| * **Return type:** | ||
| *Tuple*[bool, *BusinessId* | Exception] |
Contributor
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
Suggested change
| * **Parameters:** | |
| **value** (*Any*) | |
| * **Return type:** | |
| *Tuple*[bool, *BusinessId* | Exception] | |
| - **Parameters:** | |
| **value** (_Any_) | |
| - **Return type:** | |
| _Tuple_[bool, *BusinessId* | Exception] |
Comment on lines
+117
to
+120
| | Parameter | Default | Description | | ||
| |-----------|---------|-------------| | ||
| | `execution_strategy` | `"auto"` | `"auto"`, `"async"`, `"thread"`, or `"process"`. Controls how the handler is invoked and which context type it receives. | | ||
| | `startup_jitter_max_seconds` | `0` | Maximum random delay (in seconds) before the worker starts polling. When multiple application instances restart simultaneously, this spreads out initial activation requests to avoid saturating the server. A value of `0` (the default) means no delay. | |
Contributor
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
Suggested change
| | Parameter | Default | Description | | |
| |-----------|---------|-------------| | |
| | `execution_strategy` | `"auto"` | `"auto"`, `"async"`, `"thread"`, or `"process"`. Controls how the handler is invoked and which context type it receives. | | |
| | `startup_jitter_max_seconds` | `0` | Maximum random delay (in seconds) before the worker starts polling. When multiple application instances restart simultaneously, this spreads out initial activation requests to avoid saturating the server. A value of `0` (the default) means no delay. | | |
| | Parameter | Default | Description | | |
| | ---------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | |
| | `execution_strategy` | `"auto"` | `"auto"`, `"async"`, `"thread"`, or `"process"`. Controls how the handler is invoked and which context type it receives. | | |
| | `startup_jitter_max_seconds` | `0` | Maximum random delay (in seconds) before the worker starts polling. When multiple application instances restart simultaneously, this spreads out initial activation requests to avoid saturating the server. A value of `0` (the default) means no delay. | |
Contributor
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
camunda-docs/docs/apis-tools/python-sdk/api-reference/index.md
Lines 11 to 93 in a6914a4
Contributor
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
camunda-docs/docs/apis-tools/python-sdk/api-reference/runtime.md
Lines 544 to 564 in a6914a4
Contributor
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
camunda-docs/docs/apis-tools/python-sdk/api-reference/runtime.md
Lines 618 to 624 in a6914a4
Contributor
|
The preview environment relating to the commit ca14a18 has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-8144/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Auto-generated PR from the sync Python SDK docs workflow.
Updates the Python SDK API reference documentation from
orchestration-cluster-api-python@main.Target:
docs/apis-tools/python-sdk/When should this change go live?
PR Checklist
/docs.