Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
masipauskas committed Nov 14, 2024
1 parent 92dbc22 commit d2896cd
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 1 deletion.
2 changes: 1 addition & 1 deletion client/python/docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
import os
import sys

sys.path.insert(0, os.path.abspath("../.."))
# sys.path.insert(0, os.path.abspath("../.."))


# -- Project information -----------------------------------------------------
Expand Down
53 changes: 53 additions & 0 deletions docs/python_armada_client.md
Original file line number Diff line number Diff line change
Expand Up @@ -657,3 +657,56 @@ Convert this Subject to a grpc Subject.


## armada_client.log_client module


### _class_ armada_client.log_client.JobLogClient(url, job_id, disable_ssl=False)
Client for retrieving logs for a given job.


* **Parameters**


* **url** (*str*) – The url to use for retreiving logs.


* **job_id** (*str*) – The ID of the job.


* **disable_ssl** (*bool*) –



* **Returns**

A JobLogClient instance.



#### logs(since_time='')
Retrieve logs for the job associated with this client.


* **Parameters**

**since_time** (*str** | **None*) – Logs will be retrieved starting at the time
specified in this str. Must conform to RFC3339 date time format.



* **Returns**

A list of LogLine objects.



### _class_ armada_client.log_client.LogLine(line, timestamp)
Represents a single line from a log.


* **Parameters**


* **line** (*str*) –


* **timestamp** (*str*) –

0 comments on commit d2896cd

Please sign in to comment.