summaryrefslogtreecommitdiff
path: root/gitlab/v4/objects/jobs.py
diff options
context:
space:
mode:
Diffstat (limited to 'gitlab/v4/objects/jobs.py')
-rw-r--r--gitlab/v4/objects/jobs.py44
1 files changed, 22 insertions, 22 deletions
diff --git a/gitlab/v4/objects/jobs.py b/gitlab/v4/objects/jobs.py
index eba9648..63cb5fd 100644
--- a/gitlab/v4/objects/jobs.py
+++ b/gitlab/v4/objects/jobs.py
@@ -123,12 +123,12 @@ class ProjectJob(RefreshMixin, RESTObject):
"""Get the job artifacts.
Args:
- streamed (bool): If True the data will be processed by chunks of
+ streamed: If True the data will be processed by chunks of
`chunk_size` and each chunk is passed to `action` for
treatment
action (callable): Callable responsible of dealing with chunk of
data
- chunk_size (int): Size of each chunk
+ chunk_size: Size of each chunk
**kwargs: Extra options to send to the server (e.g. sudo)
Raises:
@@ -136,7 +136,7 @@ class ProjectJob(RefreshMixin, RESTObject):
GitlabGetError: If the artifacts could not be retrieved
Returns:
- bytes: The artifacts if `streamed` is False, None otherwise.
+ The artifacts if `streamed` is False, None otherwise.
"""
path = f"{self.manager.path}/{self.get_id()}/artifacts"
result = self.manager.gitlab.http_get(
@@ -159,13 +159,13 @@ class ProjectJob(RefreshMixin, RESTObject):
"""Get a single artifact file from within the job's artifacts archive.
Args:
- path (str): Path of the artifact
- streamed (bool): If True the data will be processed by chunks of
+ path: Path of the artifact
+ streamed: If True the data will be processed by chunks of
`chunk_size` and each chunk is passed to `action` for
treatment
action (callable): Callable responsible of dealing with chunk of
data
- chunk_size (int): Size of each chunk
+ chunk_size: Size of each chunk
**kwargs: Extra options to send to the server (e.g. sudo)
Raises:
@@ -173,7 +173,7 @@ class ProjectJob(RefreshMixin, RESTObject):
GitlabGetError: If the artifacts could not be retrieved
Returns:
- bytes: The artifacts if `streamed` is False, None otherwise.
+ The artifacts if `streamed` is False, None otherwise.
"""
path = f"{self.manager.path}/{self.get_id()}/artifacts/{path}"
result = self.manager.gitlab.http_get(
@@ -194,21 +194,21 @@ class ProjectJob(RefreshMixin, RESTObject):
) -> Dict[str, Any]:
"""Get the job trace.
- Args:
- streamed (bool): If True the data will be processed by chunks of
- `chunk_size` and each chunk is passed to `action` for
- treatment
- action (callable): Callable responsible of dealing with chunk of
- data
- chunk_size (int): Size of each chunk
- **kwargs: Extra options to send to the server (e.g. sudo)
-
- Raises:
- GitlabAuthenticationError: If authentication is not correct
- GitlabGetError: If the artifacts could not be retrieved
-
- Returns:
- str: The trace
+ Args:
+ streamed: If True the data will be processed by chunks of
+ `chunk_size` and each chunk is passed to `action` for
+ treatment
+ action (callable): Callable responsible of dealing with chunk of
+ data
+ chunk_size: Size of each chunk
+ **kwargs: Extra options to send to the server (e.g. sudo)
+
+ Raises:
+ GitlabAuthenticationError: If authentication is not correct
+ GitlabGetError: If the artifacts could not be retrieved
+
+ Returns:
+ The trace
"""
path = f"{self.manager.path}/{self.get_id()}/trace"
result = self.manager.gitlab.http_get(