org.gitlab4j.api

Class LicenseTemplatesApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.LicenseTemplatesApi

All Implemented Interfaces:

Constants

public class LicenseTemplatesApi
extends AbstractApi

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

See Also:

Licenses API

Nested Class Summary

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

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.MergeRequestSearchIn, Constants.MergeRequestState, Constants.MilestoneState, Constants.PipelineOrderBy, Constants.PipelineScope, Constants.ProjectOrderBy, Constants.ProjectSearchScope, Constants.SearchScope, Constants.SortOrder, 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 and Description
LicenseTemplatesApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method and Description
LicenseTemplate	getLicenseTemplate(String key) Get a single license template.
List<LicenseTemplate>	getLicenseTemplates() Get a List of all license templates.
Pager<LicenseTemplate>	getLicenseTemplates(Boolean popular, int itemsPerPage) Get a Pager of license templates.
Pager<LicenseTemplate>	getLicenseTemplates(int itemsPerPage) Get a Pager of all license templates.
Stream<LicenseTemplate>	getLicenseTemplatesStream() Get a Stream of all license templates.
Optional<LicenseTemplate>	getOptionalLicenseTemplate(String key) Get a single license template as the value of an Optional.
List<LicenseTemplate>	getPopularLicenseTemplates() Get a List of popular license templates.
Stream<LicenseTemplate>	getPopularLicenseTemplatesStream() Get a Stream of popular license templates.

Methods inherited from class org.gitlab4j.api.AbstractApi

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

Methods inherited from class java.lang.Object

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

Constructor Detail

LicenseTemplatesApi

public LicenseTemplatesApi(GitLabApi gitLabApi)

Method Detail

getLicenseTemplates

public List<LicenseTemplate> getLicenseTemplates()
                                          throws GitLabApiException

Get a List of all license templates.

GitLab Endpoint: GET /templates/licenses

Returns:

a List of LicenseTemplate instances

Throws:

GitLabApiException - if any exception occurs

getLicenseTemplatesStream

public Stream<LicenseTemplate> getLicenseTemplatesStream()
                                                  throws GitLabApiException

Get a Stream of all license templates.

GitLab Endpoint: GET /templates/licenses

Returns:

a Stream of LicenseTemplate instances

Throws:

GitLabApiException - if any exception occurs

getLicenseTemplates

public Pager<LicenseTemplate> getLicenseTemplates(int itemsPerPage)
                                           throws GitLabApiException

Get a Pager of all license templates.

GitLab Endpoint: GET /templates/licenses

Parameters:

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

Returns:

a Pager of LicenseTemplate instances

Throws:

GitLabApiException - if any exception occurs

getPopularLicenseTemplates

public List<LicenseTemplate> getPopularLicenseTemplates()
                                                 throws GitLabApiException

Get a List of popular license templates.

GitLab Endpoint: GET /templates/licenses?popular=true

Returns:

a List of popular LicenseTemplate instances

Throws:

GitLabApiException - if any exception occurs

getPopularLicenseTemplatesStream

public Stream<LicenseTemplate> getPopularLicenseTemplatesStream()
                                                         throws GitLabApiException

Get a Stream of popular license templates.

GitLab Endpoint: GET /templates/licenses?popular=true

Returns:

a Stream of popular LicenseTemplate instances

Throws:

GitLabApiException - if any exception occurs

getLicenseTemplates

public Pager<LicenseTemplate> getLicenseTemplates(Boolean popular,
                                                  int itemsPerPage)
                                           throws GitLabApiException

Get a Pager of license templates.

GitLab Endpoint: GET /templates/licenses

Parameters:

popular - if true, returns only popular licenses.

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

Returns:

a Pager of LicenseTemplate instances

Throws:

GitLabApiException - if any exception occurs

getLicenseTemplate

public LicenseTemplate getLicenseTemplate(String key)
                                   throws GitLabApiException

Get a single license template.

GitLab Endpoint: GET /templates/licenses/:key

Parameters:

key - The key of the license template

Returns:

a LicenseTemplate instance

Throws:

GitLabApiException - if any exception occurs

getOptionalLicenseTemplate

public Optional<LicenseTemplate> getOptionalLicenseTemplate(String key)

Get a single license template as the value of an Optional.

GitLab Endpoint: GET /templates/licenses/:key

Parameters:

key - The key of the license template

Returns:

a single license template as the value of an Optional.