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	createPipeline(Object projectIdOrPath, String ref, Map<String,String> variables) Create a pipelines in a project.
PipelineSchedule	createPipelineSchedule(Object projectIdOrPath, PipelineSchedule pipelineSchedule) create a pipeline schedule for a project.
Variable	createPipelineScheduleVariable(Object projectIdOrPath, Integer pipelineScheduleId, String key, String value) Create a pipeline schedule variable.
void	deletePipeline(Object projectIdOrPath, int pipelineId) Delete a pipeline from a project.
void	deletePipelineSchedule(Object projectIdOrPath, Integer pipelineScheduleId) Deletes a pipeline schedule from the project.
void	deletePipelineScheduleVariable(Object projectIdOrPath, Integer pipelineScheduleId, String key) Deletes a pipeline schedule variable.
Optional<PipelineSchedule>	getOptionalPipelineSchedule(Object projectIdOrPath, Integer pipelineScheduleId) Get a specific pipeline schedule for project as an Optional instance.
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.
PipelineSchedule	getPipelineSchedule(Object projectIdOrPath, Integer pipelineScheduleId) Get a specific pipeline schedule for project.
List<PipelineSchedule>	getPipelineSchedules(Object projectIdOrPath) Get a list of the project pipeline_schedules for the specified project.
Pager<PipelineSchedule>	getPipelineSchedules(Object projectIdOrPath, int itemsPerPage) Get Pager of project pipeline schedule.
List<PipelineSchedule>	getPipelineSchedules(Object projectIdOrPath, int page, int perPage) Get list of project pipeline schedules in the specified page range.
Stream<PipelineSchedule>	getPipelineSchedulesStream(Object projectIdOrPath) Get a Stream of the project pipeline schedule for the specified project.
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.
PipelineSchedule	takeOwnershipPipelineSchedule(Object projectIdOrPath, Integer pipelineScheduleId) Update the owner of the pipeline schedule of a project.
PipelineSchedule	updatePipelineSchedule(Object projectIdOrPath, PipelineSchedule pipelineSchedule) Modifies a pipeline schedule for project.
Variable	updatePipelineScheduleVariable(Object projectIdOrPath, Integer pipelineScheduleId, String key, String value) Update a pipeline schedule variable.

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

createPipeline

public Pipeline createPipeline(Object projectIdOrPath,
                               String ref,
                               Map<String,String> variables)
                        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

variables - a Map containing the variables available in the pipeline

Returns:

a Pipeline instance with the newly created pipeline info

Throws:

GitLabApiException - if any exception occurs during execution

deletePipeline

public void deletePipeline(Object projectIdOrPath,
                           int pipelineId)
                    throws GitLabApiException

Delete a pipeline from a project.

GitLab Endpoint: DELETE /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 delete

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

getPipelineSchedules

public List<PipelineSchedule> getPipelineSchedules(Object projectIdOrPath)
                                            throws GitLabApiException

Get a list of the project pipeline_schedules for the specified project.

GET /projects/:id/pipeline_schedules

Parameters:

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

Returns:

a list of pipeline schedules for the specified project

Throws:

GitLabApiException - if any exception occurs

getPipelineSchedules

public List<PipelineSchedule> getPipelineSchedules(Object projectIdOrPath,
                                                   int page,
                                                   int perPage)
                                            throws GitLabApiException

Get list of project pipeline schedules in the specified page range.

GET /projects/:id/pipeline_schedules

Parameters:

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

page - the page to get

perPage - the number of ProjectHook instances per page

Returns:

a list of project pipeline_schedules for the specified project in the specified page range

Throws:

GitLabApiException - if any exception occurs

getPipelineSchedules

public Pager<PipelineSchedule> getPipelineSchedules(Object projectIdOrPath,
                                                    int itemsPerPage)
                                             throws GitLabApiException

Get Pager of project pipeline schedule.

GET /projects/:id/pipeline_schedule

Parameters:

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

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

Returns:

a Pager of project pipeline_schedules for the specified project

Throws:

GitLabApiException - if any exception occurs

getPipelineSchedulesStream

public Stream<PipelineSchedule> getPipelineSchedulesStream(Object projectIdOrPath)
                                                    throws GitLabApiException

Get a Stream of the project pipeline schedule for the specified project.

GET /projects/:id/pipeline_schedule

Parameters:

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

Returns:

a Stream of project pipeline schedules for the specified project

Throws:

GitLabApiException - if any exception occurs

getPipelineSchedule

public PipelineSchedule getPipelineSchedule(Object projectIdOrPath,
                                            Integer pipelineScheduleId)
                                     throws GitLabApiException

