diff options
Diffstat (limited to 'gitlab/v4/objects/sidekiq.py')
| -rw-r--r-- | gitlab/v4/objects/sidekiq.py | 56 |
1 files changed, 28 insertions, 28 deletions
diff --git a/gitlab/v4/objects/sidekiq.py b/gitlab/v4/objects/sidekiq.py index 9e00fe4..b42d1c6 100644 --- a/gitlab/v4/objects/sidekiq.py +++ b/gitlab/v4/objects/sidekiq.py @@ -23,15 +23,15 @@ class SidekiqManager(RESTManager): def queue_metrics(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]: """Return the registered queues information. - Args: - **kwargs: Extra options to send to the server (e.g. sudo) + Args: + **kwargs: Extra options to send to the server (e.g. sudo) - Raises: - GitlabAuthenticationError: If authentication is not correct - GitlabGetError: If the information couldn't be retrieved + Raises: + GitlabAuthenticationError: If authentication is not correct + GitlabGetError: If the information couldn't be retrieved - Returns: - dict: Information about the Sidekiq queues + Returns: + Information about the Sidekiq queues """ return self.gitlab.http_get("/sidekiq/queue_metrics", **kwargs) @@ -42,15 +42,15 @@ class SidekiqManager(RESTManager): ) -> Union[Dict[str, Any], requests.Response]: """Return the registered sidekiq workers. - Args: - **kwargs: Extra options to send to the server (e.g. sudo) + Args: + **kwargs: Extra options to send to the server (e.g. sudo) - Raises: - GitlabAuthenticationError: If authentication is not correct - GitlabGetError: If the information couldn't be retrieved + Raises: + GitlabAuthenticationError: If authentication is not correct + GitlabGetError: If the information couldn't be retrieved - Returns: - dict: Information about the register Sidekiq worker + Returns: + Information about the register Sidekiq worker """ return self.gitlab.http_get("/sidekiq/process_metrics", **kwargs) @@ -59,15 +59,15 @@ class SidekiqManager(RESTManager): def job_stats(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]: """Return statistics about the jobs performed. - Args: - **kwargs: Extra options to send to the server (e.g. sudo) + Args: + **kwargs: Extra options to send to the server (e.g. sudo) - Raises: - GitlabAuthenticationError: If authentication is not correct - GitlabGetError: If the information couldn't be retrieved + Raises: + GitlabAuthenticationError: If authentication is not correct + GitlabGetError: If the information couldn't be retrieved - Returns: - dict: Statistics about the Sidekiq jobs performed + Returns: + Statistics about the Sidekiq jobs performed """ return self.gitlab.http_get("/sidekiq/job_stats", **kwargs) @@ -78,14 +78,14 @@ class SidekiqManager(RESTManager): ) -> Union[Dict[str, Any], requests.Response]: """Return all available metrics and statistics. - Args: - **kwargs: Extra options to send to the server (e.g. sudo) + Args: + **kwargs: Extra options to send to the server (e.g. sudo) - Raises: - GitlabAuthenticationError: If authentication is not correct - GitlabGetError: If the information couldn't be retrieved + Raises: + GitlabAuthenticationError: If authentication is not correct + GitlabGetError: If the information couldn't be retrieved - Returns: - dict: All available Sidekiq metrics and statistics + Returns: + All available Sidekiq metrics and statistics """ return self.gitlab.http_get("/sidekiq/compound_metrics", **kwargs) |