gitlab.v4 package#

Submodules#

gitlab.v4.objects module#

class gitlab.v4.objects.Application(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ApplicationAppearance(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ApplicationAppearanceManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.mixins.UpdateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.appearance.ApplicationAppearance]#

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.appearance.ApplicationAppearance]

gitlab: gitlab.client.Gitlab#
update(id: Optional[Union[int, str]] = None, new_data: Dict[str, Any] = None, **kwargs: Any) → Dict[str, Any]#

Update an object on the server.

Parameters

  • id (Optional[Union[int, str]]) – ID of the object to update (can be None if not required)

  • new_data (Dict[str, Any]) – the update data for the object

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The new object data (not a RESTObject)

Raises
Return type

Dict[str, Any]

class gitlab.v4.objects.ApplicationManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.mixins.CreateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ApplicationSettings(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ApplicationSettingsManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.mixins.UpdateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.settings.ApplicationSettings]#

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.settings.ApplicationSettings]

gitlab: gitlab.client.Gitlab#
update(id: Optional[Union[int, str]] = None, new_data: Dict[str, Any] = None, **kwargs: Any) → Dict[str, Any]#

Update an object on the server.

Parameters

  • id (Optional[Union[int, str]]) – ID of the object to update (can be None if not required)

  • new_data (Dict[str, Any]) – the update data for the object

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The new object data (not a RESTObject)

Raises
Return type

Dict[str, Any]

