org.gitlab4j.api.RunnersApi Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gitlab4j-api Show documentation
Show all versions of gitlab4j-api Show documentation
GitLab4J-API (gitlab4j-api) provides a full featured Java client library for working with GitLab repositories and servers via the GitLab REST API.
package org.gitlab4j.api;
import java.util.List;
import java.util.stream.Stream;
import javax.ws.rs.core.GenericType;
import javax.ws.rs.core.Response;
import org.gitlab4j.api.models.Job;
import org.gitlab4j.api.models.JobStatus;
import org.gitlab4j.api.models.Runner;
import org.gitlab4j.api.models.Runner.RunnerStatus;
import org.gitlab4j.api.models.Runner.RunnerType;
import org.gitlab4j.api.models.RunnerDetail;
/**
* This class provides an entry point to all the GitLab API repository files calls.
*/
public class RunnersApi extends AbstractApi {
public RunnersApi(GitLabApi gitLabApi) {
super(gitLabApi);
}
/**
* Get a list of all available runners available to the user.
*
* GitLab Endpoint: GET /runners
*
* @return List of Runners
* @throws GitLabApiException if any exception occurs
*/
public List getRunners() throws GitLabApiException {
return (getRunners(null, null, getDefaultPerPage()).all());
}
/**
* Get a list of all available runners available to the user with pagination support.
*
* GitLab Endpoint: GET /runners
*
* @param page The page offset of runners
* @param perPage The number of runners to get after the page offset
* @return List of Runners
* @throws GitLabApiException if any exception occurs
*/
public List getRunners(int page, int perPage) throws GitLabApiException {
return getRunners(null, null, page, perPage);
}
/**
* Get a list of all available runners available to the user.
*
* GitLab Endpoint: GET /runners
*
* @param itemsPerPage the number of Runner instances that will be fetched per page
* @return a Pager containing the Runners for the user
* @throws GitLabApiException if any exception occurs
*/
public Pager getRunners(int itemsPerPage) throws GitLabApiException {
return (getRunners(null, null, itemsPerPage));
}
/**
* Get a Stream of all available runners available to the user.
*
* GitLab Endpoint: GET /runners
*
* @return Stream of Runners
* @throws GitLabApiException if any exception occurs
*/
public Stream getRunnersStream() throws GitLabApiException {
return (getRunners(null, null, getDefaultPerPage()).stream());
}
/**
* Get a list of all available runners available to the user with pagination support.
*
* GitLab Endpoint: GET /runners
*
* @param type the type of runners to show, one of: instance_type, group_type, project_type, or null
* @param status the status of runners to show, one of: active, paused, online, offline, or null
* @return List of Runners
* @throws GitLabApiException if any exception occurs
*/
public List getRunners(RunnerType type, RunnerStatus status) throws GitLabApiException {
return (getRunners(type, status, getDefaultPerPage()).all());
}
/**
* Get a list of specific runners available to the user.
*
* GitLab Endpoint: GET /runners
*
* @param type the type of runners to show, one of: instance_type, group_type, project_type, or null
* @param status the status of runners to show, one of: active, paused, online, offline, or null
* @param page the page offset of runners
* @param perPage the number of runners to get after the page offset
* @return List of Runners
* @throws GitLabApiException if any exception occurs
*/
public List getRunners(RunnerType type, RunnerStatus status, int page, int perPage) throws GitLabApiException {
GitLabApiForm formData = new GitLabApiForm(page, perPage)
.withParam("type", type, false)
.withParam("status", status, false);
Response response = get(Response.Status.OK, formData.asMap(), "runners");
return (response.readEntity(new GenericType>() {}));
}
/**
* Get a list of specific runners available to the user.
*
* GitLab Endpoint: GET /runners
*
* @param type the type of runners to show, one of: instance_type, group_type, project_type, or null
* @param status the status of runners to show, one of: active, paused, online, offline, or null
* @param itemsPerPage The number of Runner instances that will be fetched per page
* @return a Pager containing the Runners for the user
* @throws GitLabApiException if any exception occurs
*/
public Pager getRunners(RunnerType type, RunnerStatus status, int itemsPerPage) throws GitLabApiException {
GitLabApiForm formData = new GitLabApiForm()
.withParam("type", type, false)
.withParam("status", status, false);
return (new Pager<>(this, Runner.class, itemsPerPage, formData.asMap(), "runners"));
}
/**
* Get a Stream of all available runners available to the user with pagination support.
*
* GitLab Endpoint: GET /runners
*
* @param type the type of runners to show, one of: instance_type, group_type, project_type, or null
* @param status the status of runners to show, one of: active, paused, online, offline, or null
* @return Stream of Runners
* @throws GitLabApiException if any exception occurs
*/
public Stream getRunnersStream(RunnerType type, RunnerStatus status) throws GitLabApiException {
return (getRunners(type, status, getDefaultPerPage()).stream());
}
/**
* Get a list of all runners in the GitLab instance (specific and shared). Access is restricted to users with admin privileges.
*
* GitLab Endpoint: GET /runners/all
*
* @return a List of Runners
* @throws GitLabApiException if any exception occurs
*/
public List getAllRunners() throws GitLabApiException {
return (getAllRunners(null, null, getDefaultPerPage()).all());
}
/**
* Get a list of all runners in the GitLab instance (specific and shared). Access is restricted to users with admin privileges.
*
* GitLab Endpoint: GET /runners/all
*
* @param page The page offset of runners
* @param perPage The number of runners to get after the page offset
* @return a list of all runners in the GitLab instance
* @throws GitLabApiException if any exception occurs
*/
public List getAllRunners(int page, int perPage) throws GitLabApiException {
return (getAllRunners(null, null, page, perPage));
}
/**
* Get a list of all runners in the GitLab instance (specific and shared). Access is restricted to users with admin privileges.
*
* GitLab Endpoint: GET /runners/all
*
* @param itemsPerPage The number of Runner instances that will be fetched per page
* @return List of Runners
* @throws GitLabApiException if any exception occurs
*/
public Pager getAllRunners(int itemsPerPage) throws GitLabApiException {
return getAllRunners(null, null, itemsPerPage);
}
/**
* Get a Stream of all runners in the GitLab instance (specific and shared). Access is restricted to users with admin privileges.
*
* GitLab Endpoint: GET /runners/all
*
* @return a Stream of Runners
* @throws GitLabApiException if any exception occurs
*/
public Stream getAllRunnersStream() throws GitLabApiException {
return (getAllRunners(null, null, getDefaultPerPage()).stream());
}
/**
* Get a list of all runners in the GitLab instance (specific and shared). Access is restricted to users with admin privileges.
*
* GitLab Endpoint: GET /runners/all
*
* @param type the type of runners to show, one of: instance_type, group_type, project_type, or null
* @param status the status of runners to show, one of: active, paused, online, offline, or null
* @return a List of Runners
* @throws GitLabApiException if any exception occurs
*/
public List getAllRunners(RunnerType type, RunnerStatus status) throws GitLabApiException {
return (getAllRunners(type, status, getDefaultPerPage()).all());
}
/**
* Get a list of all runners in the GitLab instance (specific and shared). Access is restricted to users with admin privileges.
*
* GitLab Endpoint: GET /runners/all
*
* @param type the type of runners to show, one of: instance_type, group_type, project_type, or null
* @param status the status of runners to show, one of: active, paused, online, offline, or null
* @param page The page offset of runners
* @param perPage The number of runners to get after the page offset
* @return List of Runners
* @throws GitLabApiException if any exception occurs
*/
public List getAllRunners(RunnerType type, RunnerStatus status, int page, int perPage) throws GitLabApiException {
GitLabApiForm formData = new GitLabApiForm(page, perPage)
.withParam("type", type, false)
.withParam("status", status, false);
Response response = get(Response.Status.OK, formData.asMap(), "runners", "all");
return (response.readEntity(new GenericType>() {}));
}
/**
* Get a list of all runners in the GitLab instance (specific and shared). Access is restricted to users with admin privileges.
*
* GitLab Endpoint: GET /runners/all
*
* @param type the type of runners to show, one of: instance_type, group_type, project_type, or null
* @param status the status of runners to show, one of: active, paused, online, offline, or null
* @param itemsPerPage The number of Runner instances that will be fetched per page
* @return a Pager containing the Runners
* @throws GitLabApiException if any exception occurs
*/
public Pager getAllRunners(RunnerType type, RunnerStatus status, int itemsPerPage) throws GitLabApiException {
GitLabApiForm formData = new GitLabApiForm()
.withParam("type", type, false)
.withParam("status", status, false);
return (new Pager<>(this, Runner.class, itemsPerPage, formData.asMap(), "runners", "all"));
}
/**
* Get a Stream of all runners in the GitLab instance (specific and shared). Access is restricted to users with admin privileges.
*
* GitLab Endpoint: GET /runners/all
*
* @param type the type of runners to show, one of: instance_type, group_type, project_type, or null
* @param status the status of runners to show, one of: active, paused, online, offline, or null
* @return a Stream of Runners
* @throws GitLabApiException if any exception occurs
*/
public Stream getAllRunnersStream(RunnerType type, RunnerStatus status) throws GitLabApiException {
return (getAllRunners(type, status, getDefaultPerPage()).stream());
}
/**
* Get details of a runner.
*
* GitLab Endpoint: GET /runners/:id
*
* @param runnerId Runner id to get details for
* @return RunnerDetail instance.
* @throws GitLabApiException if any exception occurs
*/
public RunnerDetail getRunnerDetail(Integer runnerId) throws GitLabApiException {
if (runnerId == null) {
throw new RuntimeException("runnerId cannot be null");
}
Response response = get(Response.Status.OK, null, "runners", runnerId);
return (response.readEntity(RunnerDetail.class));
}
/**
* Update details of a runner.
*
* GitLab Endpoint: PUT /runners/:id
*
* @param runnerId The ID of a runner
* @param description The description of a runner
* @param active The state of a runner; can be set to true or false
* @param tagList The list of tags for a runner; put array of tags, that should be finally assigned to a runner
* @param runUntagged Flag indicating the runner can execute untagged jobs
* @param locked Flag indicating the runner is locked
* @param accessLevel The access_level of the runner; not_protected or ref_protected
* @return RunnerDetail instance.
* @throws GitLabApiException if any exception occurs
*/
public RunnerDetail updateRunner(Integer runnerId, String description, Boolean active, List tagList,
Boolean runUntagged, Boolean locked, RunnerDetail.RunnerAccessLevel accessLevel) throws GitLabApiException {
if (runnerId == null) {
throw new RuntimeException("runnerId cannot be null");
}
GitLabApiForm formData = new GitLabApiForm()
.withParam("description", description, false)
.withParam("active", active, false)
.withParam("tag_list", tagList, false)
.withParam("run_untagged", runUntagged, false)
.withParam("locked", locked, false)
.withParam("access_level", accessLevel, false);
Response response = put(Response.Status.OK, formData.asMap(), "runners", runnerId);
return (response.readEntity(RunnerDetail.class));
}
/**
* Remove a runner.
*
* GitLab Endpoint: DELETE /runners/:id
*
* @param runnerId The ID of a runner
* @throws GitLabApiException if any exception occurs
*/
public void removeRunner(Integer runnerId) throws GitLabApiException {
if (runnerId == null) {
throw new RuntimeException("runnerId cannot be null");
}
delete(Response.Status.NO_CONTENT, null, "runners", runnerId);
}
/**
* List jobs that are being processed or were processed by specified Runner.
*
* GitLab Endpoint: GET /runners/:id/jobs
*
* @param runnerId The ID of a runner
* @return List jobs that are being processed or were processed by specified Runner
* @throws GitLabApiException if any exception occurs
*/
public List getJobs(Integer runnerId) throws GitLabApiException {
return (getJobs(runnerId, null, getDefaultPerPage()).all());
}
/**
* Get a Stream of jobs that are being processed or were processed by specified Runner.
*
* GitLab Endpoint: GET /runners/:id/jobs
*
* @param runnerId The ID of a runner
* @return a Stream of jobs that are being processed or were processed by specified Runner
* @throws GitLabApiException if any exception occurs
*/
public Stream getJobsStream(Integer runnerId) throws GitLabApiException {
return (getJobs(runnerId, null, getDefaultPerPage()).stream());
}
/**
* List jobs that are being processed or were processed by specified Runner.
*
* GitLab Endpoint: GET /runners/:id/jobs
*
* @param runnerId The ID of a runner
* @param status Status of the job; one of: running, success, failed, canceled
* @return List jobs that are being processed or were processed by specified Runner
* @throws GitLabApiException if any exception occurs
*/
public List getJobs(Integer runnerId, JobStatus status) throws GitLabApiException {
return (getJobs(runnerId, status, getDefaultPerPage()).all());
}
/**
* Get a Stream of jobs that are being processed or were processed by specified Runner.
*
* GitLab Endpoint: GET /runners/:id/jobs
*
* @param runnerId The ID of a runner
* @param status Status of the job; one of: running, success, failed, canceled
* @return a Stream of jobs that are being processed or were processed by specified Runner
* @throws GitLabApiException if any exception occurs
*/
public Stream getJobsStream(Integer runnerId, JobStatus status) throws GitLabApiException {
return (getJobs(runnerId, status, getDefaultPerPage()).stream());
}
/**
* List jobs that are being processed or were processed by specified Runner.
*
* GitLab Endpoint: GET /runners/:id/jobs
*
* @param runnerId The ID of a runner
* @param itemsPerPage The number of Runner instances that will be fetched per page
* @return a Pager containing the Jobs for the Runner
* @throws GitLabApiException if any exception occurs
*/
public Pager getJobs(Integer runnerId, int itemsPerPage) throws GitLabApiException {
return (getJobs(runnerId, null, itemsPerPage));
}
/**
* List jobs that are being processed or were processed by specified Runner.
*
* GitLab Endpoint: GET /runners/:id/jobs
*
* @param runnerId The ID of a runner
* @param status Status of the job; one of: running, success, failed, canceled
* @param itemsPerPage The number of Runner instances that will be fetched per page
* @return a Pager containing the Jobs for the Runner
* @throws GitLabApiException if any exception occurs
*/
public Pager getJobs(Integer runnerId, JobStatus status, int itemsPerPage) throws GitLabApiException {
if (runnerId == null) {
throw new RuntimeException("runnerId cannot be null");
}
GitLabApiForm formData = new GitLabApiForm().withParam("status", status, false);
return (new Pager<>(this, Job.class, itemsPerPage, formData.asMap(), "runners", runnerId, "jobs"));
}
/**
* List all runners (specific and shared) available in the project. Shared runners are listed if at least one
* shared runner is defined and shared runners usage is enabled in the project's settings.
*
* GitLab Endpoint: GET /projects/:id/runners
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @return List of all Runner available in the project
* @throws GitLabApiException if any exception occurs
*/
public List getProjectRunners(Object projectIdOrPath) throws GitLabApiException {
return (getProjectRunners(projectIdOrPath, getDefaultPerPage()).all());
}
/**
* Get a Stream all runners (specific and shared) available in the project. Shared runners are listed if at least one
* shared runner is defined and shared runners usage is enabled in the project's settings.
*
* GitLab Endpoint: GET /projects/:id/runners
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @return a Stream of all Runner available in the project
* @throws GitLabApiException if any exception occurs
*/
public Stream getProjectRunnersStream(Object projectIdOrPath) throws GitLabApiException {
return (getProjectRunners(projectIdOrPath, getDefaultPerPage()).stream());
}
/**
* List all runners (specific and shared) available in the project. Shared runners are listed if at least one
* shared runner is defined and shared runners usage is enabled in the project's settings.
*
* GitLab Endpoint: GET /projects/:id/runners
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param itemsPerPage the number of Project instances that will be fetched per page
* @return Pager of all Runner available in the project
* @throws GitLabApiException if any exception occurs
*/
public Pager getProjectRunners(Object projectIdOrPath, int itemsPerPage) throws GitLabApiException {
return (new Pager<>(this, Runner.class, itemsPerPage, null,
"projects", getProjectIdOrPath(projectIdOrPath), "runners"));
}
/**
* Enable an available specific runner in the project.
*
* GitLab Endpoint: POST /projects/:id/runners
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param runnerId The ID of a runner
* @return Runner instance of the Runner enabled
* @throws GitLabApiException if any exception occurs
*/
public Runner enableRunner(Object projectIdOrPath, Integer runnerId) throws GitLabApiException {
GitLabApiForm formData = new GitLabApiForm().withParam("runner_id", runnerId, true);
Response response = post(Response.Status.CREATED, formData.asMap(),
"projects", getProjectIdOrPath(projectIdOrPath), "runners");
return (response.readEntity(Runner.class));
}
/**
* Disable a specific runner from the project. It works only if the project isn't the only project associated with
* the specified runner. If so, an error is returned. Use the {@link #removeRunner(Integer)} instead.
*
* GitLab Endpoint: DELETE /projects/:id/runners/:runner_id
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param runnerId The ID of a runner
* @return Runner instance of the Runner disabled
* @throws GitLabApiException if any exception occurs
*/
public Runner disableRunner(Object projectIdOrPath, Integer runnerId) throws GitLabApiException {
Response response = delete(Response.Status.OK, null,
"projects", getProjectIdOrPath(projectIdOrPath), "runners", runnerId);
return (response.readEntity(Runner.class));
}
/**
* Register a new runner for the gitlab instance.
*
* GitLab Endpoint: POST /runners/
*
* @param token the token of the project (for project specific runners) or the token from the admin page
* @param description The description of a runner
* @param active The state of a runner; can be set to true or false
* @param tagList The list of tags for a runner; put array of tags, that should be finally assigned to a runner
* @param runUntagged Flag indicating the runner can execute untagged jobs
* @param locked Flag indicating the runner is locked
* @param maximumTimeout the maximum timeout set when this Runner will handle the job
* @return RunnerDetail instance.
* @throws GitLabApiException if any exception occurs
*/
public RunnerDetail registerRunner(String token, String description, Boolean active, List tagList,
Boolean runUntagged, Boolean locked, Integer maximumTimeout) throws GitLabApiException {
GitLabApiForm formData = new GitLabApiForm()
.withParam("token", token, true)
.withParam("description", description, false)
.withParam("active", active, false)
.withParam("locked", locked, false)
.withParam("run_untagged", runUntagged, false)
.withParam("tag_list", tagList, false)
.withParam("maximum_timeout", maximumTimeout, false);
Response response = post(Response.Status.CREATED, formData.asMap(), "runners");
return (response.readEntity(RunnerDetail.class));
}
/**
* Deletes a registered Runner.
*
* GitLab Endpoint: DELETE /runners/
*
* @param token the runners authentication token
* @throws GitLabApiException if any exception occurs
*/
public void deleteRunner(String token) throws GitLabApiException {
GitLabApiForm formData = new GitLabApiForm().withParam("token", token, true);
delete(Response.Status.NO_CONTENT, formData.asMap(), "runners");
}
}