Package org.gitlab4j.api

Class GitLabCiYamlApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.GitLabCiYamlApi

All Implemented Interfaces:

Constants

public class GitLabCiYamlApi
extends AbstractApi

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

See Also:

GitLab CI YAML API

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.DefaultBranchProtectionLevel, 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.ProjectAccessTokenScope, Constants.ProjectCreationLevel, Constants.ProjectOrderBy, Constants.ProjectSearchScope, Constants.SearchScope, Constants.SortOrder, Constants.SquashOption, Constants.StateEvent, Constants.SubgroupCreationLevel, 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
GitLabCiYamlApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method	Description
java.util.List<GitLabCiTemplateElement>	getAllGitLabCiYamlTemplates()	Get all GitLab CI/CD YAML templates.
GitLabCiTemplate	getSingleGitLabCiYamlTemplate(java.lang.String key)	Get a single GitLab CI/CD YAML template.

Methods inherited from class org.gitlab4j.api.AbstractApi

addFormParam, addFormParam, delete, delete, get, get, getApiClient, getApiVersion, getDefaultPerPage, getDefaultPerPageParam, getDefaultPerPageParam, getGroupIdOrPath, getLabelIdOrName, getNamespaceIdOrPath, 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 Detail

GitLabCiYamlApi

public GitLabCiYamlApi(GitLabApi gitLabApi)

Method Detail

getAllGitLabCiYamlTemplates

public java.util.List<GitLabCiTemplateElement> getAllGitLabCiYamlTemplates()
                                                                    throws GitLabApiException

Get all GitLab CI/CD YAML templates.

GitLab Endpoint: GET /templates/gitlab_ci_ymls

Returns:

a list of Gitlab CI YAML Templates

Throws:

GitLabApiException - if any exception occurs

getSingleGitLabCiYamlTemplate

public GitLabCiTemplate getSingleGitLabCiYamlTemplate(java.lang.String key)
                                               throws GitLabApiException

Get a single GitLab CI/CD YAML template.

GitLab Endpoint: GET /templates/gitlab_ci_ymls/:key

Parameters:

key - The key of the GitLab CI YAML template

Returns:

an Gitlab CI YAML Template

Throws:

GitLabApiException - if any exception occurs