class gitlab.v4.objects.AuditEvent(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.AuditEventManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object listing filters

  • created_after

  • created_before

  • entity_type

  • entity_id

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.audit_events.AuditEvent#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.audit_events.AuditEvent

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.BroadcastMessage(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.BroadcastMessageManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.broadcast_messages.BroadcastMessage#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.broadcast_messages.BroadcastMessage

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.CurrentUser(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

emails: gitlab.v4.objects.users.CurrentUserEmailManager#
gpgkeys: gitlab.v4.objects.users.CurrentUserGPGKeyManager#
keys: gitlab.v4.objects.users.CurrentUserKeyManager#
status: gitlab.v4.objects.users.CurrentUserStatusManager#
class gitlab.v4.objects.CurrentUserEmail(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.CurrentUserEmailManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.CreateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.users.CurrentUserEmail#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.users.CurrentUserEmail

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.CurrentUserGPGKey(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.CurrentUserGPGKeyManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.CreateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.users.CurrentUserGPGKey#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.users.CurrentUserGPGKey

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.CurrentUserKey(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.CurrentUserKeyManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.CreateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.users.CurrentUserKey#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.users.CurrentUserKey

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.CurrentUserManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.users.CurrentUser]#

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.users.CurrentUser]

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.CurrentUserStatus(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.CurrentUserStatusManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.mixins.UpdateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.users.CurrentUserStatus]#

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.users.CurrentUserStatus]

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.DeployKey(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.DeployKeyManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.DeployToken(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.DeployTokenManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.Dockerfile(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.DockerfileManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.templates.Dockerfile#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.templates.Dockerfile

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.Event(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.EventManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object listing filters

  • action

  • target_type

  • before

  • after

  • sort

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.Feature(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.FeatureManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
set(name: str, value: Union[bool, int], feature_group: Optional[str] = None, user: Optional[str] = None, group: Optional[str] = None, project: Optional[str] = None, **kwargs: Any) → gitlab.v4.objects.features.Feature#

Create or update the object.

Parameters

  • name (str) – The value to set for the object

  • value (Union[bool, int]) – The value to set for the object

  • feature_group (Optional[str]) – A feature group name

  • user (Optional[str]) – A GitLab username

  • group (Optional[str]) – A GitLab group

  • project (Optional[str]) – A GitLab project in form group/project

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The created/updated attribute

Return type

gitlab.v4.objects.features.Feature

class gitlab.v4.objects.GenericPackage(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GenericPackageManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

download(package_name: str, package_version: str, file_name: str, streamed: bool = False, action: Optional[Callable] = None, chunk_size: int = 1024, **kwargs: Any) → Optional[bytes]#

Download a generic package.

Parameters

  • package_name (str) – The package name.

  • package_version (str) – The package version.

  • file_name (str) – The name of the file in the registry

  • streamed (bool) – If True the data will be processed by chunks of chunk_size and each chunk is passed to action for treatment

  • action (Optional[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)

  • kwargs (Any) –

Raises
Returns

The package content if streamed is False, None otherwise

Return type

Optional[bytes]

gitlab: gitlab.client.Gitlab#
upload(package_name: str, package_version: str, file_name: str, path: Union[str, pathlib.Path], **kwargs: Any) → gitlab.v4.objects.packages.GenericPackage#

Upload a file as a generic package.

Parameters

  • package_name (str) – The package name. Must follow generic package name regex rules

  • package_version (str) – The package version. Must follow semantic version regex rules

  • file_name (str) – The name of the file as uploaded in the registry

  • path (Union[str, pathlib.Path]) – The path to a local file to upload

  • kwargs (Any) –

Raises
Returns

An object storing the metadata of the uploaded package.

Return type

gitlab.v4.objects.packages.GenericPackage

https://docs.gitlab.com/ee/user/packages/generic_packages/

class gitlab.v4.objects.GeoNode(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
repair(**kwargs: Any) → None#

Repair the OAuth authentication of the geo node.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

status(**kwargs: Any) → Dict[str, Any]#

Get the status of the geo node.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The status of the geo node

Return type

Dict[str, Any]

class gitlab.v4.objects.GeoNodeManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.UpdateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

current_failures(**kwargs: Any) → List[Dict[str, Any]]#

Get the list of failures on the current geo node.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The list of failures

Return type

List[Dict[str, Any]]

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.geo_nodes.GeoNode#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.geo_nodes.GeoNode

gitlab: gitlab.client.Gitlab#
status(**kwargs: Any) → List[Dict[str, Any]]#

Get the status of all the geo nodes.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The status of all the geo nodes

Return type

List[Dict[str, Any]]

class gitlab.v4.objects.Gitignore(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GitignoreManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.templates.Gitignore#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.templates.Gitignore

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.Gitlabciyml(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GitlabciymlManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.templates.Gitlabciyml#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.templates.Gitlabciyml

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.Group(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

access_tokens: gitlab.v4.objects.group_access_tokens.GroupAccessTokenManager#
accessrequests: gitlab.v4.objects.access_requests.GroupAccessRequestManager#

Add an LDAP group link.

Parameters

  • cn (str) – CN of the LDAP group

  • group_access (int) – Minimum access level for members of the LDAP group

  • provider (str) – LDAP provider for the LDAP group

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

audit_events: gitlab.v4.objects.audit_events.GroupAuditEventManager#
badges: gitlab.v4.objects.badges.GroupBadgeManager#
billable_members: gitlab.v4.objects.members.GroupBillableMemberManager#
boards: gitlab.v4.objects.boards.GroupBoardManager#
clusters: gitlab.v4.objects.clusters.GroupClusterManager#
customattributes: gitlab.v4.objects.custom_attributes.GroupCustomAttributeManager#

Delete an LDAP group link.

Parameters

  • cn (str) – CN of the LDAP group

  • provider (Optional[str]) – LDAP provider for the LDAP group

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

deploytokens: gitlab.v4.objects.deploy_tokens.GroupDeployTokenManager#
descendant_groups: GroupDescendantGroupManager#
epics: gitlab.v4.objects.epics.GroupEpicManager#
exports: gitlab.v4.objects.export_import.GroupExportManager#
hooks: gitlab.v4.objects.hooks.GroupHookManager#
imports: gitlab.v4.objects.export_import.GroupImportManager#
issues: gitlab.v4.objects.issues.GroupIssueManager#
issues_statistics: gitlab.v4.objects.statistics.GroupIssuesStatisticsManager#
labels: gitlab.v4.objects.labels.GroupLabelManager#
ldap_sync(**kwargs: Any) → None#

Sync LDAP groups.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

members: gitlab.v4.objects.members.GroupMemberManager#
members_all: gitlab.v4.objects.members.GroupMemberAllManager#
mergerequests: gitlab.v4.objects.merge_requests.GroupMergeRequestManager#
milestones: gitlab.v4.objects.milestones.GroupMilestoneManager#
notificationsettings: gitlab.v4.objects.notification_settings.GroupNotificationSettingsManager#
packages: gitlab.v4.objects.packages.GroupPackageManager#
projects: gitlab.v4.objects.projects.GroupProjectManager#
runners: gitlab.v4.objects.runners.GroupRunnerManager#
search(scope: str, search: str, **kwargs: Any) → Union[gitlab.client.GitlabList, List[Dict[str, Any]]]#

Search the group resources matching the provided string.

Parameters

  • scope (str) – Scope of the search

  • search (str) – Search string

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

A list of dicts describing the resources found.

Return type

Union[gitlab.client.GitlabList, List[Dict[str, Any]]]

share(group_id: int, group_access: int, expires_at: Optional[str] = None, **kwargs: Any) → None#

Share the group with a group.

Parameters

  • group_id (int) – ID of the group.

  • group_access (int) – Access level for the group.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • expires_at (Optional[str]) –

  • kwargs (Any) –

Raises
Returns

Group

Return type

None

subgroups: GroupSubgroupManager#
transfer(group_id: Optional[int] = None, **kwargs: Any) → None#

Transfer the group to a new parent group or make it a top-level group.

Requires GitLab ≥14.6.

Parameters

  • group_id (Optional[int]) – ID of the new parent group. When not specified, the group to transfer is instead turned into a top-level group.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

transfer_project(project_id: int, **kwargs: Any) → None#

Transfer a project to this group.

Parameters

  • to_project_id – ID of the project to transfer

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • project_id (int) –

  • kwargs (Any) –

Raises
Return type

None

unshare(group_id: int, **kwargs: Any) → None#

Delete a shared group link within a group.

Parameters

  • group_id (int) – ID of the group.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

variables: gitlab.v4.objects.variables.GroupVariableManager#
wikis: gitlab.v4.objects.wikis.GroupWikiManager#
class gitlab.v4.objects.GroupAccessRequest(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.AccessRequestMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupAccessRequestManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.mixins.CreateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupAccessToken(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupAccessTokenManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.mixins.CreateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupAuditEvent(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupAuditEventManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object listing filters

  • created_after

  • created_before

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.audit_events.GroupAuditEvent#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.audit_events.GroupAuditEvent

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupBadge(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupBadgeManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.BadgeRenderMixin, gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.badges.GroupBadge#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.badges.GroupBadge

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupBillableMember(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

memberships: GroupBillableMemberMembershipManager#
class gitlab.v4.objects.GroupBillableMemberManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object listing filters

  • search

  • sort

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupBillableMemberMembership(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupBillableMemberMembershipManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupBoard(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

lists: gitlab.v4.objects.boards.GroupBoardListManager#
class gitlab.v4.objects.GroupBoardList(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupBoardListManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.boards.GroupBoardList#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.boards.GroupBoardList

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupBoardManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.boards.GroupBoard#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.boards.GroupBoard

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupCluster(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupClusterManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

create(data: Optional[Dict[str, Any]] = None, **kwargs: Any) → gitlab.v4.objects.clusters.GroupCluster#

Create a new object.

Parameters

  • data (Optional[Dict[str, Any]]) – Parameters to send to the server to create the resource

  • **kwargs – Extra options to send to the server (e.g. sudo or ‘ref_name’, ‘stage’, ‘name’, ‘all’)

  • kwargs (Any) –

Raises
Returns

A new instance of the manage object class build with

the data sent by the server

Return type

gitlab.v4.objects.clusters.GroupCluster

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.clusters.GroupCluster#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.clusters.GroupCluster

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupCustomAttribute(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupCustomAttributeManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.SetMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.custom_attributes.GroupCustomAttribute#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.custom_attributes.GroupCustomAttribute

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupDeployToken(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupDeployTokenManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.CreateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.deploy_tokens.GroupDeployToken#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.deploy_tokens.GroupDeployToken

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupDescendantGroup(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupDescendantGroupManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.v4.objects.groups.GroupSubgroupManager

This manager inherits from GroupSubgroupManager as descendant groups share all attributes with subgroups, except the path and object class.

Object listing filters

  • skip_groups

  • all_available

  • search

  • order_by

  • sort

  • statistics

  • owned

  • with_custom_attributes

  • min_access_level

Object Creation

Object update

Parameters
Return type

None

class gitlab.v4.objects.GroupEpic(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.mixins.SaveMixin, gitlab.base.RESTObject

Parameters
Return type

None

issues: GroupEpicIssueManager#
resourcelabelevents: gitlab.v4.objects.events.GroupEpicResourceLabelEventManager#
class gitlab.v4.objects.GroupEpicAwardEmoji(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupEpicAwardEmojiManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.NoUpdateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.award_emojis.GroupEpicAwardEmoji#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.award_emojis.GroupEpicAwardEmoji

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupEpicDiscussionNote(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupEpicDiscussionNoteManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetMixin, gitlab.mixins.CreateMixin, gitlab.mixins.UpdateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.notes.GroupEpicDiscussionNote#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.notes.GroupEpicDiscussionNote

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupEpicIssue(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.mixins.SaveMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: GroupEpicIssueManager#
save(**kwargs: Any) → None#

Save the changes made to the object to the server.

The object is updated to match what the server returns.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

class gitlab.v4.objects.GroupEpicIssueManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.mixins.CreateMixin, gitlab.mixins.UpdateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

create(data: Optional[Dict[str, Any]] = None, **kwargs: Any) → gitlab.v4.objects.epics.GroupEpicIssue#

Create a new object.

Parameters

  • data (Optional[Dict[str, Any]]) – Parameters to send to the server to create the resource

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

A new instance of the manage object class build with

the data sent by the server

Return type

gitlab.v4.objects.epics.GroupEpicIssue

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupEpicManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object listing filters

  • author_id

  • labels

  • order_by

  • sort

  • search

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.epics.GroupEpic#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.epics.GroupEpic

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupEpicNote(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

awardemojis: gitlab.v4.objects.award_emojis.GroupEpicNoteAwardEmojiManager#
class gitlab.v4.objects.GroupEpicNoteAwardEmoji(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupEpicNoteAwardEmojiManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.NoUpdateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.award_emojis.GroupEpicNoteAwardEmoji#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.award_emojis.GroupEpicNoteAwardEmoji

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupEpicNoteManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.notes.GroupEpicNote#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.notes.GroupEpicNote

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupEpicResourceLabelEvent(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupEpicResourceLabelEventManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.events.GroupEpicResourceLabelEvent#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.events.GroupEpicResourceLabelEvent

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupExport(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.DownloadMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupExportManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.mixins.CreateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.export_import.GroupExport]#

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.export_import.GroupExport]

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupHook(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupHookManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.hooks.GroupHook#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.hooks.GroupHook

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupImport(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupImportManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.export_import.GroupImport]#

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.export_import.GroupImport]

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupIssue(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupIssueManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object listing filters

  • state

  • labels

  • milestone

  • order_by

  • sort

  • iids

  • author_id

  • assignee_id

  • my_reaction_emoji

  • search

  • created_after

  • created_before

  • updated_after

  • updated_before

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupIssuesStatistics(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.RefreshMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupIssuesStatisticsManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.statistics.GroupIssuesStatistics]#

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.statistics.GroupIssuesStatistics]

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupLabel(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SubscribableMixin, gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: GroupLabelManager#
save(**kwargs: Any) → None#

Saves the changes made to the object to the server.

The object is updated to match what the server returns.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

class gitlab.v4.objects.GroupLabelManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.CreateMixin, gitlab.mixins.UpdateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.labels.GroupLabel#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.labels.GroupLabel

gitlab: gitlab.client.Gitlab#
update(name: Optional[str], new_data: Optional[Dict[str, Any]] = None, **kwargs: Any) → Dict[str, Any]#

Update a Label on the server.

Parameters

  • name (Optional[str]) – The name of the label

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • new_data (Optional[Dict[str, Any]]) –

  • kwargs (Any) –

Return type

Dict[str, Any]

class gitlab.v4.objects.GroupManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object listing filters

  • skip_groups

  • all_available

  • search

  • order_by

  • sort

  • statistics

  • owned

  • with_custom_attributes

  • min_access_level

  • top_level_only

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.groups.Group#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.groups.Group

gitlab: gitlab.client.Gitlab#
import_group(file: BinaryIO, path: str, name: str, parent_id: Optional[str] = None, **kwargs: Any) → Union[Dict[str, Any], requests.models.Response]#

Import a group from an archive file.

Parameters

  • file (BinaryIO) – Data or file object containing the group

  • path (str) – The path for the new group to be imported.

  • name (str) – The name for the new group.

  • parent_id (Optional[str]) – ID of a parent group that the group will be imported into.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

A representation of the import status.

Return type

Union[Dict[str, Any], requests.models.Response]

class gitlab.v4.objects.GroupMember(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupMemberAll(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupMemberAllManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.members.GroupMemberAll#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.members.GroupMemberAll

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupMemberManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.members.GroupMember#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.members.GroupMember

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupMergeRequest(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupMergeRequestManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object listing filters

  • state

  • order_by

  • sort

  • milestone

  • view

  • labels

  • created_after

  • created_before

  • updated_after

  • updated_before

  • scope

  • author_id

  • assignee_id

  • approver_ids

  • approved_by_ids

  • my_reaction_emoji

  • source_branch

  • target_branch

  • search

  • wip

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupMilestone(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

issues(**kwargs: Any) → gitlab.base.RESTObjectList#

List issues related to this milestone.

Parameters

  • all – If True, return all the items, without pagination

  • per_page – Number of items to retrieve per request

  • page – ID of the page to return (starts with page 1)

  • as_list – If set to False and no pagination option is defined, return a generator instead of a list

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The list of issues

Return type

gitlab.base.RESTObjectList

manager: gitlab.base.RESTManager#
merge_requests(**kwargs: Any) → gitlab.base.RESTObjectList#

List the merge requests related to this milestone.

Parameters

  • all – If True, return all the items, without pagination

  • per_page – Number of items to retrieve per request

  • page – ID of the page to return (starts with page 1)

  • as_list – If set to False and no pagination option is defined, return a generator instead of a list

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The list of merge requests

Return type

gitlab.base.RESTObjectList

class gitlab.v4.objects.GroupMilestoneManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object listing filters

  • iids

  • state

  • search

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.milestones.GroupMilestone#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.milestones.GroupMilestone

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupNotificationSettings(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.v4.objects.notification_settings.NotificationSettings

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupNotificationSettingsManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.v4.objects.notification_settings.NotificationSettingsManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.notification_settings.GroupNotificationSettings]#

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.notification_settings.GroupNotificationSettings]

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupPackage(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupPackageManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object listing filters

  • exclude_subgroups

  • order_by

  • sort

  • package_type

  • package_name

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupProject(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupProjectManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object listing filters

  • archived

  • visibility

  • order_by

  • sort

  • search

  • simple

  • owned

  • starred

  • with_custom_attributes

  • include_subgroups

  • with_issues_enabled

  • with_merge_requests_enabled

  • with_shared

  • min_access_level

  • with_security_reports

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupRunner(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupRunnerManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object listing filters

  • scope

  • tag_list

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupSubgroup(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupSubgroupManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object listing filters

  • skip_groups

  • all_available

  • search

  • order_by

  • sort

  • statistics

  • owned

  • with_custom_attributes

  • min_access_level

Object Creation

Object update

Parameters
Return type

None

class gitlab.v4.objects.GroupVariable(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupVariableManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.variables.GroupVariable#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.variables.GroupVariable

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.GroupWiki(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.GroupWikiManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object listing filters

  • with_content

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.wikis.GroupWiki#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.wikis.GroupWiki

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.Hook(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.HookManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.NoUpdateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.hooks.Hook#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.hooks.Hook

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.Issue(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.IssueManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object listing filters

  • state

  • labels

  • milestone

  • scope

  • author_id

  • assignee_id

  • my_reaction_emoji

  • iids

  • order_by

  • sort

  • search

  • created_after

  • created_before

  • updated_after

  • updated_before

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.issues.Issue#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.issues.Issue

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.IssuesStatistics(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.RefreshMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.IssuesStatisticsManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.statistics.IssuesStatistics]#

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.statistics.IssuesStatistics]

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.Key(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.KeyManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.keys.Key#

Retrieve a single object.

Parameters

  • id (Optional[Union[int, str]]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.keys.Key

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.LDAPGroup(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.LDAPGroupManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.base.RESTManager

Object listing filters

  • search

  • provider

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
list(**kwargs: Any) → Union[List[gitlab.v4.objects.ldap.LDAPGroup], gitlab.base.RESTObjectList]#

Retrieve a list of objects.

Parameters

  • all – If True, return all the items, without pagination

  • per_page – Number of items to retrieve per request

  • page – ID of the page to return (starts with page 1)

  • as_list – If set to False and no pagination option is defined, return a generator instead of a list

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The list of objects, or a generator if as_list is False

Raises
Return type

Union[List[gitlab.v4.objects.ldap.LDAPGroup], gitlab.base.RESTObjectList]

class gitlab.v4.objects.License(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.LicenseManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object listing filters

  • popular

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.templates.License#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.templates.License

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.MergeRequest(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.MergeRequestManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object listing filters

  • state

  • order_by

  • sort

  • milestone

  • view

  • labels

  • with_labels_details

  • with_merge_status_recheck

  • created_after

  • created_before

  • updated_after

  • updated_before

  • scope

  • author_id

  • author_username

  • assignee_id

  • approver_ids

  • approved_by_ids

  • reviewer_id

  • reviewer_username

  • my_reaction_emoji

  • source_branch

  • target_branch

  • search

  • in

  • wip

  • not

  • environment

  • deployed_before

  • deployed_after

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.Namespace(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.NamespaceManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object listing filters

  • search

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.namespaces.Namespace#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.namespaces.Namespace

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.NotificationSettings(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.NotificationSettingsManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.mixins.UpdateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.notification_settings.NotificationSettings]#

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.notification_settings.NotificationSettings]

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.PagesDomain(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.PagesDomainManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.PersonalAccessToken(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.PersonalAccessTokenManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.DeleteMixin, gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object listing filters

  • user_id

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.Project(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.RefreshMixin, gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.v4.objects.repositories.RepositoryMixin, gitlab.base.RESTObject

Parameters
Return type

None

access_tokens: gitlab.v4.objects.project_access_tokens.ProjectAccessTokenManager#
accessrequests: gitlab.v4.objects.access_requests.ProjectAccessRequestManager#
additionalstatistics: gitlab.v4.objects.statistics.ProjectAdditionalStatisticsManager#
approvalrules: gitlab.v4.objects.merge_request_approvals.ProjectApprovalRuleManager#
approvals: gitlab.v4.objects.merge_request_approvals.ProjectApprovalManager#
archive(**kwargs: Any) → None#

Archive a project.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

artifact(*args: Any, **kwargs: Any) → Optional[bytes]#
Parameters

  • args (Any) –

  • kwargs (Any) –

Return type

Optional[bytes]

artifacts: gitlab.v4.objects.artifacts.ProjectArtifactManager#
audit_events: gitlab.v4.objects.audit_events.ProjectAuditEventManager#
badges: gitlab.v4.objects.badges.ProjectBadgeManager#
boards: gitlab.v4.objects.boards.ProjectBoardManager#
branches: gitlab.v4.objects.branches.ProjectBranchManager#
clusters: gitlab.v4.objects.clusters.ProjectClusterManager#
commits: gitlab.v4.objects.commits.ProjectCommitManager#
create_fork_relation(forked_from_id: int, **kwargs: Any) → None#

Create a forked from/to relation between existing projects.

Parameters

  • forked_from_id (int) – The ID of the project that was forked from

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

customattributes: gitlab.v4.objects.custom_attributes.ProjectCustomAttributeManager#
delete_fork_relation(**kwargs: Any) → None#

Delete a forked relation between existing projects.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

deployments: gitlab.v4.objects.deployments.ProjectDeploymentManager#
deploytokens: gitlab.v4.objects.deploy_tokens.ProjectDeployTokenManager#
environments: gitlab.v4.objects.environments.ProjectEnvironmentManager#
events: gitlab.v4.objects.events.ProjectEventManager#
exports: gitlab.v4.objects.export_import.ProjectExportManager#
files: gitlab.v4.objects.files.ProjectFileManager#
forks: ProjectForkManager#
generic_packages: gitlab.v4.objects.packages.GenericPackageManager#
groups: gitlab.v4.objects.projects.ProjectGroupManager#
hooks: gitlab.v4.objects.hooks.ProjectHookManager#
housekeeping(**kwargs: Any) → None#

Start the housekeeping task.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

imports: gitlab.v4.objects.export_import.ProjectImportManager#
issues: gitlab.v4.objects.issues.ProjectIssueManager#
issues_statistics: gitlab.v4.objects.statistics.ProjectIssuesStatisticsManager#
jobs: gitlab.v4.objects.jobs.ProjectJobManager#
keys: gitlab.v4.objects.deploy_keys.ProjectKeyManager#
labels: gitlab.v4.objects.labels.ProjectLabelManager#
languages(**kwargs: Any) → Union[Dict[str, Any], requests.models.Response]#

Get languages used in the project with percentage value.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

Union[Dict[str, Any], requests.models.Response]

members: gitlab.v4.objects.members.ProjectMemberManager#
members_all: gitlab.v4.objects.members.ProjectMemberAllManager#
merge_trains: gitlab.v4.objects.merge_trains.ProjectMergeTrainManager#
mergerequests: gitlab.v4.objects.merge_requests.ProjectMergeRequestManager#
milestones: gitlab.v4.objects.milestones.ProjectMilestoneManager#
mirror_pull(**kwargs: Any) → None#

Start the pull mirroring process for the project.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

notes: gitlab.v4.objects.notes.ProjectNoteManager#
notificationsettings: gitlab.v4.objects.notification_settings.ProjectNotificationSettingsManager#
packages: gitlab.v4.objects.packages.ProjectPackageManager#
pagesdomains: gitlab.v4.objects.pages.ProjectPagesDomainManager#
pipelines: gitlab.v4.objects.pipelines.ProjectPipelineManager#
pipelineschedules: gitlab.v4.objects.pipelines.ProjectPipelineScheduleManager#
protectedbranches: gitlab.v4.objects.branches.ProjectProtectedBranchManager#
protectedtags: gitlab.v4.objects.tags.ProjectProtectedTagManager#
pushrules: gitlab.v4.objects.push_rules.ProjectPushRulesManager#
releases: gitlab.v4.objects.releases.ProjectReleaseManager#
remote_mirrors: ProjectRemoteMirrorManager#
repositories: gitlab.v4.objects.container_registry.ProjectRegistryRepositoryManager#
runners: gitlab.v4.objects.runners.ProjectRunnerManager#
search(scope: str, search: str, **kwargs: Any) → Union[gitlab.client.GitlabList, List[Dict[str, Any]]]#

Search the project resources matching the provided string.’

Parameters

  • scope (str) – Scope of the search

  • search (str) – Search string

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

A list of dicts describing the resources found.

Return type

Union[gitlab.client.GitlabList, List[Dict[str, Any]]]

services: gitlab.v4.objects.services.ProjectServiceManager#
share(group_id: int, group_access: int, expires_at: Optional[str] = None, **kwargs: Any) → None#

Share the project with a group.

Parameters

  • group_id (int) – ID of the group.

  • group_access (int) – Access level for the group.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • expires_at (Optional[str]) –

  • kwargs (Any) –

Raises
Return type

None

snapshot(wiki: bool = False, streamed: bool = False, action: Optional[Callable] = None, chunk_size: int = 1024, **kwargs: Any) → Optional[bytes]#

Return a snapshot of the repository.

Parameters

  • wiki (bool) – If True return the wiki repository

  • streamed (bool) – If True the data will be processed by chunks of chunk_size and each chunk is passed to action for treatment.

  • action (Optional[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)

  • kwargs (Any) –

Raises
Returns

The uncompressed tar archive of the repository

Return type

Optional[bytes]

snippets: gitlab.v4.objects.snippets.ProjectSnippetManager#
star(**kwargs: Any) → None#

Star a project.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

storage: ProjectStorageManager#
tags: gitlab.v4.objects.tags.ProjectTagManager#
transfer(to_namespace: Union[int, str], **kwargs: Any) → None#

Transfer a project to the given namespace ID

Parameters

  • to_namespace (Union[int, str]) – ID or path of the namespace to transfer the

  • to (project) –

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

transfer_project(*args: Any, **kwargs: Any) → None#
Parameters

  • args (Any) –

  • kwargs (Any) –

Return type

None

trigger_pipeline(ref: str, token: str, variables: Optional[Dict[str, Any]] = None, **kwargs: Any) → gitlab.v4.objects.pipelines.ProjectPipeline#

Trigger a CI build.

See https://gitlab.com/help/ci/triggers/README.md#trigger-a-build

Parameters

  • ref (str) – Commit to build; can be a branch name or a tag

  • token (str) – The trigger token

  • variables (Optional[Dict[str, Any]]) – Variables passed to the build script

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

gitlab.v4.objects.pipelines.ProjectPipeline

triggers: gitlab.v4.objects.triggers.ProjectTriggerManager#
unarchive(**kwargs: Any) → None#

Unarchive a project.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

unshare(group_id: int, **kwargs: Any) → None#

Delete a shared project link within a group.

Parameters

  • group_id (int) – ID of the group.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

unstar(**kwargs: Any) → None#

Unstar a project.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

upload(filename: str, filedata: Optional[bytes] = None, filepath: Optional[str] = None, **kwargs: Any) → Dict[str, Any]#

Upload the specified file into the project.

Note

Either filedata or filepath MUST be specified.

Parameters

  • filename (str) – The name of the file being uploaded

  • filedata (Optional[bytes]) – The raw data of the file being uploaded

  • filepath (Optional[str]) – The path to a local file to upload (optional)

  • kwargs (Any) –

Raises
Returns

  • alt - The alternate text for the upload

  • url - The direct url to the uploaded file

  • markdown - Markdown for the uploaded file

Return type

A dict with the keys

users: gitlab.v4.objects.users.ProjectUserManager#
variables: gitlab.v4.objects.variables.ProjectVariableManager#
wikis: gitlab.v4.objects.wikis.ProjectWikiManager#
class gitlab.v4.objects.ProjectAccessRequest(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.AccessRequestMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectAccessRequestManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.mixins.CreateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectAccessToken(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectAccessTokenManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.mixins.CreateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectAdditionalStatistics(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.RefreshMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectAdditionalStatisticsManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.statistics.ProjectAdditionalStatistics]#

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.statistics.ProjectAdditionalStatistics]

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectApproval(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectApprovalManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.mixins.UpdateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.merge_request_approvals.ProjectApproval]#

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.merge_request_approvals.ProjectApproval]

gitlab: gitlab.client.Gitlab#
set_approvers(approver_ids: Optional[List[int]] = None, approver_group_ids: Optional[List[int]] = None, **kwargs: Any) → Dict[str, Any]#

Change project-level allowed approvers and approver groups.

Parameters

  • approver_ids (Optional[List[int]]) – User IDs that can approve MRs

  • approver_group_ids (Optional[List[int]]) – Group IDs whose members can approve MRs

  • kwargs (Any) –

Raises
Returns

A dict value of the result

Return type

Dict[str, Any]

class gitlab.v4.objects.ProjectApprovalRule(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectApprovalRuleManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.mixins.CreateMixin, gitlab.mixins.UpdateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectArtifact(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Dummy object to manage custom actions on artifacts

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectArtifactManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

delete(**kwargs: Any) → None#

Delete the project’s artifacts on the server.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

download(ref_name: str, job: str, streamed: bool = False, action: Optional[Callable] = None, chunk_size: int = 1024, **kwargs: Any) → Optional[bytes]#

Get the job artifacts archive from a specific tag or branch.

Parameters

  • ref_name (str) – Branch or tag name in repository. HEAD or SHA references

  • supported. (are not) –

  • job (str) – The name of the job.

  • job_token – Job token for multi-project pipeline triggers.

  • streamed (bool) – If True the data will be processed by chunks of chunk_size and each chunk is passed to action for treatment

  • action (Optional[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)

  • kwargs (Any) –

Raises
Returns

The artifacts if streamed is False, None otherwise.

Return type

Optional[bytes]

gitlab: gitlab.client.Gitlab#
raw(ref_name: str, artifact_path: str, job: str, streamed: bool = False, action: Optional[Callable] = None, chunk_size: int = 1024, **kwargs: Any) → Optional[bytes]#

Download a single artifact file from a specific tag or branch from within the job’s artifacts archive.

Parameters

  • ref_name (str) – Branch or tag name in repository. HEAD or SHA references are not supported.

  • artifact_path (str) – Path to a file inside the artifacts archive.

  • job (str) – The name of the job.

  • streamed (bool) – If True the data will be processed by chunks of chunk_size and each chunk is passed to action for treatment

  • action (Optional[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)

  • kwargs (Any) –

Raises
Returns

The artifact if streamed is False, None otherwise.

Return type

Optional[bytes]

class gitlab.v4.objects.ProjectAudit(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.v4.objects.audit_events.ProjectAuditEvent

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectAuditEvent(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectAuditEventManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object listing filters

  • created_after

  • created_before

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.audit_events.ProjectAuditEvent#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.audit_events.ProjectAuditEvent

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectAuditManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.v4.objects.audit_events.ProjectAuditEventManager

Object listing filters

  • created_after

  • created_before

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectBadge(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectBadgeManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.BadgeRenderMixin, gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.badges.ProjectBadge#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.badges.ProjectBadge

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectBoard(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

lists: gitlab.v4.objects.boards.ProjectBoardListManager#
class gitlab.v4.objects.ProjectBoardList(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectBoardListManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.boards.ProjectBoardList#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.boards.ProjectBoardList

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectBoardManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.boards.ProjectBoard#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.boards.ProjectBoard

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectBranch(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectBranchManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.NoUpdateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.branches.ProjectBranch#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.branches.ProjectBranch

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectCluster(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectClusterManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

create(data: Optional[Dict[str, Any]] = None, **kwargs: Any) → gitlab.v4.objects.clusters.ProjectCluster#

Create a new object.

Parameters

  • data (Optional[Dict[str, Any]]) – Parameters to send to the server to create the resource

  • **kwargs – Extra options to send to the server (e.g. sudo or ‘ref_name’, ‘stage’, ‘name’, ‘all’)

  • kwargs (Any) –

Raises
Returns

A new instance of the manage object class build with

the data sent by the server

Return type

gitlab.v4.objects.clusters.ProjectCluster

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.clusters.ProjectCluster#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.clusters.ProjectCluster

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectCommit(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

cherry_pick(branch: str, **kwargs: Any) → None#

Cherry-pick a commit into a branch.

Parameters

  • branch (str) – Name of target branch

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

comments: ProjectCommitCommentManager#
diff(**kwargs: Any) → Union[gitlab.client.GitlabList, List[Dict[str, Any]]]#

Generate the commit diff.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The changes done in this commit

Return type

Union[gitlab.client.GitlabList, List[Dict[str, Any]]]

discussions: gitlab.v4.objects.discussions.ProjectCommitDiscussionManager#
merge_requests(**kwargs: Any) → Union[gitlab.client.GitlabList, List[Dict[str, Any]]]#

List the merge requests related to the commit.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The merge requests related to the commit.

Return type

Union[gitlab.client.GitlabList, List[Dict[str, Any]]]

refs(type: str = 'all', **kwargs: Any) → Union[gitlab.client.GitlabList, List[Dict[str, Any]]]#

List the references the commit is pushed to.

Parameters

  • type (str) – The scope of references (‘branch’, ‘tag’ or ‘all’)

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The references the commit is pushed to.

Return type

Union[gitlab.client.GitlabList, List[Dict[str, Any]]]

revert(branch: str, **kwargs: Any) → Union[Dict[str, Any], requests.models.Response]#

Revert a commit on a given branch.

Parameters

  • branch (str) – Name of target branch

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The new commit data (not a RESTObject)

Return type

Union[Dict[str, Any], requests.models.Response]

signature(**kwargs: Any) → Union[Dict[str, Any], requests.models.Response]#

Get the signature of the commit.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The commit’s signature data

Return type

Union[Dict[str, Any], requests.models.Response]

statuses: ProjectCommitStatusManager#
class gitlab.v4.objects.ProjectCommitComment(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectCommitCommentManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.mixins.CreateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectCommitDiscussion(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

notes: gitlab.v4.objects.notes.ProjectCommitDiscussionNoteManager#
class gitlab.v4.objects.ProjectCommitDiscussionManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.CreateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.discussions.ProjectCommitDiscussion#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.discussions.ProjectCommitDiscussion

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectCommitDiscussionNote(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectCommitDiscussionNoteManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetMixin, gitlab.mixins.CreateMixin, gitlab.mixins.UpdateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.notes.ProjectCommitDiscussionNote#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.notes.ProjectCommitDiscussionNote

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectCommitManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.CreateMixin, gitlab.base.RESTManager

Object listing filters

  • ref_name

  • since

  • until

  • path

  • with_stats

  • first_parent

  • order

  • trailers

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.commits.ProjectCommit#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.commits.ProjectCommit

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectCommitStatus(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.RefreshMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectCommitStatusManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.mixins.CreateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

create(data: Optional[Dict[str, Any]] = None, **kwargs: Any) → gitlab.v4.objects.commits.ProjectCommitStatus#

Create a new object.

Parameters

  • data (Optional[Dict[str, Any]]) – Parameters to send to the server to create the resource

  • **kwargs – Extra options to send to the server (e.g. sudo or ‘ref_name’, ‘stage’, ‘name’, ‘all’)

  • kwargs (Any) –

Raises
Returns

A new instance of the manage object class build with

the data sent by the server

Return type

gitlab.v4.objects.commits.ProjectCommitStatus

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectCustomAttribute(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectCustomAttributeManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.SetMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.custom_attributes.ProjectCustomAttribute#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.custom_attributes.ProjectCustomAttribute

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectDeployToken(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectDeployTokenManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.CreateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.deploy_tokens.ProjectDeployToken#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.deploy_tokens.ProjectDeployToken

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectDeployment(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.base.RESTObject

Parameters
Return type

None

mergerequests: gitlab.v4.objects.merge_requests.ProjectDeploymentMergeRequestManager#
class gitlab.v4.objects.ProjectDeploymentManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.CreateMixin, gitlab.mixins.UpdateMixin, gitlab.base.RESTManager

Object listing filters

  • order_by

  • sort

  • updated_after

  • updated_before

  • environment

  • status

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.deployments.ProjectDeployment#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.deployments.ProjectDeployment

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectDeploymentMergeRequest(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.v4.objects.merge_requests.MergeRequest

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectDeploymentMergeRequestManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.v4.objects.merge_requests.MergeRequestManager

Object listing filters

  • state

  • order_by

  • sort

  • milestone

  • view

  • labels

  • with_labels_details

  • with_merge_status_recheck

  • created_after

  • created_before

  • updated_after

  • updated_before

  • scope

  • author_id

  • author_username

  • assignee_id

  • approver_ids

  • approved_by_ids

  • reviewer_id

  • reviewer_username

  • my_reaction_emoji

  • source_branch

  • target_branch

  • search

  • in

  • wip

  • not

  • environment

  • deployed_before

  • deployed_after

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectEnvironment(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
stop(**kwargs: Any) → Union[Dict[str, Any], requests.models.Response]#

Stop the environment.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

A dict of the result.

Return type

Union[Dict[str, Any], requests.models.Response]

class gitlab.v4.objects.ProjectEnvironmentManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.CreateMixin, gitlab.mixins.UpdateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object listing filters

  • name

  • search

  • states

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.environments.ProjectEnvironment#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.environments.ProjectEnvironment

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectEvent(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.v4.objects.events.Event

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectEventManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.v4.objects.events.EventManager

Object listing filters

  • action

  • target_type

  • before

  • after

  • sort

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectExport(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.DownloadMixin, gitlab.mixins.RefreshMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectExportManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.mixins.CreateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.export_import.ProjectExport]#

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.export_import.ProjectExport]

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectFile(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

decode() → bytes#

Returns the decoded content of the file.

Returns

The decoded content.

Return type

bytes

delete(branch: str, commit_message: str, **kwargs: Any) → None#

Delete the file from the server.

Parameters

  • branch (str) – Branch from which the file will be removed

  • commit_message (str) – Commit message for the deletion

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

file_path: str#
manager: ProjectFileManager#
save(branch: str, commit_message: str, **kwargs: Any) → None#

Save the changes made to the file to the server.

The object is updated to match what the server returns.

Parameters

  • branch (str) – Branch in which the file will be updated

  • commit_message (str) – Message to send with the commit

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

class gitlab.v4.objects.ProjectFileManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetMixin, gitlab.mixins.CreateMixin, gitlab.mixins.UpdateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

blame(file_path: str, ref: str, **kwargs: Any) → List[Dict[str, Any]]#

Return the content of a file for a commit.

Parameters

  • file_path (str) – Path of the file to retrieve

  • ref (str) – Name of the branch, tag or commit

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

A list of commits/lines matching the file

Return type

List[Dict[str, Any]]

create(data: Optional[Dict[str, Any]] = None, **kwargs: Any) → gitlab.v4.objects.files.ProjectFile#

Create a new object.

Parameters

  • data (Optional[Dict[str, Any]]) – parameters to send to the server to create the resource

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

a new instance of the managed object class built with

the data sent by the server

Raises
Return type

gitlab.v4.objects.files.ProjectFile

delete(file_path: str, branch: str, commit_message: str, **kwargs: Any) → None#

Delete a file on the server.

Parameters

  • file_path (str) – Path of the file to remove

  • branch (str) – Branch from which the file will be removed

  • commit_message (str) – Commit message for the deletion

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

get(file_path: str, ref: str, **kwargs: Any) → gitlab.v4.objects.files.ProjectFile#

Retrieve a single file.

Parameters

  • file_path (str) – Path of the file to retrieve

  • ref (str) – Name of the branch, tag or commit

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The generated RESTObject

Return type

gitlab.v4.objects.files.ProjectFile

gitlab: gitlab.client.Gitlab#
raw(file_path: str, ref: str, streamed: bool = False, action: Optional[Callable[[...], Any]] = None, chunk_size: int = 1024, **kwargs: Any) → Optional[bytes]#

Return the content of a file for a commit.

Parameters

  • ref (str) – ID of the commit

  • filepath – Path of the file to return

  • streamed (bool) – If True the data will be processed by chunks of chunk_size and each chunk is passed to action for treatment

  • action (Optional[Callable[[...], Any]]) – 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)

  • file_path (str) –

  • kwargs (Any) –

Raises
Returns

The file content

Return type

Optional[bytes]

update(file_path: str, new_data: Optional[Dict[str, Any]] = None, **kwargs: Any) → Dict[str, Any]#

Update an object on the server.

Parameters

  • id – ID of the object to update (can be None if not required)

  • new_data (Optional[Dict[str, Any]]) – the update data for the object

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • file_path (str) –

  • kwargs (Any) –

Returns

The new object data (not a RESTObject)

Raises
Return type

Dict[str, Any]

class gitlab.v4.objects.ProjectFork(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectForkManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CreateMixin, gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object listing filters

  • archived

  • visibility

  • order_by

  • sort

  • search

  • simple

  • owned

  • membership

  • starred

  • statistics

  • with_custom_attributes

  • with_issues_enabled

  • with_merge_requests_enabled

Object Creation

Object update

Parameters
Return type

None

create(data: Optional[Dict[str, Any]] = None, **kwargs: Any) → gitlab.v4.objects.projects.ProjectFork#

Creates a new object.

Parameters

  • data (Optional[Dict[str, Any]]) – Parameters to send to the server to create the resource

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

A new instance of the managed object class build with

the data sent by the server

Return type

gitlab.v4.objects.projects.ProjectFork

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectHook(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectHookManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.hooks.ProjectHook#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.hooks.ProjectHook

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectImport(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.RefreshMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectImportManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.export_import.ProjectImport]#

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.export_import.ProjectImport]

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectIssue(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.UserAgentDetailMixin, gitlab.mixins.SubscribableMixin, gitlab.mixins.TodoMixin, gitlab.mixins.TimeTrackingMixin, gitlab.mixins.ParticipantsMixin, gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

awardemojis: gitlab.v4.objects.award_emojis.ProjectIssueAwardEmojiManager#
closed_by(**kwargs: Any) → Dict[str, Any]#

List merge requests that will close the issue when merged.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises

  • GitlabAuthenticationError – If authentication is not correct

  • GitlabGetErrot – If the merge requests could not be retrieved

Returns

The list of merge requests.

Return type

Dict[str, Any]

discussions: gitlab.v4.objects.discussions.ProjectIssueDiscussionManager#
move(to_project_id: int, **kwargs: Any) → None#

Move the issue to another project.

Parameters

  • to_project_id (int) – ID of the target project

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

notes: gitlab.v4.objects.notes.ProjectIssueNoteManager#
related_merge_requests(**kwargs: Any) → Dict[str, Any]#

List merge requests related to the issue.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises

  • GitlabAuthenticationError – If authentication is not correct

  • GitlabGetErrot – If the merge requests could not be retrieved

Returns

The list of merge requests.

Return type

Dict[str, Any]

resourcelabelevents: gitlab.v4.objects.events.ProjectIssueResourceLabelEventManager#
resourcemilestoneevents: gitlab.v4.objects.events.ProjectIssueResourceMilestoneEventManager#
resourcestateevents: gitlab.v4.objects.events.ProjectIssueResourceStateEventManager#
class gitlab.v4.objects.ProjectIssueAwardEmoji(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectIssueAwardEmojiManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.NoUpdateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.award_emojis.ProjectIssueAwardEmoji#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.award_emojis.ProjectIssueAwardEmoji

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectIssueDiscussion(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

notes: gitlab.v4.objects.notes.ProjectIssueDiscussionNoteManager#
class gitlab.v4.objects.ProjectIssueDiscussionManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.CreateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.discussions.ProjectIssueDiscussion#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.discussions.ProjectIssueDiscussion

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectIssueDiscussionNote(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectIssueDiscussionNoteManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetMixin, gitlab.mixins.CreateMixin, gitlab.mixins.UpdateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.notes.ProjectIssueDiscussionNote#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.notes.ProjectIssueDiscussionNote

gitlab: gitlab.client.Gitlab#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectIssueLinkManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.mixins.CreateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

create(data: Dict[str, Any], **kwargs: Any) → Tuple[gitlab.base.RESTObject, gitlab.base.RESTObject]#

Create a new object.

Parameters

  • data (Dict[str, Any]) – parameters to send to the server to create the resource

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The source and target issues

Raises
Return type

Tuple[gitlab.base.RESTObject, gitlab.base.RESTObject]

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectIssueManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object listing filters

  • iids

  • state

  • labels

  • milestone

  • scope

  • author_id

  • assignee_id

  • my_reaction_emoji

  • order_by

  • sort

  • search

  • created_after

  • created_before

  • updated_after

  • updated_before

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.issues.ProjectIssue#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.issues.ProjectIssue

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectIssueNote(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

awardemojis: gitlab.v4.objects.award_emojis.ProjectIssueNoteAwardEmojiManager#
class gitlab.v4.objects.ProjectIssueNoteAwardEmoji(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectIssueNoteAwardEmojiManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.NoUpdateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.award_emojis.ProjectIssueNoteAwardEmoji#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.award_emojis.ProjectIssueNoteAwardEmoji

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectIssueNoteManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.notes.ProjectIssueNote#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.notes.ProjectIssueNote

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectIssueResourceLabelEvent(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectIssueResourceLabelEventManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.events.ProjectIssueResourceLabelEvent#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.events.ProjectIssueResourceLabelEvent

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectIssueResourceMilestoneEvent(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectIssueResourceMilestoneEventManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.events.ProjectIssueResourceMilestoneEvent#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.events.ProjectIssueResourceMilestoneEvent

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectIssueResourceStateEvent(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectIssueResourceStateEventManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.events.ProjectIssueResourceStateEvent#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.events.ProjectIssueResourceStateEvent

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectIssuesStatistics(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.RefreshMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectIssuesStatisticsManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.statistics.ProjectIssuesStatistics]#

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.statistics.ProjectIssuesStatistics]

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectJob(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.RefreshMixin, gitlab.base.RESTObject

Parameters
Return type

None

artifact(path: str, streamed: bool = False, action: Optional[Callable[[...], Any]] = None, chunk_size: int = 1024, **kwargs: Any) → Optional[bytes]#

Get a single artifact file from within the job’s artifacts archive.

Parameters

  • path (str) – Path of the artifact

  • streamed (bool) – If True the data will be processed by chunks of chunk_size and each chunk is passed to action for treatment

  • action (Optional[Callable[[...], Any]]) – 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)

  • kwargs (Any) –

Raises
Returns

The artifacts if streamed is False, None otherwise.

Return type

Optional[bytes]

artifacts(streamed: bool = False, action: Optional[Callable[[...], Any]] = None, chunk_size: int = 1024, **kwargs: Any) → Optional[bytes]#

Get the job artifacts.

Parameters

  • streamed (bool) – If True the data will be processed by chunks of chunk_size and each chunk is passed to action for treatment

  • action (Optional[Callable[[...], Any]]) – 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)

  • kwargs (Any) –

Raises
Returns

The artifacts if streamed is False, None otherwise.

Return type

Optional[bytes]

cancel(**kwargs: Any) → Dict[str, Any]#

Cancel the job.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

Dict[str, Any]

delete_artifacts(**kwargs: Any) → None#

Delete artifacts of a job.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

erase(**kwargs: Any) → None#

Erase the job (remove job artifacts and trace).

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

keep_artifacts(**kwargs: Any) → None#

Prevent artifacts from being deleted when expiration is set.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

manager: gitlab.base.RESTManager#
play(**kwargs: Any) → None#

Trigger a job explicitly.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

retry(**kwargs: Any) → Dict[str, Any]#

Retry the job.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

Dict[str, Any]

trace(streamed: bool = False, action: Optional[Callable[[...], Any]] = None, chunk_size: int = 1024, **kwargs: Any) → Dict[str, Any]#

Get the job trace.

Parameters

  • streamed (bool) – If True the data will be processed by chunks of chunk_size and each chunk is passed to action for treatment

  • action (Optional[Callable[[...], Any]]) – 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)

  • kwargs (Any) –

Raises
Returns

The trace

Return type

Dict[str, Any]

class gitlab.v4.objects.ProjectJobManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.jobs.ProjectJob#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.jobs.ProjectJob

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectKey(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectKeyManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

enable(key_id: int, **kwargs: Any) → Union[Dict[str, Any], requests.models.Response]#

Enable a deploy key for a project.

Parameters

  • key_id (int) – The ID of the key to enable

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

A dict of the result.

Return type

Union[Dict[str, Any], requests.models.Response]

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.deploy_keys.ProjectKey#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.deploy_keys.ProjectKey

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectLabel(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.PromoteMixin, gitlab.mixins.SubscribableMixin, gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: ProjectLabelManager#
save(**kwargs: Any) → None#

Saves the changes made to the object to the server.

The object is updated to match what the server returns.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

class gitlab.v4.objects.ProjectLabelManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.CreateMixin, gitlab.mixins.UpdateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.labels.ProjectLabel#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.labels.ProjectLabel

gitlab: gitlab.client.Gitlab#
update(name: Optional[str], new_data: Optional[Dict[str, Any]] = None, **kwargs: Any) → Dict[str, Any]#

Update a Label on the server.

Parameters

  • name (Optional[str]) – The name of the label

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • new_data (Optional[Dict[str, Any]]) –

  • kwargs (Any) –

Return type

Dict[str, Any]

class gitlab.v4.objects.ProjectManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object listing filters

  • archived

  • id_after

  • id_before

  • last_activity_after

  • last_activity_before

  • membership

  • min_access_level

  • order_by

  • owned

  • repository_checksum_failed

  • repository_storage

  • search_namespaces

  • search

  • simple

  • sort

  • starred

  • statistics

  • topic

  • visibility

  • wiki_checksum_failed

  • with_custom_attributes

  • with_issues_enabled

  • with_merge_requests_enabled

  • with_programming_language

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.projects.Project#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.projects.Project

gitlab: gitlab.client.Gitlab#
import_bitbucket_server(bitbucket_server_url: str, bitbucket_server_username: str, personal_access_token: str, bitbucket_server_project: str, bitbucket_server_repo: str, new_name: Optional[str] = None, target_namespace: Optional[str] = None, **kwargs: Any) → Union[Dict[str, Any], requests.models.Response]#

Import a project from BitBucket Server to Gitlab (schedule the import)

This method will return when an import operation has been safely queued, or an error has occurred. After triggering an import, check the import_status of the newly created project to detect when the import operation has completed.

Note

This request may take longer than most other API requests. So this method will specify a 60 second default timeout if none is specified. A timeout can be specified via kwargs to override this functionality.

Parameters

  • bitbucket_server_url (str) – Bitbucket Server URL

  • bitbucket_server_username (str) – Bitbucket Server Username

  • personal_access_token (str) – Bitbucket Server personal access token/password

  • bitbucket_server_project (str) – Bitbucket Project Key

  • bitbucket_server_repo (str) – Bitbucket Repository Name

  • new_name (Optional[str]) – New repository name (Optional)

  • target_namespace (Optional[str]) – Namespace to import repository into. Supports subgroups like /namespace/subgroup (Optional)

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

A representation of the import status.

Return type

Union[Dict[str, Any], requests.models.Response]

Example:

gl = gitlab.Gitlab_from_config()
print("Triggering import")
result = gl.projects.import_bitbucket_server(
    bitbucket_server_url="https://some.server.url",
    bitbucket_server_username="some_bitbucket_user",
    personal_access_token="my_password_or_access_token",
    bitbucket_server_project="my_project",
    bitbucket_server_repo="my_repo",
    new_name="gl_project_name",
    target_namespace="gl_project_path"
)
project = gl.projects.get(ret['id'])
print("Waiting for import to complete")
while project.import_status == u'started':
    time.sleep(1.0)
    project = gl.projects.get(project.id)
print("BitBucket import complete")
import_github(personal_access_token: str, repo_id: int, target_namespace: str, new_name: Optional[str] = None, **kwargs: Any) → Union[Dict[str, Any], requests.models.Response]#

Import a project from Github to Gitlab (schedule the import)

This method will return when an import operation has been safely queued, or an error has occurred. After triggering an import, check the import_status of the newly created project to detect when the import operation has completed.

Note

This request may take longer than most other API requests. So this method will specify a 60 second default timeout if none is specified. A timeout can be specified via kwargs to override this functionality.

Parameters

  • personal_access_token (str) – GitHub personal access token

  • repo_id (int) – Github repository ID

  • target_namespace (str) – Namespace to import repo into

  • new_name (Optional[str]) – New repo name (Optional)

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

A representation of the import status.

Return type

Union[Dict[str, Any], requests.models.Response]

Example:

gl = gitlab.Gitlab_from_config()
print("Triggering import")
result = gl.projects.import_github(ACCESS_TOKEN,
                                   123456,
                                   "my-group/my-subgroup")
project = gl.projects.get(ret['id'])
print("Waiting for import to complete")
while project.import_status == u'started':
    time.sleep(1.0)
    project = gl.projects.get(project.id)
print("Github import complete")
import_project(file: str, path: str, name: Optional[str] = None, namespace: Optional[str] = None, overwrite: bool = False, override_params: Optional[Dict[str, Any]] = None, **kwargs: Any) → Union[Dict[str, Any], requests.models.Response]#

Import a project from an archive file.

Parameters

  • file (str) – Data or file object containing the project

  • path (str) – Name and path for the new project

  • namespace (Optional[str]) – The ID or path of the namespace that the project will be imported to

  • overwrite (bool) – If True overwrite an existing project with the same path

  • override_params (Optional[Dict[str, Any]]) – Set the specific settings for the project

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • name (Optional[str]) –

  • kwargs (Any) –

Raises
Returns

A representation of the import status.

Return type

Union[Dict[str, Any], requests.models.Response]

class gitlab.v4.objects.ProjectMember(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectMemberAll(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectMemberAllManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.members.ProjectMemberAll#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.members.ProjectMemberAll

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectMemberManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.members.ProjectMember#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.members.ProjectMember

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectMergeRequest(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SubscribableMixin, gitlab.mixins.TodoMixin, gitlab.mixins.TimeTrackingMixin, gitlab.mixins.ParticipantsMixin, gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

approval_rules: gitlab.v4.objects.merge_request_approvals.ProjectMergeRequestApprovalRuleManager#
approval_state: gitlab.v4.objects.merge_request_approvals.ProjectMergeRequestApprovalStateManager#
approvals: gitlab.v4.objects.merge_request_approvals.ProjectMergeRequestApprovalManager#
approve(sha: Optional[str] = None, **kwargs: Any) → Dict[str, Any]#

Approve the merge request.

Parameters

  • sha (Optional[str]) – Head SHA of MR

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

A dict containing the result.

Return type

Dict[str, Any]

https://docs.gitlab.com/ee/api/merge_request_approvals.html#approve-merge-request

awardemojis: gitlab.v4.objects.award_emojis.ProjectMergeRequestAwardEmojiManager#
cancel_merge_when_pipeline_succeeds(**kwargs: Any) → gitlab.v4.objects.merge_requests.ProjectMergeRequest#

Cancel merge when the pipeline succeeds.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

ProjectMergeRequest

Return type

gitlab.v4.objects.merge_requests.ProjectMergeRequest

changes(**kwargs: Any) → Union[Dict[str, Any], requests.models.Response]#

List the merge request changes.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

List of changes

Return type

Union[Dict[str, Any], requests.models.Response]

closes_issues(**kwargs: Any) → gitlab.base.RESTObjectList#

List issues that will close on merge.”

Parameters

  • all – If True, return all the items, without pagination

  • per_page – Number of items to retrieve per request

  • page – ID of the page to return (starts with page 1)

  • as_list – If set to False and no pagination option is defined, return a generator instead of a list

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

List of issues

Return type

gitlab.base.RESTObjectList

commits(**kwargs: Any) → gitlab.base.RESTObjectList#

List the merge request commits.

Parameters

  • all – If True, return all the items, without pagination

  • per_page – Number of items to retrieve per request

  • page – ID of the page to return (starts with page 1)

  • as_list – If set to False and no pagination option is defined, return a generator instead of a list

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The list of commits

Return type

gitlab.base.RESTObjectList

diffs: ProjectMergeRequestDiffManager#
discussions: gitlab.v4.objects.discussions.ProjectMergeRequestDiscussionManager#
merge(merge_commit_message: Optional[str] = None, should_remove_source_branch: Optional[bool] = None, merge_when_pipeline_succeeds: Optional[bool] = None, **kwargs: Any) → Dict[str, Any]#

Accept the merge request.

Parameters

  • merge_commit_message (Optional[str]) – Commit message

  • should_remove_source_branch (Optional[bool]) – If True, removes the source branch

  • merge_when_pipeline_succeeds (Optional[bool]) – Wait for the build to succeed, then merge

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

Dict[str, Any]

merge_ref(**kwargs: Any) → Union[Dict[str, Any], requests.models.Response]#
Attempt to merge changes between source and target branches into

refs/merge-requests/:iid/merge.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises

GitlabGetError – If cannot be merged

Return type

Union[Dict[str, Any], requests.models.Response]

notes: gitlab.v4.objects.notes.ProjectMergeRequestNoteManager#
pipelines: gitlab.v4.objects.pipelines.ProjectMergeRequestPipelineManager#
rebase(**kwargs: Any) → Union[Dict[str, Any], requests.models.Response]#

Attempt to rebase the source branch onto the target branch

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

Union[Dict[str, Any], requests.models.Response]

resourcelabelevents: gitlab.v4.objects.events.ProjectMergeRequestResourceLabelEventManager#
resourcemilestoneevents: gitlab.v4.objects.events.ProjectMergeRequestResourceMilestoneEventManager#
resourcestateevents: gitlab.v4.objects.events.ProjectMergeRequestResourceStateEventManager#
unapprove(**kwargs: Any) → None#

Unapprove the merge request.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

https://docs.gitlab.com/ee/api/merge_request_approvals.html#unapprove-merge-request

class gitlab.v4.objects.ProjectMergeRequestApproval(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectMergeRequestApprovalManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.mixins.UpdateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.merge_request_approvals.ProjectMergeRequestApproval]#

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.merge_request_approvals.ProjectMergeRequestApproval]

gitlab: gitlab.client.Gitlab#
set_approvers(approvals_required: int, approver_ids: Optional[List[int]] = None, approver_group_ids: Optional[List[int]] = None, approval_rule_name: str = 'name', **kwargs: Any) → gitlab.base.RESTObject#

Change MR-level allowed approvers and approver groups.

Parameters

  • approvals_required (int) – The number of required approvals for this rule

  • approver_ids (Optional[List[int]]) – User IDs that can approve MRs

  • approver_group_ids (Optional[List[int]]) – Group IDs whose members can approve MRs

  • approval_rule_name (str) –

  • kwargs (Any) –

Raises
Return type

gitlab.base.RESTObject

class gitlab.v4.objects.ProjectMergeRequestApprovalRule(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

id: int#
save(**kwargs: Any) → None#

Save the changes made to the object to the server.

The object is updated to match what the server returns.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

class gitlab.v4.objects.ProjectMergeRequestApprovalRuleManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.mixins.UpdateMixin, gitlab.mixins.CreateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object listing filters

  • name

  • rule_type

Object Creation

Object update

Parameters
Return type

None

create(data: Optional[Dict[str, Any]] = None, **kwargs: Any) → gitlab.base.RESTObject#

Create a new object.

Parameters

  • data (Optional[Dict[str, Any]]) – Parameters to send to the server to create the resource

  • **kwargs – Extra options to send to the server (e.g. sudo or ‘ref_name’, ‘stage’, ‘name’, ‘all’)

  • kwargs (Any) –

Raises
Returns

A new instance of the manage object class build with

the data sent by the server

Return type

gitlab.base.RESTObject

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectMergeRequestApprovalState(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectMergeRequestApprovalStateManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.merge_request_approvals.ProjectMergeRequestApprovalState]#

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.merge_request_approvals.ProjectMergeRequestApprovalState]

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectMergeRequestAwardEmoji(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectMergeRequestAwardEmojiManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.NoUpdateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.award_emojis.ProjectMergeRequestAwardEmoji#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.award_emojis.ProjectMergeRequestAwardEmoji

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectMergeRequestDiff(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectMergeRequestDiffManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.merge_requests.ProjectMergeRequestDiff#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.merge_requests.ProjectMergeRequestDiff

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectMergeRequestDiscussion(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.base.RESTObject

Parameters
Return type

None

notes: gitlab.v4.objects.notes.ProjectMergeRequestDiscussionNoteManager#
class gitlab.v4.objects.ProjectMergeRequestDiscussionManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.CreateMixin, gitlab.mixins.UpdateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.discussions.ProjectMergeRequestDiscussion#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.discussions.ProjectMergeRequestDiscussion

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectMergeRequestDiscussionNote(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectMergeRequestDiscussionNoteManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetMixin, gitlab.mixins.CreateMixin, gitlab.mixins.UpdateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.notes.ProjectMergeRequestDiscussionNote#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.notes.ProjectMergeRequestDiscussionNote

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectMergeRequestManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object listing filters

  • state

  • order_by

  • sort

  • milestone

  • view

  • labels

  • created_after

  • created_before

  • updated_after

  • updated_before

  • scope

  • iids

  • author_id

  • assignee_id

  • approver_ids

  • approved_by_ids

  • my_reaction_emoji

  • source_branch

  • target_branch

  • search

  • wip

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.merge_requests.ProjectMergeRequest#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.merge_requests.ProjectMergeRequest

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectMergeRequestNote(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

awardemojis: gitlab.v4.objects.award_emojis.ProjectMergeRequestNoteAwardEmojiManager#
class gitlab.v4.objects.ProjectMergeRequestNoteAwardEmoji(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectMergeRequestNoteAwardEmojiManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.NoUpdateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.award_emojis.ProjectMergeRequestNoteAwardEmoji#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.award_emojis.ProjectMergeRequestNoteAwardEmoji

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectMergeRequestNoteManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.notes.ProjectMergeRequestNote#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.notes.ProjectMergeRequestNote

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectMergeRequestPipeline(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectMergeRequestPipelineManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CreateMixin, gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectMergeRequestResourceLabelEvent(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectMergeRequestResourceLabelEventManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.events.ProjectMergeRequestResourceLabelEvent#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.events.ProjectMergeRequestResourceLabelEvent

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectMergeRequestResourceMilestoneEvent(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectMergeRequestResourceMilestoneEventManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.events.ProjectMergeRequestResourceMilestoneEvent#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.events.ProjectMergeRequestResourceMilestoneEvent

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectMergeRequestResourceStateEvent(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectMergeRequestResourceStateEventManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.events.ProjectMergeRequestResourceStateEvent#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.events.ProjectMergeRequestResourceStateEvent

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectMergeTrain(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectMergeTrainManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object listing filters

  • scope

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectMilestone(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.PromoteMixin, gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

issues(**kwargs: Any) → gitlab.base.RESTObjectList#

List issues related to this milestone.

Parameters

  • all – If True, return all the items, without pagination

  • per_page – Number of items to retrieve per request

  • page – ID of the page to return (starts with page 1)

  • as_list – If set to False and no pagination option is defined, return a generator instead of a list

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The list of issues

Return type

gitlab.base.RESTObjectList

manager: gitlab.base.RESTManager#
merge_requests(**kwargs: Any) → gitlab.base.RESTObjectList#

List the merge requests related to this milestone.

Parameters

  • all – If True, return all the items, without pagination

  • per_page – Number of items to retrieve per request

  • page – ID of the page to return (starts with page 1)

  • as_list – If set to False and no pagination option is defined, return a generator instead of a list

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The list of merge requests

Return type

gitlab.base.RESTObjectList

class gitlab.v4.objects.ProjectMilestoneManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object listing filters

  • iids

  • state

  • search

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.milestones.ProjectMilestone#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.milestones.ProjectMilestone

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectNote(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectNoteManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.notes.ProjectNote#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.notes.ProjectNote

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectNotificationSettings(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.v4.objects.notification_settings.NotificationSettings

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectNotificationSettingsManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.v4.objects.notification_settings.NotificationSettingsManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.notification_settings.ProjectNotificationSettings]#

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.notification_settings.ProjectNotificationSettings]

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectPackage(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

package_files: ProjectPackageFileManager#
class gitlab.v4.objects.ProjectPackageFile(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectPackageFileManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.DeleteMixin, gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectPackageManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.mixins.GetMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object listing filters

  • order_by

  • sort

  • package_type

  • package_name

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.packages.ProjectPackage#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.packages.ProjectPackage

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectPagesDomain(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectPagesDomainManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.pages.ProjectPagesDomain#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.pages.ProjectPagesDomain

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectPipeline(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.RefreshMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

bridges: ProjectPipelineBridgeManager#
cancel(**kwargs: Any) → Union[Dict[str, Any], requests.models.Response]#

Cancel the job.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

Union[Dict[str, Any], requests.models.Response]

jobs: ProjectPipelineJobManager#
retry(**kwargs: Any) → Union[Dict[str, Any], requests.models.Response]#

Retry the job.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

Union[Dict[str, Any], requests.models.Response]

test_report: ProjectPipelineTestReportManager#
test_report_summary: ProjectPipelineTestReportSummaryManager#
variables: ProjectPipelineVariableManager#
class gitlab.v4.objects.ProjectPipelineBridge(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectPipelineBridgeManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object listing filters

  • scope

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectPipelineJob(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectPipelineJobManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object listing filters

  • scope

  • include_retried

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectPipelineManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.CreateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object listing filters

  • scope

  • status

  • ref

  • sha

  • yaml_errors

  • name

  • username

  • order_by

  • sort

Object Creation

Object update

Parameters
Return type

None

create(data: Optional[Dict[str, Any]] = None, **kwargs: Any) → gitlab.v4.objects.pipelines.ProjectPipeline#

Creates a new object.

Parameters

  • data (Optional[Dict[str, Any]]) – Parameters to send to the server to create the resource

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

A new instance of the managed object class build with

the data sent by the server

Return type

gitlab.v4.objects.pipelines.ProjectPipeline

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.pipelines.ProjectPipeline#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.pipelines.ProjectPipeline

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectPipelineSchedule(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

play(**kwargs: Any) → Dict[str, Any]#

Trigger a new scheduled pipeline, which runs immediately. The next scheduled run of this pipeline is not affected.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

Dict[str, Any]

take_ownership(**kwargs: Any) → None#

Update the owner of a pipeline schedule.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

variables: gitlab.v4.objects.pipelines.ProjectPipelineScheduleVariableManager#
class gitlab.v4.objects.ProjectPipelineScheduleManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.pipelines.ProjectPipelineSchedule#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.pipelines.ProjectPipelineSchedule

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectPipelineScheduleVariable(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectPipelineScheduleVariableManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CreateMixin, gitlab.mixins.UpdateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectPipelineTestReport(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectPipelineTestReportManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.pipelines.ProjectPipelineTestReport]#

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.pipelines.ProjectPipelineTestReport]

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectPipelineTestReportSummary(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectPipelineTestReportSummaryManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.pipelines.ProjectPipelineTestReportSummary]#

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.pipelines.ProjectPipelineTestReportSummary]

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectPipelineVariable(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectPipelineVariableManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectProtectedBranch(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectProtectedBranchManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.NoUpdateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.branches.ProjectProtectedBranch#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.branches.ProjectProtectedBranch

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectProtectedTag(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectProtectedTagManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.NoUpdateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.tags.ProjectProtectedTag#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.tags.ProjectProtectedTag

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectPushRules(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectPushRulesManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.mixins.CreateMixin, gitlab.mixins.UpdateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.push_rules.ProjectPushRules]#

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.push_rules.ProjectPushRules]

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectRegistryRepository(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

tags: ProjectRegistryTagManager#
class gitlab.v4.objects.ProjectRegistryRepositoryManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.DeleteMixin, gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectRegistryTag(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectRegistryTagManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.DeleteMixin, gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

delete_in_bulk(name_regex_delete: str, **kwargs: Any) → None#

Delete Tag in bulk

Parameters

  • name_regex_delete (str) – The regex of the name to delete. To delete all tags specify .*.

  • keep_n – The amount of latest tags of given name to keep.

  • name_regex_keep – The regex of the name to keep. This value overrides any matches from name_regex.

  • older_than – Tags to delete that are older than the given time, written in human readable form 1h, 1d, 1month.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.container_registry.ProjectRegistryTag#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.container_registry.ProjectRegistryTag

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectRelease(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.base.RESTObject

Parameters
Return type

None

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.mixins.SaveMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectReleaseLinkManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.releases.ProjectReleaseLink#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.releases.ProjectReleaseLink

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectReleaseManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.releases.ProjectRelease#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.releases.ProjectRelease

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectRemoteMirror(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectRemoteMirrorManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.mixins.CreateMixin, gitlab.mixins.UpdateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectRunner(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectRunnerManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CreateMixin, gitlab.mixins.DeleteMixin, gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object listing filters

  • scope

  • tag_list

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectService(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectServiceManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetMixin, gitlab.mixins.UpdateMixin, gitlab.mixins.DeleteMixin, gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

available(**kwargs: Any) → List[str]#

List the services known by python-gitlab.

Returns

The list of service code names.

Parameters

kwargs (Any) –

Return type

List[str]

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.services.ProjectService#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.services.ProjectService

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectSnippet(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.UserAgentDetailMixin, gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

awardemojis: gitlab.v4.objects.award_emojis.ProjectSnippetAwardEmojiManager#
content(streamed: bool = False, action: Optional[Callable[[...], Any]] = None, chunk_size: int = 1024, **kwargs: Any) → Optional[bytes]#

Return the content of a snippet.

Parameters

  • streamed (bool) – If True the data will be processed by chunks of chunk_size and each chunk is passed to action for treatment.

  • action (Optional[Callable[[...], Any]]) – 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)

  • kwargs (Any) –

Raises
Returns

The snippet content

Return type

Optional[bytes]

discussions: gitlab.v4.objects.discussions.ProjectSnippetDiscussionManager#
notes: gitlab.v4.objects.notes.ProjectSnippetNoteManager#
class gitlab.v4.objects.ProjectSnippetAwardEmoji(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectSnippetAwardEmojiManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.NoUpdateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.award_emojis.ProjectSnippetAwardEmoji#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.award_emojis.ProjectSnippetAwardEmoji

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectSnippetDiscussion(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

notes: gitlab.v4.objects.notes.ProjectSnippetDiscussionNoteManager#
class gitlab.v4.objects.ProjectSnippetDiscussionManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.CreateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.discussions.ProjectSnippetDiscussion#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.discussions.ProjectSnippetDiscussion

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectSnippetDiscussionNote(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectSnippetDiscussionNoteManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetMixin, gitlab.mixins.CreateMixin, gitlab.mixins.UpdateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.notes.ProjectSnippetDiscussionNote#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.notes.ProjectSnippetDiscussionNote

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectSnippetManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.snippets.ProjectSnippet#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.snippets.ProjectSnippet

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectSnippetNote(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

awardemojis: gitlab.v4.objects.award_emojis.ProjectSnippetNoteAwardEmojiManager#
class gitlab.v4.objects.ProjectSnippetNoteAwardEmoji(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectSnippetNoteAwardEmojiManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.NoUpdateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.award_emojis.ProjectSnippetNoteAwardEmoji#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.award_emojis.ProjectSnippetNoteAwardEmoji

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectSnippetNoteManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.notes.ProjectSnippetNote#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.notes.ProjectSnippetNote

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectStorage(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.RefreshMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectStorageManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.projects.ProjectStorage]#

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.projects.ProjectStorage]

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectTag(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectTagManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.NoUpdateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.tags.ProjectTag#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.tags.ProjectTag

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectTrigger(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectTriggerManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.triggers.ProjectTrigger#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.triggers.ProjectTrigger

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectUser(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectUserManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object listing filters

  • search

  • skip_users

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectVariable(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectVariableManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.variables.ProjectVariable#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.variables.ProjectVariable

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.ProjectWiki(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.ProjectWikiManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object listing filters

  • with_content

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.wikis.ProjectWiki#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.wikis.ProjectWiki

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.RepositoryMixin#

Bases: object

delete_merged_branches(**kwargs: Any) → None#

Delete merged branches.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

repository_archive(sha: str = None, streamed: bool = False, action: Optional[Callable[[...], Any]] = None, chunk_size: int = 1024, format: Optional[str] = None, **kwargs: Any) → Optional[bytes]#

Return an archive of the repository.

Parameters

  • sha (str) – ID of the commit (default branch by default)

  • streamed (bool) – If True the data will be processed by chunks of chunk_size and each chunk is passed to action for treatment

  • action (Optional[Callable[[...], Any]]) – Callable responsible of dealing with chunk of data

  • chunk_size (int) – Size of each chunk

  • format (Optional[str]) – file format (tar.gz by default)

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The binary data of the archive

Return type

Optional[bytes]

repository_blob(sha: str, **kwargs: Any) → Union[Dict[str, Any], requests.models.Response]#

Return a file by blob SHA.

Parameters

  • sha (str) – ID of the blob

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The blob content and metadata

Return type

Union[Dict[str, Any], requests.models.Response]

repository_compare(from_: str, to: str, **kwargs: Any) → Union[Dict[str, Any], requests.models.Response]#

Return a diff between two branches/commits.

Parameters

  • from – Source branch/SHA

  • to (str) – Destination branch/SHA

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • from_ (str) –

  • kwargs (Any) –

Raises
Returns

The diff

Return type

Union[Dict[str, Any], requests.models.Response]

repository_contributors(**kwargs: Any) → Union[gitlab.client.GitlabList, List[Dict[str, Any]]]#

Return a list of contributors for the project.

Parameters

  • all – If True, return all the items, without pagination

  • per_page – Number of items to retrieve per request

  • page – ID of the page to return (starts with page 1)

  • as_list – If set to False and no pagination option is defined, return a generator instead of a list

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The contributors

Return type

Union[gitlab.client.GitlabList, List[Dict[str, Any]]]

repository_raw_blob(sha: str, streamed: bool = False, action: Optional[Callable[[...], Any]] = None, chunk_size: int = 1024, **kwargs: Any) → Optional[bytes]#

Return the raw file contents for a blob.

Parameters

  • sha (str) – ID of the blob

  • streamed (bool) – If True the data will be processed by chunks of chunk_size and each chunk is passed to action for treatment

  • action (Optional[Callable[[...], Any]]) – 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)

  • kwargs (Any) –

Raises
Returns

The blob content if streamed is False, None otherwise

Return type

Optional[bytes]

repository_tree(path: str = '', ref: str = '', recursive: bool = False, **kwargs: Any) → Union[gitlab.client.GitlabList, List[Dict[str, Any]]]#

Return a list of files in the repository.

Parameters

  • path (str) – Path of the top folder (/ by default)

  • ref (str) – Reference to a commit or branch

  • recursive (bool) – Whether to get the tree recursively

  • all – If True, return all the items, without pagination

  • per_page – Number of items to retrieve per request

  • page – ID of the page to return (starts with page 1)

  • as_list – If set to False and no pagination option is defined, return a generator instead of a list

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The representation of the tree

Return type

Union[gitlab.client.GitlabList, List[Dict[str, Any]]]

update_submodule(submodule: str, branch: str, commit_sha: str, **kwargs: Any) → Union[Dict[str, Any], requests.models.Response]#

Update a project submodule

Parameters

  • submodule (str) – Full path to the submodule

  • branch (str) – Name of the branch to commit into

  • commit_sha (str) – Full commit SHA to update the submodule to

  • commit_message – Commit message. If no message is provided, a default one will be set (optional)

  • kwargs (Any) –

Raises
Return type

Union[Dict[str, Any], requests.models.Response]

class gitlab.v4.objects.Runner(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

jobs: gitlab.v4.objects.runners.RunnerJobManager#
class gitlab.v4.objects.RunnerJob(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.RunnerJobManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object listing filters

  • status

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.RunnerManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object listing filters

  • scope

  • tag_list

Object Creation

Object update

Parameters
Return type

None

all(scope: Optional[str] = None, **kwargs: Any) → List[gitlab.v4.objects.runners.Runner]#

List all the runners.

Parameters

  • scope (Optional[str]) – The scope of runners to show, one of: specific, shared, active, paused, online

  • all – If True, return all the items, without pagination

  • per_page – Number of items to retrieve per request

  • page – ID of the page to return (starts with page 1)

  • as_list – If set to False and no pagination option is defined, return a generator instead of a list

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

A list of runners matching the scope.

Return type

List[gitlab.v4.objects.runners.Runner]

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.runners.Runner#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.runners.Runner

gitlab: gitlab.client.Gitlab#
verify(token: str, **kwargs: Any) → None#

Validates authentication credentials for a registered Runner.

Parameters

  • token (str) – The runner’s authentication token

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

class gitlab.v4.objects.SidekiqManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.base.RESTManager

Manager for the Sidekiq methods.

This manager doesn’t actually manage objects but provides helper function for the sidekiq metrics API.

Object Creation

Object update

Parameters
Return type

None

compound_metrics(**kwargs: Any) → Union[Dict[str, Any], requests.models.Response]#

Return all available metrics and statistics.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

All available Sidekiq metrics and statistics

Return type

Union[Dict[str, Any], requests.models.Response]

gitlab: gitlab.client.Gitlab#
job_stats(**kwargs: Any) → Union[Dict[str, Any], requests.models.Response]#

Return statistics about the jobs performed.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

Statistics about the Sidekiq jobs performed

Return type

Union[Dict[str, Any], requests.models.Response]

process_metrics(**kwargs: Any) → Union[Dict[str, Any], requests.models.Response]#

Return the registered sidekiq workers.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

Information about the register Sidekiq worker

Return type

Union[Dict[str, Any], requests.models.Response]

queue_metrics(**kwargs: Any) → Union[Dict[str, Any], requests.models.Response]#

Return the registered queues information.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

Information about the Sidekiq queues

Return type

Union[Dict[str, Any], requests.models.Response]

class gitlab.v4.objects.Snippet(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.UserAgentDetailMixin, gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

content(streamed: bool = False, action: Optional[Callable[[...], Any]] = None, chunk_size: int = 1024, **kwargs: Any) → Optional[bytes]#

Return the content of a snippet.

Parameters

  • streamed (bool) – If True the data will be processed by chunks of chunk_size and each chunk is passed to action for treatment.

  • action (Optional[Callable[[...], Any]]) – 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)

  • kwargs (Any) –

Raises
Returns

The snippet content

Return type

Optional[bytes]

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.SnippetManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.snippets.Snippet#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.snippets.Snippet

gitlab: gitlab.client.Gitlab#
public(**kwargs: Any) → Union[gitlab.base.RESTObjectList, List[gitlab.base.RESTObject]]#

List all the public snippets.

Parameters

  • all – If True the returned object will be a list

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises

GitlabListError – If the list could not be retrieved

Returns

A generator for the snippets list

Return type

Union[gitlab.base.RESTObjectList, List[gitlab.base.RESTObject]]

class gitlab.v4.objects.StarredProject(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.StarredProjectManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object listing filters

  • archived

  • membership

  • min_access_level

  • order_by

  • owned

  • search

  • simple

  • sort

  • starred

  • statistics

  • visibility

  • with_custom_attributes

  • with_issues_enabled

  • with_merge_requests_enabled

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.Todo(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
mark_as_done(**kwargs: Any) → Dict[str, Any]#

Mark the todo as done.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

A dict with the result

Return type

Dict[str, Any]

class gitlab.v4.objects.TodoManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object listing filters

  • action

  • author_id

  • project_id

  • state

  • type

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
mark_all_as_done(**kwargs: Any) → None#

Mark all the todos as done.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The number of todos marked done

Return type

None

class gitlab.v4.objects.Topic(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.TopicManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.topics.Topic#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.topics.Topic

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.User(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

activate(**kwargs: Any) → Union[Dict[str, Any], requests.models.Response]#

Activate the user.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

Whether the user status has been changed

Return type

Union[Dict[str, Any], requests.models.Response]

block(**kwargs: Any) → Union[Dict[str, Any], requests.models.Response]#

Block the user.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

Whether the user status has been changed

Return type

Union[Dict[str, Any], requests.models.Response]

customattributes: gitlab.v4.objects.custom_attributes.UserCustomAttributeManager#
deactivate(**kwargs: Any) → Union[Dict[str, Any], requests.models.Response]#

Deactivate the user.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

Whether the user status has been changed

Return type

Union[Dict[str, Any], requests.models.Response]

emails: UserEmailManager#
events: gitlab.v4.objects.events.UserEventManager#
follow(**kwargs: Any) → Union[Dict[str, Any], requests.models.Response]#

Follow the user.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The new object data (not a RESTObject)

Return type

Union[Dict[str, Any], requests.models.Response]

followers_users: UserFollowersManager#
following_users: UserFollowingManager#
gpgkeys: UserGPGKeyManager#
identityproviders: UserIdentityProviderManager#
impersonationtokens: UserImpersonationTokenManager#
keys: UserKeyManager#
memberships: UserMembershipManager#
personal_access_tokens: gitlab.v4.objects.personal_access_tokens.UserPersonalAccessTokenManager#
projects: UserProjectManager#
starred_projects: StarredProjectManager#
status: UserStatusManager#
unblock(**kwargs: Any) → Union[Dict[str, Any], requests.models.Response]#

Unblock the user.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

Whether the user status has been changed

Return type

Union[Dict[str, Any], requests.models.Response]

unfollow(**kwargs: Any) → Union[Dict[str, Any], requests.models.Response]#

Unfollow the user.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The new object data (not a RESTObject)

Return type

Union[Dict[str, Any], requests.models.Response]

class gitlab.v4.objects.UserActivities(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.UserActivitiesManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.UserCustomAttribute(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.UserCustomAttributeManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.SetMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.custom_attributes.UserCustomAttribute#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.custom_attributes.UserCustomAttribute

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.UserEmail(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.UserEmailManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.CreateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.users.UserEmail#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.users.UserEmail

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.UserEvent(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.v4.objects.events.Event

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.UserEventManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.v4.objects.events.EventManager

Object listing filters

  • action

  • target_type

  • before

  • after

  • sort

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.UserGPGKey(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.UserGPGKeyManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.CreateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.users.UserGPGKey#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.users.UserGPGKey

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.UserIdentityProviderManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Manager for user identities.

This manager does not actually manage objects but enables functionality for deletion of user identities by provider.

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.UserImpersonationToken(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.UserImpersonationTokenManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.NoUpdateMixin, gitlab.base.RESTManager

Object listing filters

  • state

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.users.UserImpersonationToken#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.users.UserImpersonationToken

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.UserKey(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.UserKeyManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.CreateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.users.UserKey#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.users.UserKey

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.UserManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object listing filters

  • active

  • blocked

  • username

  • extern_uid

  • provider

  • external

  • search

  • custom_attributes

  • status

  • two_factor

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.users.User#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.users.User

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.UserMembership(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.UserMembershipManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object listing filters

  • type

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.users.UserMembership#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.users.UserMembership

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.UserPersonalAccessToken(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.UserPersonalAccessTokenManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CreateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.UserProject(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.UserProjectManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.ListMixin, gitlab.mixins.CreateMixin, gitlab.base.RESTManager

Object listing filters

  • archived

  • visibility

  • order_by

  • sort

  • search

  • simple

  • owned

  • membership

  • starred

  • statistics

  • with_issues_enabled

  • with_merge_requests_enabled

  • with_custom_attributes

  • with_programming_language

  • wiki_checksum_failed

  • repository_checksum_failed

  • min_access_level

  • id_after

  • id_before

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab#
list(**kwargs: Any) → Union[gitlab.base.RESTObjectList, List[gitlab.base.RESTObject]]#

Retrieve a list of objects.

Parameters

  • all – If True, return all the items, without pagination

  • per_page – Number of items to retrieve per request

  • page – ID of the page to return (starts with page 1)

  • as_list – If set to False and no pagination option is defined, return a generator instead of a list

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The list of objects, or a generator if as_list is False

Raises
Return type

Union[gitlab.base.RESTObjectList, List[gitlab.base.RESTObject]]

class gitlab.v4.objects.UserStatus(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.UserStatusManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.users.UserStatus]#

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.users.UserStatus]

gitlab: gitlab.client.Gitlab#
class gitlab.v4.objects.Variable(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)#

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager#
class gitlab.v4.objects.VariableManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)#

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.variables.Variable#

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.variables.Variable

gitlab: gitlab.client.Gitlab#

Module contents#