Skip to content

docs: [google-cloud-batch] Refine description for field task_execution #12693

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
parthea merged 5 commits into from
May 14, 2024
Merged

docs: [google-cloud-batch] Refine description for field task_execution #12693

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
14551d3
docs: Refine description for field `task_execution`
gcf-owl-bot[bot] May 13, 2024
91ed17b
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] May 13, 2024
1a71fca
docs: Refine description for field `task_execution`
gcf-owl-bot[bot] May 14, 2024
b63e041
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] May 14, 2024
c077ebe
See https://github.com/googleapis/gapic-generator-python/issues/1722
parthea May 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions packages/google-cloud-batch/google/cloud/batch_v1/types/task.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,9 +155,22 @@ class TaskExecution(proto.Message):

Attributes:
exit_code (int):
When task is completed as the status of
FAILED or SUCCEEDED, exit code is for one task
execution result, default is 0 as success.
The exit code of a finished task.

If the task succeeded, the exit code will be 0.
If the task failed but not due to the following
reasons, the exit code will be 50000.

Otherwise, it can be from different sources:

- Batch known failures as
https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes.
- Batch runnable execution failures: You can
rely on Batch logs for further diagnose:
https://cloud.google.com/batch/docs/analyze-job-using-logs.
If there are multiple runnables failures,
Batch only exposes the first error caught for
now.
"""

exit_code: int = proto.Field(
Expand Down
19 changes: 16 additions & 3 deletions packages/google-cloud-batch/google/cloud/batch_v1alpha/types/task.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,9 +164,22 @@ class TaskExecution(proto.Message):

Attributes:
exit_code (int):
When task is completed as the status of
FAILED or SUCCEEDED, exit code is for one task
execution result, default is 0 as success.
The exit code of a finished task.

If the task succeeded, the exit code will be 0.
If the task failed but not due to the following
reasons, the exit code will be 50000.

Otherwise, it can be from different sources:

- Batch known failures as
https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes.
- Batch runnable execution failures: You can
rely on Batch logs for further diagnose:
https://cloud.google.com/batch/docs/analyze-job-using-logs.
If there are multiple runnables failures,
Batch only exposes the first error caught for
now.
stderr_snippet (str):
Optional. The tail end of any content written
to standard error by the task execution. This
Expand Down