Skip to content

Commit 151aede

Browse files
committed
Docs: clarify that budget might be ignored when creating job
ref: Open-EO/openeo-api#541
1 parent fede931 commit 151aede

File tree

4 files changed

+12
-8
lines changed

4 files changed

+12
-8
lines changed

openeo/rest/connection.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -1714,8 +1714,9 @@ def create_job(
17141714
or as local file path or URL
17151715
:param title: job title
17161716
:param description: job description
1717-
:param plan: billing plan
1718-
:param budget: maximum cost the request is allowed to produce
1717+
:param plan: The billing plan to process and charge the job with
1718+
:param budget: Maximum budget to be spent on executing the job.
1719+
Note that some backends do not honor this limit.
17191720
:param additional: additional job options to pass to the backend
17201721
:param validate: Optional toggle to enable/prevent validation of the process graphs before execution
17211722
(overruling the connection's ``auto_validate`` setting).

openeo/rest/datacube.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -2268,8 +2268,9 @@ def create_job(
22682268
:param out_format: output file format.
22692269
:param title: job title
22702270
:param description: job description
2271-
:param plan: billing plan
2272-
:param budget: maximum cost the request is allowed to produce
2271+
:param plan: The billing plan to process and charge the job with
2272+
:param budget: Maximum budget to be spent on executing the job.
2273+
Note that some backends do not honor this limit.
22732274
:param job_options: custom job options.
22742275
:param validate: Optional toggle to enable/prevent validation of the process graphs before execution
22752276
(overruling the connection's ``auto_validate`` setting).

openeo/rest/mlmodel.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,9 @@ def create_job(
9696
9797
:param title: job title
9898
:param description: job description
99-
:param plan: billing plan
100-
:param budget: maximum cost the request is allowed to produce
99+
:param plan: The billing plan to process and charge the job with
100+
:param budget: Maximum budget to be spent on executing the job.
101+
Note that some backends do not honor this limit.
101102
:param job_options: A dictionary containing (custom) job options
102103
:param format_options: String Parameters for the job result format
103104
:return: Created job.

openeo/rest/vectorcube.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -320,8 +320,9 @@ def create_job(
320320
:param out_format: String Format of the job result.
321321
:param title: job title
322322
:param description: job description
323-
:param plan: billing plan
324-
:param budget: maximum cost the request is allowed to produce
323+
:param plan: The billing plan to process and charge the job with
324+
:param budget: Maximum budget to be spent on executing the job.
325+
Note that some backends do not honor this limit.
325326
:param job_options: A dictionary containing (custom) job options
326327
:param format_options: String Parameters for the job result format
327328
:param validate: Optional toggle to enable/prevent validation of the process graphs before execution

0 commit comments

Comments
 (0)