docs/gl_objects/resource_groups.rst


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
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()