Uses of Class
io.jenkins.plugins.batchcontrol.model.RunRequest

Packages that use RunRequest

Package	Description
io.jenkins.plugins.batchcontrol.action
io.jenkins.plugins.batchcontrol.model
io.jenkins.plugins.batchcontrol.ops
io.jenkins.plugins.batchcontrol.policy
io.jenkins.plugins.batchcontrol.store
io.jenkins.plugins.batchcontrol.ui

Uses of RunRequest in io.jenkins.plugins.batchcontrol.action

Methods in io.jenkins.plugins.batchcontrol.action that return RunRequest

Modifier and Type	Method	Description
RunRequest	RequestItem.getRequest()

Methods in io.jenkins.plugins.batchcontrol.action that return types with arguments of type RunRequest

Modifier and Type	Method	Description
List<RunRequest>	RequestsSection.getActiveItems()	Approved requests whose run has not started yet, on the current page, newest first.
List<RunRequest>	RequestsSection.getEndedItems()	Executed, rejected, cancelled, expired and invalidated requests, newest first.
List<RunRequest>	RequestsSection.getPendingItems()	Pending requests on the current page, oldest first (closest to its timeout on top).

Uses of RunRequest in io.jenkins.plugins.batchcontrol.model

Methods in io.jenkins.plugins.batchcontrol.model that return RunRequest

Modifier and Type	Method	Description
static RunRequest	RunRequest.create(String jobFullName, Map<String,String> parameters, String reason, String requester, String approver)	Single-approver form of create(String, Map, String, String, List).
static RunRequest	RunRequest.create(String jobFullName, Map<String,String> parameters, String reason, String requester, List<String> approvers)	Creates a new PENDING request with a random UUID id (D-68) and its creation time from BatchClock, holding the masked display map parameters (D-72).

Uses of RunRequest in io.jenkins.plugins.batchcontrol.ops

Methods in io.jenkins.plugins.batchcontrol.ops that return RunRequest

Modifier and Type	Method	Description
RunRequest	IncidentService.rerun(String incidentId, String approver)	Creates a rerun RunRequest carrying the failed run's own parameter values (D-72: taken from the build's ParametersAction, original secrets and recoverable file values included) and links it both ways: request.incidentId and incident.rerunRequestIds.
RunRequest	IncidentService.rerun(String incidentId, List<String> approvers)	Approver-set form (D-37) of IncidentService.rerun(String, String).

Methods in io.jenkins.plugins.batchcontrol.ops with parameters of type RunRequest

Modifier and Type	Method	Description
static void	NotificationDispatcher.run(NotificationEvent event, RunRequest request)	Event for a run request.
static void	NotificationDispatcher.runEnded(NotificationEvent event, RunRequest request, boolean wasPending, String reason)	D-54: NotificationEvent.CANCELLED, NotificationEvent.EXPIRED or NotificationEvent.INVALIDATED for a run request that ended without a decision.

Uses of RunRequest in io.jenkins.plugins.batchcontrol.policy

Methods in io.jenkins.plugins.batchcontrol.policy that return RunRequest

Modifier and Type	Method	Description
RunRequest	RunRequestService.approve(String id, String comment)	Approves a PENDING request and submits the build.
RunRequest	RunRequestService.cancel(String id)	Cancels a PENDING request; requester or a Manage holder only (SPEC 7).
RunRequest	RunRequestService.changeApprover(String id, String newApprover)	Single-approver form of RunRequestService.changeApprovers(String, List).
RunRequest	RunRequestService.changeApprovers(String id, List<String> newApprovers)	Replaces the designated approver set of a PENDING request; requester only (SPEC item 3, D-26, D-37).
RunRequest	RunRequestService.create(Job<?,?> job, List<ParameterValue> values, String reason, String approver)	Single-approver form of RunRequestService.create(Job, List, String, List, String), without an incident.
RunRequest	RunRequestService.create(Job<?,?> job, List<ParameterValue> values, String reason, List<String> approvers, String incidentId)	Creates a PENDING run request holding the submitted typed values (D-72), linked to an incident when incidentId is given (SPEC item 11: the run listener links a successful rerun back to the incident).
RunRequest	RunRequestService.create(Job<?,?> job, List<ParameterValue> values, Map<String,Long> uploaded, String reason, List<String> approvers, String incidentId)	As RunRequestService.create(Job, List, String, List, String) for a web submission: uploaded maps a parameter name to the size of the uploaded parts its value was created from (RequestBodyLimit.uploadedSize(org.kohsuke.stapler.StaplerRequest2, java.util.Collection<java.lang.String>)), which the kept-size check counts for a value whose own size cannot be read (D-74 (2)).
RunRequest	RunRequestService.create(Job<?,?> job, Map<String,String> parameters, String reason, String approver)	Creates a PENDING run request from string values, designating a single approver: each value becomes a typed value through the job's parameter definition (SimpleParameterDefinition.createValue(String)), or a StringParameterValue where the job defines no such simple parameter, and the request is created as by RunRequestService.create(Job, List, String, List, String).
RunRequest	RunRequestService.load(String id)	Loads a request by id, or null.
RunRequest	RunRequestService.reject(String id, String comment)	Rejects a PENDING request; the comment is mandatory (SPEC 5).

