Package org.gitlab4j.api

Class JobApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.JobApi

All Implemented Interfaces:

Constants

public class JobApi
extends AbstractApi
implements Constants

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

Nested Class Summary

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

Constants.ActionType, Constants.EpicOrderBy, Constants.GroupOrderBy, Constants.ImpersonationState, 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	Description
JobApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method	Description
Job	cancleJob(int projectId, int jobId)	Cancel specified job in a project.
InputStream	downloadArtifactsFile(Integer projectId, String ref, String jobName)	Get an InputStream pointing to the artifacts file from the given reference name and job provided the job finished successfully.
File	downloadArtifactsFile(Integer projectId, String ref, String jobName, File directory)	Download the artifacts file from the given reference name and job provided the job finished successfully.
InputStream	downloadSingleArtifactsFile(Integer projectId, Integer jobId, Path artifactPath)	Download a single artifact file from within the job's artifacts archive.
File	downloadSingleArtifactsFile(Integer projectId, Integer jobId, Path artifactPath, File directory)	Download a single artifact file from within the job's artifacts archive.
Job	eraseJob(int projectId, int jobId)	Erase specified job in a project.
Job	getJob(int projectId, int jobId)	Get single job in a project.
List<Job>	getJobs(int projectId)	Get a list of jobs in a project.
Pager<Job>	getJobs(int projectId, int itemsPerPage)	Get a Pager of jobs in a project.
List<Job>	getJobs(int projectId, int page, int perPage)	Get a list of jobs in a project in the specified page range.
List<Job>	getJobs(int projectId, Constants.JobScope scope)	Get a list of jobs in a project.
List<Job>	getJobsForPipeline(int projectId, int pipelineId)	Get a list of jobs in a pipeline.
List<Job>	getJobsForPipeline(int projectId, int pipelineId, Constants.JobScope scope)	Get a list of jobs in a pipeline.
Optional<Job>	getOptionalJob(int projectId, int jobId)	Get single job in a project as an Optional instance.
String	getTrace(int projectId, int jobId)	Get a trace of a specific job of a project GET /projects/:id/jobs/:id/trace
Job	playJob(int projectId, int jobId)	Play specified job in a project.
Job	retryJob(int projectId, int jobId)	Retry specified job in a project.

Methods inherited from class org.gitlab4j.api.AbstractApi

addFormParam, addFormParam, delete, delete, get, get, getApiClient, getApiVersion, getDefaultPerPage, getDefaultPerPageParam, getGroupIdOrPath, getPageQueryParams, getProjectIdOrPath, getWithAccepts, handle, isApiVersion, post, post, post, post, post, put, put, putWithFormData, upload, upload, urlEncode, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

JobApi

public JobApi(GitLabApi gitLabApi)

Method Detail

getJobs

public List<Job> getJobs(int projectId)
                  throws GitLabApiException

Get a list of jobs in a project. GET /projects/:id/jobs

Parameters:

projectId - the project ID to get the list of jobs for

Returns:

a list containing the jobs for the specified project ID

Throws:

GitLabApiException - if any exception occurs during execution

getJobs

public List<Job> getJobs(int projectId,
                         int page,
                         int perPage)
                  throws GitLabApiException

Get a list of jobs in a project in the specified page range. GET /projects/:id/jobs

Parameters:

projectId - the project ID to get the list of jobs for

page - the page to get

perPage - the number of Job instances per page

Returns:

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

Throws:

GitLabApiException - if any exception occurs during execution

getJobs

public Pager<Job> getJobs(int projectId,
                          int itemsPerPage)
                   throws GitLabApiException

Get a Pager of jobs in a project. GET /projects/:id/jobs

Parameters:

projectId - the project ID to get the list of jobs for

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

Returns:

a Pager containing the jobs for the specified project ID

Throws:

GitLabApiException - if any exception occurs during execution

getJobs

public List<Job> getJobs(int projectId,
                         Constants.JobScope scope)
                  throws GitLabApiException

Get a list of jobs in a project. GET /projects/:id/jobs

Parameters:

projectId - the project ID to get the list of jobs for

scope - the scope of jobs, one of: CREATED, PENDING, RUNNING, FAILED, SUCCESS, CANCELED, SKIPPED, MANUAL

Returns:

a list containing the jobs for the specified project ID

Throws:

GitLabApiException - if any exception occurs during execution

getJobsForPipeline

public List<Job> getJobsForPipeline(int projectId,
                                    int pipelineId)
                             throws GitLabApiException

Get a list of jobs in a pipeline. GET /projects/:id/pipelines/:pipeline_id/jobs

Parameters:

projectId - the project ID to get the list of pipeline for

pipelineId - the pipeline ID to get the list of jobs for

Returns:

a list containing the jobs for the specified project ID and pipeline ID

Throws:

GitLabApiException - if any exception occurs during execution

getJobsForPipeline

public List<Job> getJobsForPipeline(int projectId,
                                    int pipelineId,
                                    Constants.JobScope scope)
                             throws GitLabApiException

Get a list of jobs in a pipeline. GET /projects/:id/pipelines/:pipeline_id/jobs

Parameters:

projectId - the project ID to get the list of pipeline for

pipelineId - the pipeline ID to get the list of jobs for

scope - the scope of jobs, one of: CREATED, PENDING, RUNNING, FAILED, SUCCESS, CANCELED, SKIPPED, MANUAL

