Package org.gitlab4j.api

Class ReleasesApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.ReleasesApi

All Implemented Interfaces:

Constants

public class ReleasesApi
extends AbstractApi

This class provides an entry point to all the GitLab Releases API calls.

See Also:

• Releases API at GitLab

Nested Class Summary

Nested classes/interfaces inherited from interface org.gitlab4j.api.Constants

Constants.ActionType, Constants.ApplicationScope, Constants.ArchiveFormat, Constants.AutoDevopsDeployStrategy, Constants.BuildGitStrategy, Constants.CommitBuildState, Constants.ContributorOrderBy, Constants.DeploymentOrderBy, Constants.DeploymentStatus, Constants.DeployTokenScope, Constants.Encoding, Constants.EpicOrderBy, Constants.EventScope, Constants.GroupOrderBy, Constants.GroupSearchScope, Constants.ImpersonationState, Constants.IssueOrderBy, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, Constants.MergeRequestOrderBy, Constants.MergeRequestScope, Constants.MergeRequestSearchIn, Constants.MergeRequestState, Constants.MilestoneState, Constants.PackageOrderBy, Constants.PackageStatus, Constants.PipelineOrderBy, Constants.PipelineScope, Constants.ProjectOrderBy, Constants.ProjectSearchScope, Constants.SearchScope, Constants.SortOrder, Constants.SquashOption, Constants.StateEvent, Constants.TagOrderBy, Constants.TargetType, Constants.TodoAction, Constants.TodoState, Constants.TodoType, Constants.TokenType

Field Summary

Fields inherited from class org.gitlab4j.api.AbstractApi

gitLabApi

Fields inherited from interface org.gitlab4j.api.Constants

NEXT_PAGE_HEADER, PAGE_HEADER, PAGE_PARAM, PER_PAGE, PER_PAGE_PARAM, PREV_PAGE_HEADER, TOTAL_HEADER, TOTAL_PAGES_HEADER

Constructor Summary

Constructors

Constructor	Description
ReleasesApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method	Description
Release	createRelease(Object projectIdOrPath, ReleaseParams params)	Create a Release.
void	deleteRelease(Object projectIdOrPath, String tagName)	Delete a Release.
Optional<Release>	getOptionalRelease(Object projectIdOrPath, String tagName)	Get an Optional instance holding a Release instance for the specific tag name.
Release	getRelease(Object projectIdOrPath, String tagName)	Get a Release for the given tag name.
List<Release>	getReleases(Object projectIdOrPath)	Get a list of releases for a project, sorted by release date.
Pager<Release>	getReleases(Object projectIdOrPath, int itemsPerPage)	Get a Pager of releases for a project, sorted by release date.
Stream<Release>	getReleasesStream(Object projectIdOrPath)	Get a Stream of releases for a project, sorted by release date.
Release	updateRelease(Object projectIdOrPath, ReleaseParams params)	Updates the release notes of a given release.

Methods inherited from class org.gitlab4j.api.AbstractApi

addFormParam, addFormParam, delete, delete, get, get, getApiClient, getApiVersion, getDefaultPerPage, getDefaultPerPageParam, getDefaultPerPageParam, getGroupIdOrPath, getLabelIdOrName, getPageQueryParams, getPageQueryParams, getPerPageQueryParam, getProjectIdOrPath, getUserIdOrUsername, getWithAccepts, handle, head, isApiVersion, patch, patch, post, post, post, post, post, put, put, put, putUpload, putUpload, putWithFormData, upload, upload, upload, upload, urlEncode, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ReleasesApi

public ReleasesApi(GitLabApi gitLabApi)

Method Details

getReleases

public List<Release> getReleases(Object projectIdOrPath)
                          throws GitLabApiException

Get a list of releases for a project, sorted by release date.

GitLab Endpoint: GET /projects/:id/releases

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

Returns:

the list of releases for the specified project

Throws:

GitLabApiException - if any exception occurs

getReleases

public Pager<Release> getReleases(Object projectIdOrPath,
 int itemsPerPage)
                           throws GitLabApiException

Get a Pager of releases for a project, sorted by release date.

GitLab Endpoint: GET /projects/:id/releases

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

itemsPerPage - the number of Release instances that will be fetched per page

Returns:

the Pager of Release instances for the specified project ID

Throws:

GitLabApiException - if any exception occurs

getReleasesStream

public Stream<Release> getReleasesStream(Object projectIdOrPath)
                                  throws GitLabApiException

Get a Stream of releases for a project, sorted by release date.

GitLab Endpoint: GET /projects/:id/releases

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

Returns:

a Stream of Release instances for the specified project ID

Throws:

GitLabApiException - if any exception occurs

getRelease

public Release getRelease(Object projectIdOrPath,
 String tagName)
                   throws GitLabApiException

Get a Release for the given tag name.

GitLab Endpoint: GET /projects/:id/releases/:tagName

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

tagName - the name of the tag to fetch the Release for

Returns:

a Releases instance with info on the specified tag

Throws:

GitLabApiException - if any exception occurs

getOptionalRelease

public Optional<Release> getOptionalRelease(Object projectIdOrPath,
 String tagName)
                                     throws GitLabApiException

Get an Optional instance holding a Release instance for the specific tag name.

GitLab Endpoint: GET /projects/:id/releases/:tagName

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

tagName - the name of the tag to fetch the Release for

Returns:

an Optional instance with the specified Release as the value

Throws:

GitLabApiException - if any exception occurs

createRelease

public Release createRelease(Object projectIdOrPath,
 ReleaseParams params)
                      throws GitLabApiException

Create a Release. You need push access to the repository to create a Release.

GitLab Endpoint: POST /projects/:id/releases

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

params - a ReleaseParams instance holding the parameters for the release

Returns:

a Release instance containing the newly created Release info

Throws:

GitLabApiException - if any exception occurs

updateRelease

public Release updateRelease(Object projectIdOrPath,
 ReleaseParams params)
                      throws GitLabApiException

Updates the release notes of a given release.

GitLab Endpoint: PUT /projects/:id/releases/:tag_name

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

params - a ReleaseParams instance holding the parameters for the release

Returns:

a Release instance containing info on the updated Release

Throws:

GitLabApiException - if any exception occurs

deleteRelease

public void deleteRelease(Object projectIdOrPath,
 String tagName)
                   throws GitLabApiException

Delete a Release. Deleting a Release will not delete the associated tag.

GitLab Endpoint: DELETE /projects/:id/releases/:tag_name

Parameters:

projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance

tagName - the tag name that the release was created from

Throws:

GitLabApiException - if any exception occurs