summaryrefslogtreecommitdiff
path: root/docs/gl_objects
diff options
context:
space:
mode:
authorNejc Habjan <nejc.habjan@siemens.com>2022-11-27 00:11:32 +0100
committerJohn Villalovos <john@sodarock.com>2022-12-18 01:13:20 -0600
commit5f8b8f5be901e944dfab2257f9e0cc4b2b1d2cd5 (patch)
tree30d3b0fa7103cc52829979af1578f2c4bebff4b5 /docs/gl_objects
parent1816107b8d87614e7947837778978d8de8da450f (diff)
downloadgitlab-5f8b8f5be901e944dfab2257f9e0cc4b2b1d2cd5.tar.gz
feat(api): add support for resource groups
Diffstat (limited to 'docs/gl_objects')
-rw-r--r--docs/gl_objects/resource_groups.rst38
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/gl_objects/resource_groups.rst b/docs/gl_objects/resource_groups.rst
new file mode 100644
index 0000000..3fa0f92
--- /dev/null
+++ b/docs/gl_objects/resource_groups.rst
@@ -0,0 +1,38 @@
+###############
+Resource Groups
+###############
+
+Reference
+---------
+
+* v4 API:
+
+ + :class:`gitlab.v4.objects.ProjectResourceGroup`
+ + :class:`gitlab.v4.objects.ProjectResourceGroupManager`
+ + :attr:`gitlab.v4.objects.Project.resource_groups`
+ + :class:`gitlab.v4.objects.ProjectResourceGroupUpcomingJob`
+ + :class:`gitlab.v4.objects.ProjectResourceGroupUpcomingJobManager`
+ + :attr:`gitlab.v4.objects.ProjectResourceGroup.upcoming_jobs`
+
+* Gitlab API: https://docs.gitlab.com/ee/api/resource_groups.html
+
+Examples
+--------
+
+List resource groups for a project::
+
+ project = gl.projects.get(project_id, lazy=True)
+ resource_group = project.resource_groups.list()
+
+Get a single resource group::
+
+ resource_group = project.resource_groups.get("production")
+
+Edit a resource group::
+
+ resource_group.process_mode = "oldest_first"
+ resource_group.save()
+
+List upcoming jobs for a resource group::
+
+ upcoming_jobs = resource_group.upcoming_jobs.list()