---
updatedAt: 2025-12-03T17:42:42.000Z
agentTools:
  projectIndex: https://documentation.picsellia.com/llms.txt
---

# Job

#

# *Properties*

* `status` Status of this [Job](job)

***

# *Methods*

## wait\_for\_done

```python
wait_for_done(
   blocking_time_increment: float = 1.0, attempts: int = 20
)
```

**Description**

Wait for the job to be done.

**Examples**

```python
job.wait_for_done()
```

**Arguments**

* *blocking\_time\_increment*  : Time between each attempts

* *attempts*  : Number of attempts

***

## wait\_for\_status

```python
wait_for_status(
   statuses: (str|JobStatus|JobRunStatus|list[str|JobStatus|JobRunStatus]),
   blocking_time_increment: float = 1.0, attempts: int = 20
)
```

**Description**

Wait for the job to be in a specific status.

**Examples**

```python
job = client.get_job_by_id("job_id")
job.wait_for_status(JobStatus.SUCCESS)
```

**Arguments**

* *statuses*  : Status to wait for (JobStatus or JobRunStatus)

* *blocking\_time\_increment*  : Time between each attempts

* *attempts*  : Number of attempts

**Returns**

(JobStatus) or (JobRunStatus) of the job

***

## update\_job\_run\_with\_status

```python
update_job_run_with_status(
   status: JobRunStatus
)
```

**Description**

Update the job run with a new status.

**Examples**

```python
job.update_job_run_with_status(JobRunStatus.SUCCEEDED)
```

**Arguments**

* *status*  : New status of the job run

***

## send\_logging

```python
send_logging(
   log: (str|list), part: str, final: bool = False, special: (str|bool|list) = False
)
```

**Description**

Send a log entry to the job.

**Examples**

```python
job.send_logging("log1", "part1")
job.send_logging("log2", "part1")
job.send_logging("log3", "part2")
job.send_logging("log4", "part2", final=True)
```

**Arguments**

* *log* (str) : Log content

* *part* (str) : Logging Part

* *final* (bool, optional) : True if Final line. Defaults to False.

* *special* (bool, optional) : True if special log. Defaults to False.

***

## start\_logging\_chapter

```python
start_logging_chapter(
   name: str
)
```

**Description**

Start a logging chapter.

**Examples**

```python
job.start_logging_chapter("chapter1")
job.send_logging("log1")
job.send_logging("log2")
job.end_logging_chapter()
```

**Arguments**

* *name* (str) : Chapter name

***

## start\_logging\_buffer

```python
start_logging_buffer(
   length: int = 1
)
```

**Description**

Start a logging buffer.

**Examples**

```python
job.start_logging_buffer()
job.send_logging("log1")
job.send_logging("log2")
job.end_logging_buffer()
```

**Arguments**

* *length* (int, optional) : Buffer length. Defaults to 1.

***

## end\_logging\_buffer

```python
end_logging_buffer()
```

**Description**

End the logging buffer.

***

## store\_logging\_file

```python
store_logging_file(
   path: (str|Path)
)
```

**Description**

Store a logging file in the platform.

**Examples**

```python
job.store_logging_file("path/to/file")
```

**Arguments**

* *path* (str or Path) : path to the file or folder.

**Raises**

* *FileNotFoundException*  : No file found at the given path

**Returns**

Object name of logging file as string

***