public class PackagesApi extends AbstractApi
This class implements the client side API for the GitLab Packages API. See Packages API at GitLab for more information.
NOTE: This API is not available in the Community edition of GitLab.Constants.ActionType, Constants.ApplicationScope, Constants.ArchiveFormat, Constants.CommitBuildState, Constants.Encoding, Constants.EpicOrderBy, Constants.GroupOrderBy, Constants.GroupSearchScope, Constants.ImpersonationState, Constants.IssueOrderBy, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, Constants.MergeRequestOrderBy, Constants.MergeRequestScope, Constants.MergeRequestState, Constants.MilestoneState, Constants.PipelineOrderBy, Constants.PipelineScope, Constants.ProjectOrderBy, Constants.ProjectSearchScope, Constants.SearchScope, Constants.SortOrder, Constants.StateEvent, Constants.TagOrderBy, Constants.TargetType, Constants.TokenType
gitLabApi
NEXT_PAGE_HEADER, PAGE_HEADER, PAGE_PARAM, PER_PAGE, PER_PAGE_PARAM, PREV_PAGE_HEADER, TOTAL_HEADER, TOTAL_PAGES_HEADER
Constructor and Description |
---|
PackagesApi(GitLabApi gitLabApi) |
Modifier and Type | Method and Description |
---|---|
void |
deletePackage(Object projectIdOrPath,
Integer packageId)
Deletes a project package.
|
Package |
getPackage(Object projectIdOrPath,
Integer packageId)
Get a single project package.
|
List<PackageFile> |
getPackageFiles(Object projectIdOrPath,
Integer packageId)
Get a list of package files of a single package.
|
Pager<PackageFile> |
getPackageFiles(Object projectIdOrPath,
Integer packageId,
int itemsPerPage)
Get a Pager of project package files.
|
List<PackageFile> |
getPackageFiles(Object projectIdOrPath,
Integer packageId,
int page,
int perPage)
Get a list of package files of a single package for the specified page.
|
List<Package> |
getPackages(Object projectIdOrPath)
Get a list of project packages.
|
Pager<Package> |
getPackages(Object projectIdOrPath,
int itemsPerPage)
Get a Pager of project packages.
|
List<Package> |
getPackages(Object projectIdOrPath,
int page,
int perPage)
Get a list of project packages for the specified page.
|
Stream<Package> |
getPackagesStream(Object projectIdOrPath)
Get a Stream of project packages.
|
Stream<PackageFile> |
getPackagesStream(Object projectIdOrPath,
Integer packageId)
Get a Stream of project package files.
|
addFormParam, addFormParam, delete, delete, get, get, getApiClient, getApiVersion, getDefaultPerPage, getDefaultPerPageParam, getDefaultPerPageParam, getGroupIdOrPath, getPageQueryParams, getPageQueryParams, getPerPageQueryParam, getProjectIdOrPath, getUserIdOrUsername, getWithAccepts, handle, head, isApiVersion, post, post, post, post, post, put, put, putUpload, putUpload, putWithFormData, upload, upload, upload, urlEncode, validate
public PackagesApi(GitLabApi gitLabApi)
public List<Package> getPackages(Object projectIdOrPath) throws GitLabApiException
GitLab Endpoint: GET /projects/:id/packages
projectIdOrPath
- the project in the form of an Integer(ID), String(path), or Project instanceGitLabApiException
- if any exception occurspublic List<Package> getPackages(Object projectIdOrPath, int page, int perPage) throws GitLabApiException
GitLab Endpoint: GET /projects/:id/packages
projectIdOrPath
- the project in the form of an Integer(ID), String(path), or Project instancepage
- the page to getperPage
- the number of Package instances per pageGitLabApiException
- if any exception occurspublic Pager<Package> getPackages(Object projectIdOrPath, int itemsPerPage) throws GitLabApiException
GitLab Endpoint: GET /projects/:id/packages
projectIdOrPath
- the project in the form of an Integer(ID), String(path), or Project instanceitemsPerPage
- the number of Package instances per pageGitLabApiException
- if any exception occurspublic Stream<Package> getPackagesStream(Object projectIdOrPath) throws GitLabApiException
GitLab Endpoint: GET /projects/:id/packages
projectIdOrPath
- the project in the form of an Integer(ID), String(path), or Project instanceGitLabApiException
- if any exception occurspublic Package getPackage(Object projectIdOrPath, Integer packageId) throws GitLabApiException
GitLab Endpoint: GET /projects/:id/packages/:package_id
projectIdOrPath
- the project in the form of an Integer(ID), String(path), or Project instancepackageId
- the ID of the package to getGitLabApiException
- if any exception occurspublic List<PackageFile> getPackageFiles(Object projectIdOrPath, Integer packageId) throws GitLabApiException
GitLab Endpoint: GET /projects/:id/packages/:package_id/package_files
projectIdOrPath
- the project in the form of an Integer(ID), String(path), or Project instancepackageId
- the ID of the package to get the package files forGitLabApiException
- if any exception occurspublic List<PackageFile> getPackageFiles(Object projectIdOrPath, Integer packageId, int page, int perPage) throws GitLabApiException
GitLab Endpoint: GET /projects/:id/packages/:package_id/package_files
projectIdOrPath
- the project in the form of an Integer(ID), String(path), or Project instancepackageId
- the ID of the package to get the package files forpage
- the page to getperPage
- the number of PackageFile instances per pageGitLabApiException
- if any exception occurspublic Pager<PackageFile> getPackageFiles(Object projectIdOrPath, Integer packageId, int itemsPerPage) throws GitLabApiException
GitLab Endpoint: GET /projects/:id/packages/:package_id/package_files
projectIdOrPath
- the project in the form of an Integer(ID), String(path), or Project instancepackageId
- the ID of the package to get the package files foritemsPerPage
- the number of PackageFile instances per pageGitLabApiException
- if any exception occurspublic Stream<PackageFile> getPackagesStream(Object projectIdOrPath, Integer packageId) throws GitLabApiException
GitLab Endpoint: GET /projects/:id/packages/:package_id/package_files
projectIdOrPath
- the project in the form of an Integer(ID), String(path), or Project instancepackageId
- the ID of the package to get the package files forGitLabApiException
- if any exception occurspublic void deletePackage(Object projectIdOrPath, Integer packageId) throws GitLabApiException
GitLab Endpoint: DELETE /projects/:id/packages/:package_id
projectIdOrPath
- the project in the form of an Integer(ID), String(path), or Project instancepackageId
- the ID of the package to deleteGitLabApiException
- if any exception occursCopyright © 2019. All rights reserved.