org.gitlab4j.api

Class PipelineApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.PipelineApi

All Implemented Interfaces:

Constants

public class PipelineApi
extends AbstractApi
implements Constants

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

Nested Class Summary

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

Constants.ActionType, Constants.ArchiveFormat, Constants.CommitBuildState, Constants.EpicOrderBy, Constants.GroupOrderBy, 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.SortOrder, Constants.StateEvent, Constants.TargetType, Constants.TokenType

Field Summary

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
PipelineApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method and Description
Pipeline	cancelPipelineJobs(Object projectIdOrPath, int pipelineId) Cancel jobs of specified pipelines in a project.
Pipeline	createPipeline(Object projectIdOrPath, String ref) Create a pipelines in a project.
Pipeline	getPipeline(Object projectIdOrPath, int pipelineId) Get single pipelines in a project.
List<Pipeline>	getPipelines(Object projectIdOrPath) Get a list of pipelines in a project.
List<Pipeline>	getPipelines(Object projectIdOrPath, Constants.PipelineScope scope, PipelineStatus status, String ref, boolean yamlErrors, String name, String username, Constants.PipelineOrderBy orderBy, Constants.SortOrder sort) Get a list of pipelines in a project.
Pager<Pipeline>	getPipelines(Object projectIdOrPath, Constants.PipelineScope scope, PipelineStatus status, String ref, boolean yamlErrors, String name, String username, Constants.PipelineOrderBy orderBy, Constants.SortOrder sort, int itemsPerPage) Get a Pager of pipelines in a project.
List<Pipeline>	getPipelines(Object projectIdOrPath, Constants.PipelineScope scope, PipelineStatus status, String ref, boolean yamlErrors, String name, String username, Constants.PipelineOrderBy orderBy, Constants.SortOrder sort, int page, int perPage) Get a list of pipelines in a project in the specified page range.
Pager<Pipeline>	getPipelines(Object projectIdOrPath, int itemsPerPage) Get a Pager of pipelines in a project.
List<Pipeline>	getPipelines(Object projectIdOrPath, int page, int perPage) Get a list of pipelines in a project in the specified page range.
Stream<Pipeline>	getPipelinesStream(Object projectIdOrPath) Get a Stream of pipelines in a project.
Stream<Pipeline>	getPipelinesStream(Object projectIdOrPath, Constants.PipelineScope scope, PipelineStatus status, String ref, boolean yamlErrors, String name, String username, Constants.PipelineOrderBy orderBy, Constants.SortOrder sort) Get a Stream of pipelines in a project.
Pipeline	retryPipelineJob(Object projectIdOrPath, int pipelineId) Retry a job in specified pipelines in a project.

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

PipelineApi

public PipelineApi(GitLabApi gitLabApi)

Method Detail

getPipelines

public List<Pipeline> getPipelines(Object projectIdOrPath)
                            throws GitLabApiException

Get a list of pipelines in a project.

GitLab Endpoint: GET /projects/:id/pipelines

Parameters:

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

Returns:

a list containing the pipelines for the specified project ID

Throws:

GitLabApiException - if any exception occurs during execution

getPipelines

public List<Pipeline> getPipelines(Object projectIdOrPath,
                                   int page,
                                   int perPage)
                            throws GitLabApiException

Get a list of pipelines in a project in the specified page range.

GitLab Endpoint: GET /projects/:id/pipelines

Parameters:

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

page - the page to get

perPage - the number of Pipeline instances per page

Returns:

a list containing the pipelines for the specified project ID in the specified page range

Throws:

GitLabApiException - if any exception occurs during execution

getPipelines

public Pager<Pipeline> getPipelines(Object projectIdOrPath,
                                    int itemsPerPage)
                             throws GitLabApiException

Get a Pager of pipelines in a project.

GitLab Endpoint: GET /projects/:id/pipelines

Parameters:

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

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

Returns:

a Pager containing the pipelines for the specified project ID

Throws:

GitLabApiException - if any exception occurs during execution

getPipelinesStream

public Stream<Pipeline> getPipelinesStream(Object projectIdOrPath)
                                    throws GitLabApiException

Get a Stream of pipelines in a project.

GitLab Endpoint: GET /projects/:id/pipelines

Parameters:

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

Returns:

a Stream containing the pipelines for the specified project ID

Throws:

GitLabApiException - if any exception occurs during execution

getPipelines

public List<Pipeline> getPipelines(Object projectIdOrPath,
                                   Constants.PipelineScope scope,
                                   PipelineStatus status,
                                   String ref,
                                   boolean yamlErrors,
                                   String name,
                                   String username,
                                   Constants.PipelineOrderBy orderBy,
                                   Constants.SortOrder sort)
                            throws GitLabApiException

Get a list of pipelines in a project.

GitLab Endpoint: GET /projects/:id/pipelines

Parameters:

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

scope - the scope of pipelines, one of: RUNNING, PENDING, FINISHED, BRANCHES, TAGS

status - the status of pipelines, one of: RUNNING, PENDING, SUCCESS, FAILED, CANCELED, SKIPPED

ref - the ref of pipelines

yamlErrors - returns pipelines with invalid configurations

name - the name of the user who triggered pipelines

username - the username of the user who triggered pipelines

orderBy - order pipelines by ID, STATUS, REF, USER_ID (default: ID)

sort - sort pipelines in ASC or DESC order (default: DESC)

Returns:

a list containing the pipelines for the specified project ID

