Package org.sourcelab.buildkite.api.client.util

Class BuildkiteClientUtils

java.lang.Object

org.sourcelab.buildkite.api.client.util.BuildkiteClientUtils

public class BuildkiteClientUtils
extends Object

Collection of Utilities for common access patterns that consists of multiple requests to the Buildkite REST Api.

Constructor Summary

Constructors

Constructor	Description
BuildkiteClientUtils()

Method Summary

Modifier and Type	Method	Description
static <REQUEST, OBJECT> List<OBJECT>	retrieveAll(Filters filters, Class<REQUEST> requestClass, Class<OBJECT> objectClass, BuildkiteClient client)	Helper method to retrieve all entries given a filter criteria.
static MultipleRetriedJobsResults	retryMultipleJobs(RetryMultipleJobsOptions options, BuildkiteClient client)	Given multiple jobs that belong to the same pipeline, retry all of them and return a single result.

Methods inherited from class java.lang.Object

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

Constructor Details

BuildkiteClientUtils

public BuildkiteClientUtils()

Method Details

retrieveAll

public static <REQUEST,
OBJECT> List<OBJECT> retrieveAll(Filters filters,
 Class<REQUEST> requestClass,
 Class<OBJECT> objectClass,
 BuildkiteClient client)

Helper method to retrieve all entries given a filter criteria. The results will be ordered from OLDEST to NEWEST. NOTE: This may result in executing a LARGE number of requests depending on how many entries exist.

Type Parameters:

REQUEST - The request class.

OBJECT - The object within the Response to return.

Parameters:

filters - Search criteria.

requestClass - The request class.

objectClass - The object within the Response to return.

client - The BuildkiteClient to execute the requests against.

Returns:

List of Builds sorted from NEWEST to OLDEST.

Throws:

BuildkiteException - on errors.

retryMultipleJobs

public static MultipleRetriedJobsResults retryMultipleJobs(RetryMultipleJobsOptions options,
 BuildkiteClient client)

Given multiple jobs that belong to the same pipeline, retry all of them and return a single result.

Parameters:

options - Defines the jobs to retry.

client - The client to execute the requests against.

Returns:

Results from retrying multiple jobs.

Throws:

BuildkiteException - on errors.