From 151aede40adf0a273927dd506a2b1ae65967da2f Mon Sep 17 00:00:00 2001 From: Stefaan Lippens Date: Mon, 15 Jul 2024 17:02:53 +0200 Subject: [PATCH] Docs: clarify that budget might be ignored when creating job ref: https://github.com/Open-EO/openeo-api/issues/541 --- openeo/rest/connection.py | 5 +++-- openeo/rest/datacube.py | 5 +++-- openeo/rest/mlmodel.py | 5 +++-- openeo/rest/vectorcube.py | 5 +++-- 4 files changed, 12 insertions(+), 8 deletions(-) diff --git a/openeo/rest/connection.py b/openeo/rest/connection.py index b829b80a4..dac229b88 100644 --- a/openeo/rest/connection.py +++ b/openeo/rest/connection.py @@ -1714,8 +1714,9 @@ def create_job( or as local file path or URL :param title: job title :param description: job description - :param plan: billing plan - :param budget: maximum cost the request is allowed to produce + :param plan: The billing plan to process and charge the job with + :param budget: Maximum budget to be spent on executing the job. + Note that some backends do not honor this limit. :param additional: additional job options to pass to the backend :param validate: Optional toggle to enable/prevent validation of the process graphs before execution (overruling the connection's ``auto_validate`` setting). diff --git a/openeo/rest/datacube.py b/openeo/rest/datacube.py index 888f9f138..1c3f7682d 100644 --- a/openeo/rest/datacube.py +++ b/openeo/rest/datacube.py @@ -2268,8 +2268,9 @@ def create_job( :param out_format: output file format. :param title: job title :param description: job description - :param plan: billing plan - :param budget: maximum cost the request is allowed to produce + :param plan: The billing plan to process and charge the job with + :param budget: Maximum budget to be spent on executing the job. + Note that some backends do not honor this limit. :param job_options: custom job options. :param validate: Optional toggle to enable/prevent validation of the process graphs before execution (overruling the connection's ``auto_validate`` setting). diff --git a/openeo/rest/mlmodel.py b/openeo/rest/mlmodel.py index b2e012ab8..0ddb92598 100644 --- a/openeo/rest/mlmodel.py +++ b/openeo/rest/mlmodel.py @@ -96,8 +96,9 @@ def create_job( :param title: job title :param description: job description - :param plan: billing plan - :param budget: maximum cost the request is allowed to produce + :param plan: The billing plan to process and charge the job with + :param budget: Maximum budget to be spent on executing the job. + Note that some backends do not honor this limit. :param job_options: A dictionary containing (custom) job options :param format_options: String Parameters for the job result format :return: Created job. diff --git a/openeo/rest/vectorcube.py b/openeo/rest/vectorcube.py index a0302ecf6..80fe7ed86 100644 --- a/openeo/rest/vectorcube.py +++ b/openeo/rest/vectorcube.py @@ -320,8 +320,9 @@ def create_job( :param out_format: String Format of the job result. :param title: job title :param description: job description - :param plan: billing plan - :param budget: maximum cost the request is allowed to produce + :param plan: The billing plan to process and charge the job with + :param budget: Maximum budget to be spent on executing the job. + Note that some backends do not honor this limit. :param job_options: A dictionary containing (custom) job options :param format_options: String Parameters for the job result format :param validate: Optional toggle to enable/prevent validation of the process graphs before execution