Methods in io.jenkins.plugins.batchcontrol.policy that return types with arguments of type RunRequest

Modifier and Type	Method	Description
List<RunRequest>	RunRequestService.list()	All stored requests, in creation order.

Methods in io.jenkins.plugins.batchcontrol.policy with parameters of type RunRequest

Modifier and Type	Method	Description
boolean	RunRequestService.canCancel(RunRequest request)	D-38b: whether the current user may cancel request: its requester holding BatchControl/Request on the job, or a Manage holder.
boolean	RunRequestService.canChangeApprovers(RunRequest request)	D-38b: whether the current user may change the approvers of request: its requester holding BatchControl/Request on the job.
static boolean	ApprovalPolicy.checkDecision(RunRequest request)	Checks that the current caller may decide (approve/reject) the given request (SPEC item 3: list membership AND the Approve permission at decision time, SPEC item 2: admin self-approval policy, D-37: any member of the designated set).
boolean	RunRequestService.requesterLacksBuild(RunRequest request)	D-38a (SPEC item 6): whether the requester of request (not the current user) lacks Item/Build on the request's job, so an approval also authorises a run the requester could not start.

Uses of RunRequest in io.jenkins.plugins.batchcontrol.store

Methods in io.jenkins.plugins.batchcontrol.store that return RunRequest

Modifier and Type	Method	Description
RunRequest	FileStore.loadRunRequest(String id)
RunRequest	Store.loadRunRequest(String id)	Loads a request by id from <id>.xml, or returns null if it does not exist.

Methods in io.jenkins.plugins.batchcontrol.store that return types with arguments of type RunRequest

Modifier and Type	Method	Description
List<RunRequest>	FileStore.listOpenRunRequests(Consumer<String> unreadable)
default List<RunRequest>	Store.listOpenRunRequests()	Loads the PENDING and APPROVED run requests only, sorted by creation time.
List<RunRequest>	Store.listOpenRunRequests(Consumer<String> unreadable)	As Store.listOpenRunRequests(), and hands the id of every open request left out because its file cannot be read to unreadable, for a caller that must act on it once it can be read (an invalidation it would otherwise miss).
List<RunRequest>	FileStore.listRunRequests()
List<RunRequest>	Store.listRunRequests()	Loads every stored run request, sorted by creation time.

Methods in io.jenkins.plugins.batchcontrol.store with parameters of type RunRequest

Modifier and Type	Method	Description
void	FileStore.saveNewRunRequest(RunRequest request, List<ParameterValue> values)	Stores a new request (D-72, D-74): <id>.xml, then its typed values in <id>.values.xml when there are any (a request without parameters has no values file).
void	Store.saveNewRunRequest(RunRequest request, List<ParameterValue> values)	Stores a new request (D-72, D-74): <id>.xml, then its typed values in <id>.values.xml when there are any (a request without parameters has no values file).
void	FileStore.saveRunRequest(RunRequest request)
void	Store.saveRunRequest(RunRequest request)	Writes (or rewrites, on a status transition) the request XML <id>.xml atomically.

Uses of RunRequest in io.jenkins.plugins.batchcontrol.ui

Methods in io.jenkins.plugins.batchcontrol.ui with parameters of type RunRequest

Modifier and Type	Method	Description
static boolean	Visibility.canSeeRunRequest(RunRequest request)	A run request is visible iff the caller has Manage (or Overall/Administer), OR is the requester, OR is a member of the designated approver set (D-37), OR holds Item/Read on the target job.
static boolean	RequesterPermission.lacksBuild(RunRequest request)	See RunRequestService.requesterLacksBuild(io.jenkins.plugins.batchcontrol.model.RunRequest).