Throws:

GitLabApiException - if any exception occurs during execution

getPipelines

public List<Pipeline> getPipelines(Object projectIdOrPath,
                                   Constants.PipelineScope scope,
                                   PipelineStatus status,
                                   String ref,
                                   boolean yamlErrors,
                                   String name,
                                   String username,
                                   Constants.PipelineOrderBy orderBy,
                                   Constants.SortOrder sort,
                                   int page,
                                   int perPage)
                            throws GitLabApiException

Get a list of pipelines in a project in the specified page range.

GitLab Endpoint: GET /projects/:id/pipelines

Parameters:

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

scope - the scope of pipelines, one of: RUNNING, PENDING, FINISHED, BRANCHES, TAGS

status - the status of pipelines, one of: RUNNING, PENDING, SUCCESS, FAILED, CANCELED, SKIPPED

ref - the ref of pipelines

yamlErrors - returns pipelines with invalid configurations

name - the name of the user who triggered pipelines

username - the username of the user who triggered pipelines

orderBy - order pipelines by ID, STATUS, REF, USER_ID (default: ID)

sort - sort pipelines in ASC or DESC order (default: DESC)

page - the page to get

perPage - the number of Pipeline instances per page

Returns:

a list containing the pipelines for the specified project ID

Throws:

GitLabApiException - if any exception occurs during execution

getPipelinesStream

public Stream<Pipeline> getPipelinesStream(Object projectIdOrPath,
                                           Constants.PipelineScope scope,
                                           PipelineStatus status,
                                           String ref,
                                           boolean yamlErrors,
                                           String name,
                                           String username,
                                           Constants.PipelineOrderBy orderBy,
                                           Constants.SortOrder sort)
                                    throws GitLabApiException

Get a Stream of pipelines in a project.

GitLab Endpoint: GET /projects/:id/pipelines

Parameters:

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

scope - the scope of pipelines, one of: RUNNING, PENDING, FINISHED, BRANCHES, TAGS

status - the status of pipelines, one of: RUNNING, PENDING, SUCCESS, FAILED, CANCELED, SKIPPED

ref - the ref of pipelines

yamlErrors - returns pipelines with invalid configurations

name - the name of the user who triggered pipelines

username - the username of the user who triggered pipelines

orderBy - order pipelines by ID, STATUS, REF, USER_ID (default: ID)

sort - sort pipelines in ASC or DESC order (default: DESC)

Returns:

a Stream containing the pipelines for the specified project ID

Throws:

GitLabApiException - if any exception occurs during execution

getPipelines

public Pager<Pipeline> getPipelines(Object projectIdOrPath,
                                    Constants.PipelineScope scope,
                                    PipelineStatus status,
                                    String ref,
                                    boolean yamlErrors,
                                    String name,
                                    String username,
                                    Constants.PipelineOrderBy orderBy,
                                    Constants.SortOrder sort,
                                    int itemsPerPage)
                             throws GitLabApiException

Get a Pager of pipelines in a project.

GitLab Endpoint: GET /projects/:id/pipelines

Parameters:

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

scope - the scope of pipelines, one of: RUNNING, PENDING, FINISHED, BRANCHES, TAGS

status - the status of pipelines, one of: RUNNING, PENDING, SUCCESS, FAILED, CANCELED, SKIPPED

ref - the ref of pipelines

yamlErrors - returns pipelines with invalid configurations

name - the name of the user who triggered pipelines

username - the username of the user who triggered pipelines

orderBy - order pipelines by ID, STATUS, REF, USER_ID (default: ID)

sort - sort pipelines in ASC or DESC order (default: DESC)

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

Returns:

a list containing the pipelines for the specified project ID

Throws:

GitLabApiException - if any exception occurs during execution

getPipeline

public Pipeline getPipeline(Object projectIdOrPath,
                            int pipelineId)
                     throws GitLabApiException

Get single pipelines in a project.

GitLab Endpoint: GET /projects/:id/pipelines/:pipeline_id

Parameters:

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

pipelineId - the pipeline ID to get

Returns:

a single pipelines for the specified project ID

Throws:

GitLabApiException - if any exception occurs during execution

createPipeline

public Pipeline createPipeline(Object projectIdOrPath,
                               String ref)
                        throws GitLabApiException

Create a pipelines in a project.

GitLab Endpoint: POST /projects/:id/pipeline

Parameters:

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

ref - reference to commit

Returns:

a Pipeline instance with the newly created pipeline info

Throws:

GitLabApiException - if any exception occurs during execution

retryPipelineJob

public Pipeline retryPipelineJob(Object projectIdOrPath,
                                 int pipelineId)
                          throws GitLabApiException

Retry a job in specified pipelines in a project.

GitLab Endpoint: POST /projects/:id/pipelines/:pipeline_id/retry

Parameters:

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

pipelineId - the pipeline ID to retry a job from

Returns:

pipeline instance which just retried

Throws:

GitLabApiException - if any exception occurs during execution

cancelPipelineJobs

public Pipeline cancelPipelineJobs(Object projectIdOrPath,
                                   int pipelineId)
                            throws GitLabApiException

Cancel jobs of specified pipelines in a project.

GitLab Endpoint: POST /projects/:id/pipelines/:pipeline_id/cancel

Parameters:

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

pipelineId - the pipeline ID to cancel jobs

Returns:

pipeline instance which just canceled

Throws:

GitLabApiException - if any exception occurs during execution