Package gitlab3 :: Class GitLab :: Class Project

[frames] | no frames]

Class Project

A project. http://github.com/gitlabhq/gitlabhq/blob/master/doc/api/projects.md#get-single-project

Nested Classes

[hide private]

Branch
A project branch.

DeployKey
A project deploy key.

Event
A project event.

Hook
A project hook.

Issue
A project issue.

Member
A project member.

MergeRequest
A merge request.

Milestone
A project milestone.

Snippet
A project snippet.

Tag
A project tag.

File
A project file.

Commit
A commit made to the project repository.

WallNote
A wall note.

Instance Methods

[hide private]

delete()
Delete this Project

fork_from(forked_from_id)
Create a forked from relationship between this project and the given project (specified as a project id).

delete_fork()
Delete this project's existing forked from relationship.

get_blob(sha_or_ref_name, filepath)
Get the raw contents of a file.

protect_branch(branch)
Protect a branch.

unprotect_branch(branch)
Unprotect a branch.

branches(limit=None, page=None, per_page=None)
Return a list of Project branches.

find_branch(find_all=False, cached=None, **kwargs)
Find the first matching Branch whose properties match all of the key, value pairs given in the arguments.

branch(id)
Return the Branch specified by the given id.

deploy_keys(limit=None, page=None, per_page=None)
Return a list of Project deploy_keys.

find_deploy_key(find_all=False, cached=None, **kwargs)
Find the first matching DeployKey whose properties match all of the key, value pairs given in the arguments.

deploy_key(id)
Return the DeployKey specified by the given id.

add_deploy_key(title, key)
Add a new deploy_key to this Project

delete_deploy_key(deploy_key)
Equivalent to deploy_key.delete()

events(limit=None, page=None, per_page=None)
Return a list of Project events.

find_event(find_all=False, cached=None, **kwargs)
Find the first matching Event whose properties match all of the key, value pairs given in the arguments.

hooks(limit=None, page=None, per_page=None)
Return a list of Project hooks.

find_hook(find_all=False, cached=None, **kwargs)
Find the first matching Hook whose properties match all of the key, value pairs given in the arguments.

hook(id)
Return the Hook specified by the given id.

add_hook(url)
Add a new hook to this Project

update_hook(hook)
Equivalent to hook.save()

delete_hook(hook)
Equivalent to hook.delete()

issues(limit=None, page=None, per_page=None)
Return a list of Project issues.

find_issue(find_all=False, cached=None, **kwargs)
Find the first matching Issue whose properties match all of the key, value pairs given in the arguments.

issue(id)
Return the Issue specified by the given id.

add_issue(title, description=None, assignee_id=None, milestone_id=None, labels=None, state_event=None)
Add a new issue to this Project

update_issue(issue)
Equivalent to issue.save()

members(limit=None, page=None, per_page=None)
Return a list of Project members.

find_member(find_all=False, cached=None, **kwargs)
Find the first matching Member whose properties match all of the key, value pairs given in the arguments.

member(id)
Return the Member specified by the given id.

add_member(user_id, access_level)
Add a new member to this Project

update_member(member)
Equivalent to member.save()

delete_member(member)
Equivalent to member.delete()

merge_requests(limit=None, page=None, per_page=None)
Return a list of Project merge_requests.

find_merge_request(find_all=False, cached=None, **kwargs)
Find the first matching MergeRequest whose properties match all of the key, value pairs given in the arguments.

merge_request(id)
Return the MergeRequest specified by the given id.

add_merge_request(source_branch, target_branch, title, assignee_id=None)
Add a new merge_request to this Project

update_merge_request(merge_request)
Equivalent to merge_request.save()

milestones(limit=None, page=None, per_page=None)
Return a list of Project milestones.

find_milestone(find_all=False, cached=None, **kwargs)
Find the first matching Milestone whose properties match all of the key, value pairs given in the arguments.

milestone(id)
Return the Milestone specified by the given id.

add_milestone(title, description=None, due_date=None, state_event=None)
Add a new milestone to this Project

update_milestone(milestone)
Equivalent to milestone.save()

snippets(limit=None, page=None, per_page=None)
Return a list of Project snippets.

find_snippet(find_all=False, cached=None, **kwargs)
Find the first matching Snippet whose properties match all of the key, value pairs given in the arguments.

snippet(id)
Return the Snippet specified by the given id.

add_snippet(title, file_name, code, lifetime=None)
Add a new snippet to this Project

update_snippet(snippet)
Equivalent to snippet.save()

delete_snippet(snippet)
Equivalent to snippet.delete()

tags(limit=None, page=None, per_page=None)
Return a list of Project tags.

find_tag(find_all=False, cached=None, **kwargs)
Find the first matching Tag whose properties match all of the key, value pairs given in the arguments.

files(limit=None, page=None, per_page=None)
Return a list of Project files.

find_file(find_all=False, cached=None, **kwargs)
Find the first matching File whose properties match all of the key, value pairs given in the arguments.

commits(limit=None, page=None, per_page=None)
Return a list of Project commits.