Get a specific pipeline schedule for project.

GET /projects/:id/pipeline_schedules/:pipeline_schedule_id

Parameters:

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

pipelineScheduleId - the ID of the hook to get

Returns:

the project hook for the specified project ID/hook ID pair

Throws:

GitLabApiException - if any exception occurs

getOptionalPipelineSchedule

public Optional<PipelineSchedule> getOptionalPipelineSchedule(Object projectIdOrPath,
                                                              Integer pipelineScheduleId)

Get a specific pipeline schedule for project as an Optional instance.

GET /projects/:id/pipeline_schedules/:pipeline_schedule_id

Parameters:

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

pipelineScheduleId - the ID of the hook to get

Returns:

the project hook for the specified project ID/hook ID pair as an Optional instance

createPipelineSchedule

public PipelineSchedule createPipelineSchedule(Object projectIdOrPath,
                                               PipelineSchedule pipelineSchedule)
                                        throws GitLabApiException

create a pipeline schedule for a project.

POST /projects/:id/pipeline_schedules

Parameters:

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

pipelineSchedule - a PipelineSchedule instance to create

Returns:

the added PipelineSchedule instance

Throws:

GitLabApiException - if any exception occurs

deletePipelineSchedule

public void deletePipelineSchedule(Object projectIdOrPath,
                                   Integer pipelineScheduleId)
                            throws GitLabApiException

Deletes a pipeline schedule from the project.

DELETE /projects/:id/pipeline_schedules/:pipeline_schedule_id

Parameters:

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

pipelineScheduleId - the project schedule ID to delete

Throws:

GitLabApiException - if any exception occurs

updatePipelineSchedule

public PipelineSchedule updatePipelineSchedule(Object projectIdOrPath,
                                               PipelineSchedule pipelineSchedule)
                                        throws GitLabApiException

Modifies a pipeline schedule for project.

PUT /projects/:id/pipeline_schedules/:pipeline_schedule_id

Parameters:

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

pipelineSchedule - the pipelineSchedule instance that contains the pipelineSchedule info to modify

Returns:

the modified project schedule

Throws:

GitLabApiException - if any exception occurs

takeOwnershipPipelineSchedule

public PipelineSchedule takeOwnershipPipelineSchedule(Object projectIdOrPath,
                                                      Integer pipelineScheduleId)
                                               throws GitLabApiException

Update the owner of the pipeline schedule of a project.

POST /projects/:id/pipeline_schedules/:pipeline_schedule_id/take_ownership

Parameters:

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

pipelineScheduleId - the pipelineSchedule instance id that ownership has to be taken of

Returns:

the modified project schedule

Throws:

GitLabApiException - if any exception occurs

createPipelineScheduleVariable

public Variable createPipelineScheduleVariable(Object projectIdOrPath,
                                               Integer pipelineScheduleId,
                                               String key,
                                               String value)
                                        throws GitLabApiException

Create a pipeline schedule variable.

GitLab Endpoint: POST /projects/:id/pipeline_schedules/:pipeline_schedule_id/variables

Parameters:

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

pipelineScheduleId - the pipelineSchedule ID

key - the key of a variable; must have no more than 255 characters; only A-Z, a-z, 0-9, and _ are allowed

value - the value for the variable

Returns:

a Pipeline instance with the newly created pipeline schedule variable

Throws:

GitLabApiException - if any exception occurs during execution

updatePipelineScheduleVariable

public Variable updatePipelineScheduleVariable(Object projectIdOrPath,
                                               Integer pipelineScheduleId,
                                               String key,
                                               String value)
                                        throws GitLabApiException

Update a pipeline schedule variable.

GitLab Endpoint: PUT /projects/:id/pipeline_schedules/:pipeline_schedule_id/variables/:key

Parameters:

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

pipelineScheduleId - the pipelineSchedule ID

key - the key of an existing pipeline schedule variable

value - the new value for the variable

Returns:

a Pipeline instance with the updated variable

Throws:

GitLabApiException - if any exception occurs during execution

deletePipelineScheduleVariable

public void deletePipelineScheduleVariable(Object projectIdOrPath,
                                           Integer pipelineScheduleId,
                                           String key)
                                    throws GitLabApiException

Deletes a pipeline schedule variable.

DELETE /projects/:id/pipeline_schedules/:pipeline_schedule_id/variables/:key

Parameters:

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

pipelineScheduleId - the pipeline schedule ID

key - the key of an existing pipeline schedule variable

Throws:

GitLabApiException - if any exception occurs