Returns:

a list containing the jobs for the specified project ID and pipeline ID

Throws:

GitLabApiException - if any exception occurs during execution

getJob

public Job getJob(int projectId,
                  int jobId)
           throws GitLabApiException

Get single job in a project. GET /projects/:id/jobs/:job_id

Parameters:

projectId - the project ID to get the specified job for

jobId - the job ID to get

Returns:

a single job for the specified project ID

Throws:

GitLabApiException - if any exception occurs during execution

getOptionalJob

public Optional<Job> getOptionalJob(int projectId,
                                    int jobId)

Get single job in a project as an Optional instance. GET /projects/:id/jobs/:job_id

Parameters:

projectId - the project ID to get the specified job for

jobId - the job ID to get

Returns:

a single job for the specified project ID as an Optional intance

downloadArtifactsFile

public File downloadArtifactsFile(Integer projectId,
                                  String ref,
                                  String jobName,
                                  File directory)
                           throws GitLabApiException

Download the artifacts file from the given reference name and job provided the job finished successfully. The file will be saved to the specified directory. If the file already exists in the directory it will be overwritten. GET /projects/:id/jobs/artifacts/:ref_name/download?job=name

Parameters:

projectId - the ID of the project

ref - the ref from a repository

jobName - the name of the job to download the artifacts for

directory - the File instance of the directory to save the file to, if null will use "java.io.tmpdir"

Returns:

a File instance pointing to the download of the specified artifacts file

Throws:

GitLabApiException - if any exception occurs

downloadArtifactsFile

public InputStream downloadArtifactsFile(Integer projectId,
                                         String ref,
                                         String jobName)
                                  throws GitLabApiException

Get an InputStream pointing to the artifacts file from the given reference name and job provided the job finished successfully. The file will be saved to the specified directory. If the file already exists in the directory it will be overwritten. GET /projects/:id/jobs/artifacts/:ref_name/download?job=name

Parameters:

projectId - the ID of the project

ref - the ref from a repository

jobName - the name of the job to download the artifacts for

Returns:

an InputStream to read the specified artifacts file from

Throws:

GitLabApiException - if any exception occurs

downloadSingleArtifactsFile

public File downloadSingleArtifactsFile(Integer projectId,
                                        Integer jobId,
                                        Path artifactPath,
                                        File directory)
                                 throws GitLabApiException

Download a single artifact file from within the job's artifacts archive. Only a single file is going to be extracted from the archive and streamed to a client. GET /projects/:id/jobs/:job_id/artifacts/*artifact_path

Parameters:

projectId - The ID of the project owned by the authenticated user

jobId - The unique job identifier

artifactPath - Path to a file inside the artifacts archive

directory - the File instance of the directory to save the file to, if null will use "java.io.tmpdir"

Returns:

a File instance pointing to the download of the specified artifacts file

Throws:

GitLabApiException - if any exception occurs

downloadSingleArtifactsFile

public InputStream downloadSingleArtifactsFile(Integer projectId,
                                               Integer jobId,
                                               Path artifactPath)
                                        throws GitLabApiException

Download a single artifact file from within the job's artifacts archive. Only a single file is going to be extracted from the archive and streamed to a client. GET /projects/:id/jobs/:job_id/artifacts/*artifact_path

Parameters:

projectId - The ID of the project owned by the authenticated user

jobId - The unique job identifier

artifactPath - Path to a file inside the artifacts archive

Returns:

an InputStream to read the specified artifacts file from

Throws:

GitLabApiException - if any exception occurs

getTrace

public String getTrace(int projectId,
                       int jobId)
                throws GitLabApiException

Get a trace of a specific job of a project GET /projects/:id/jobs/:id/trace

Parameters:

projectId - the project ID to get the specified job's trace for

jobId - the job ID to get the trace for

Returns:

a String containing the specified job's trace

Throws:

GitLabApiException - if any exception occurs during execution

cancleJob

public Job cancleJob(int projectId,
                     int jobId)
              throws GitLabApiException

Cancel specified job in a project. POST /projects/:id/jobs/:job_id/cancel

Parameters:

projectId - the project ID to cancel specified job

jobId - the ID to cancel job

Returns:

job instance which just canceled

Throws:

GitLabApiException - if any exception occurs during execution

retryJob

public Job retryJob(int projectId,
                    int jobId)
             throws GitLabApiException

Retry specified job in a project. POST /projects/:id/jobs/:job_id/retry

Parameters:

projectId - the project ID to retry speficied job

jobId - the ID to retry job

Returns:

job instance which just retried

Throws:

GitLabApiException - if any exception occurs during execution

eraseJob

public Job eraseJob(int projectId,
                    int jobId)
             throws GitLabApiException

Erase specified job in a project. POST /projects/:id/jobs/:job_id/erase

Parameters:

projectId - the project ID to erase specified job

jobId - the ID to erase job

Returns:

job instance which just erased

Throws:

GitLabApiException - if any exception occurs during execution

playJob

public Job playJob(int projectId,
                   int jobId)
            throws GitLabApiException

Play specified job in a project. POST /projects/:id/jobs/:job_id/play

Parameters:

projectId - the project ID to play specified job

jobId - the ID to play job

Returns:

job instance which just played

Throws:

GitLabApiException - if any exception occurs during execution