find_commit(find_all=False, cached=None, **kwargs)
Find the first matching Commit whose properties match all of the key, value pairs given in the arguments.

commit(id)
Return the Commit specified by the given id.

wall_notes(limit=None, page=None, per_page=None)
Return a list of Project wall_notes.

find_wall_note(find_all=False, cached=None, **kwargs)
Find the first matching WallNote whose properties match all of the key, value pairs given in the arguments.

wall_note(id)
Return the WallNote specified by the given id.

add_wall_note(body)
Add a new wall_note to this Project

Method Details

[hide private]

delete_fork()

Delete this project's existing forked from relationship. This will succeed if no existing relationship exists.

protect_branch(branch)

Protect a branch. branch can either be a branch object or a branch name. Specifying an already protected branch will have no effect.

unprotect_branch(branch)

Unprotect a branch. branch can either be a branch object or a branch name. Specifying an already unprotected branch will have no effect.

branches(limit=None, page=None, per_page=None)

Return a list of Project branches.

limit can be given to specify the maximum list size.

page and per_page can be used for pagination.

limit should not be specified with either page or per_page. If it is, limit takes precedence.

find_branch(find_all=False, cached=None, **kwargs)

Find the first matching Branch whose properties match all of the key, value pairs given in the arguments.

If find_all is true, a list of all matching branches will be returned. If a cached list is not given, the list to search will be queried from the server each time this is called.

Searching is done via an unoptimized, inefficient o(n) search.

All arguments must be named.

branch(id)

Return the Branch specified by the given id. get_branch() may be used as an alias for this function.

deploy_keys(limit=None, page=None, per_page=None)

Return a list of Project deploy_keys.

limit can be given to specify the maximum list size.

page and per_page can be used for pagination.

limit should not be specified with either page or per_page. If it is, limit takes precedence.

find_deploy_key(find_all=False, cached=None, **kwargs)

Find the first matching DeployKey whose properties match all of the key, value pairs given in the arguments.

If find_all is true, a list of all matching deploy_keys will be returned. If a cached list is not given, the list to search will be queried from the server each time this is called.

Searching is done via an unoptimized, inefficient o(n) search.

All arguments must be named.

deploy_key(id)

Return the DeployKey specified by the given id. get_deploy_key() may be used as an alias for this function.

add_deploy_key(title, key)

Add a new deploy_key to this Project

On success, the newly created object is returned.

events(limit=None, page=None, per_page=None)

Return a list of Project events.

limit can be given to specify the maximum list size.

page and per_page can be used for pagination.

limit should not be specified with either page or per_page. If it is, limit takes precedence.

find_event(find_all=False, cached=None, **kwargs)

Find the first matching Event whose properties match all of the key, value pairs given in the arguments.

If find_all is true, a list of all matching events will be returned. If a cached list is not given, the list to search will be queried from the server each time this is called.

Searching is done via an unoptimized, inefficient o(n) search.

All arguments must be named.

hooks(limit=None, page=None, per_page=None)

Return a list of Project hooks.

limit can be given to specify the maximum list size.

page and per_page can be used for pagination.

limit should not be specified with either page or per_page. If it is, limit takes precedence.

find_hook(find_all=False, cached=None, **kwargs)

Find the first matching Hook whose properties match all of the key, value pairs given in the arguments.

If find_all is true, a list of all matching hooks will be returned. If a cached list is not given, the list to search will be queried from the server each time this is called.

Searching is done via an unoptimized, inefficient o(n) search.

All arguments must be named.

hook(id)

Return the Hook specified by the given id. get_hook() may be used as an alias for this function.

add_hook(url)

Add a new hook to this Project

On success, the newly created object is returned.

issues(limit=None, page=None, per_page=None)

Return a list of Project issues.

limit can be given to specify the maximum list size.

page and per_page can be used for pagination.

limit should not be specified with either page or per_page. If it is, limit takes precedence.

find_issue(find_all=False, cached=None, **kwargs)

Find the first matching Issue whose properties match all of the key, value pairs given in the arguments.

If find_all is true, a list of all matching issues will be returned. If a cached list is not given, the list to search will be queried from the server each time this is called.

Searching is done via an unoptimized, inefficient o(n) search.

All arguments must be named.

issue(id)

Return the Issue specified by the given id. get_issue() may be used as an alias for this function.

add_issue(title, description=None, assignee_id=None, milestone_id=None, labels=None, state_event=None)

Add a new issue to this Project

On success, the newly created object is returned.

members(limit=None, page=None, per_page=None)

Return a list of Project members.

limit can be given to specify the maximum list size.

page and per_page can be used for pagination.

limit should not be specified with either page or per_page. If it is, limit takes precedence.

find_member(find_all=False, cached=None, **kwargs)

Find the first matching Member whose properties match all of the key, value pairs given in the arguments.

If find_all is true, a list of all matching members will be returned. If a cached list is not given, the list to search will be queried from the server each time this is called.

Searching is done via an unoptimized, inefficient o(n) search.

All arguments must be named.

member(id)

Return the Member specified by the given id. get_member() may be used as an alias for this function.

add_member(user_id, access_level)

Add a new member to this Project

On success, the newly created object is returned.

merge_requests(limit=None, page=None, per_page=None)

Return a list of Project merge_requests.

limit can be given to specify the maximum list size.

page and per_page can be used for pagination.

limit should not be specified with either page or per_page. If it is, limit takes precedence.

find_merge_request(find_all=False, cached=None, **kwargs)

Find the first matching MergeRequest whose properties match all of the key, value pairs given in the arguments.

If find_all is true, a list of all matching merge_requests will be returned. If a cached list is not given, the list to search will be queried from the server each time this is called.

Searching is done via an unoptimized, inefficient o(n) search.

All arguments must be named.

merge_request(id)

Return the MergeRequest specified by the given id. get_merge_request() may be used as an alias for this function.

add_merge_request(source_branch, target_branch, title, assignee_id=None)

Add a new merge_request to this Project

On success, the newly created object is returned.

milestones(limit=None, page=None, per_page=None)

Return a list of Project milestones.

limit can be given to specify the maximum list size.

page and per_page can be used for pagination.

limit should not be specified with either page or per_page. If it is, limit takes precedence.

find_milestone(find_all=False, cached=None, **kwargs)

Find the first matching Milestone whose properties match all of the key, value pairs given in the arguments.

If find_all is true, a list of all matching milestones will be returned. If a cached list is not given, the list to search will be queried from the server each time this is called.

Searching is done via an unoptimized, inefficient o(n) search.

All arguments must be named.

milestone(id)

Return the Milestone specified by the given id. get_milestone() may be used as an alias for this function.

add_milestone(title, description=None, due_date=None, state_event=None)

Add a new milestone to this Project

On success, the newly created object is returned.

snippets(limit=None, page=None, per_page=None)

Return a list of Project snippets.

limit can be given to specify the maximum list size.

page and per_page can be used for pagination.

limit should not be specified with either page or per_page. If it is, limit takes precedence.

find_snippet(find_all=False, cached=None, **kwargs)

Find the first matching Snippet whose properties match all of the key, value pairs given in the arguments.

If find_all is true, a list of all matching snippets will be returned. If a cached list is not given, the list to search will be queried from the server each time this is called.

Searching is done via an unoptimized, inefficient o(n) search.

All arguments must be named.

snippet(id)

Return the Snippet specified by the given id. get_snippet() may be used as an alias for this function.

add_snippet(title, file_name, code, lifetime=None)

Add a new snippet to this Project

On success, the newly created object is returned.

tags(limit=None, page=None, per_page=None)

Return a list of Project tags.

limit can be given to specify the maximum list size.

page and per_page can be used for pagination.

limit should not be specified with either page or per_page. If it is, limit takes precedence.

find_tag(find_all=False, cached=None, **kwargs)

Find the first matching Tag whose properties match all of the key, value pairs given in the arguments.

If find_all is true, a list of all matching tags will be returned. If a cached list is not given, the list to search will be queried from the server each time this is called.

Searching is done via an unoptimized, inefficient o(n) search.

All arguments must be named.

files(limit=None, page=None, per_page=None)

Return a list of Project files.

limit can be given to specify the maximum list size.

page and per_page can be used for pagination.

limit should not be specified with either page or per_page. If it is, limit takes precedence.

find_file(find_all=False, cached=None, **kwargs)

Find the first matching File whose properties match all of the key, value pairs given in the arguments.

If find_all is true, a list of all matching files will be returned. If a cached list is not given, the list to search will be queried from the server each time this is called.

Searching is done via an unoptimized, inefficient o(n) search.

All arguments must be named.

commits(limit=None, page=None, per_page=None)

Return a list of Project commits.

limit can be given to specify the maximum list size.

page and per_page can be used for pagination.

limit should not be specified with either page or per_page. If it is, limit takes precedence.

find_commit(find_all=False, cached=None, **kwargs)

Find the first matching Commit whose properties match all of the key, value pairs given in the arguments.

If find_all is true, a list of all matching commits will be returned. If a cached list is not given, the list to search will be queried from the server each time this is called.

Searching is done via an unoptimized, inefficient o(n) search.

All arguments must be named.

commit(id)

Return the Commit specified by the given id. get_commit() may be used as an alias for this function.

wall_notes(limit=None, page=None, per_page=None)

Return a list of Project wall_notes.

limit can be given to specify the maximum list size.

page and per_page can be used for pagination.

limit should not be specified with either page or per_page. If it is, limit takes precedence.

find_wall_note(find_all=False, cached=None, **kwargs)

Find the first matching WallNote whose properties match all of the key, value pairs given in the arguments.

If find_all is true, a list of all matching wall_notes will be returned. If a cached list is not given, the list to search will be queried from the server each time this is called.

Searching is done via an unoptimized, inefficient o(n) search.

All arguments must be named.

wall_note(id)

Return the WallNote specified by the given id. get_wall_note() may be used as an alias for this function.

add_wall_note(body)

Add a new wall_note to this Project

On success, the newly created object is returned.