Class WebhookRelayAPI

java.lang.Object

com.webhookrelay.jenkins.WebhookRelayAPI

public class WebhookRelayAPI
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebhookRelayAPI.Bucket
static class	WebhookRelayAPI.Input
static class	WebhookRelayAPI.Output

Constructor Summary

Constructors

Constructor	Description
WebhookRelayAPI(Secret apiKey, Secret apiSecret)

Method Summary

Modifier and Type	Method	Description
WebhookRelayAPI.Bucket	createBucket(String name)
WebhookRelayAPI.Input	createInput(String bucketId, String name)
WebhookRelayAPI.Output	createOutput(String bucketId, String name, String destination)
WebhookRelayAPI.Bucket	findBucketByName(String name)	Returns the bucket matching the given name (or id), or null if none exists.
WebhookRelayAPI.Bucket	findOrCreateBucket(String name)	Finds an existing bucket by name, creating it (with its default public input) if it does not exist.
WebhookRelayAPI.Bucket	getBucket(String idOrName)
List<WebhookRelayAPI.Bucket>	listBuckets()

Methods inherited from class Object

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

Constructor Details

WebhookRelayAPI

public WebhookRelayAPI(Secret apiKey,
 Secret apiSecret)

Method Details

listBuckets

public List<WebhookRelayAPI.Bucket> listBuckets()
                                         throws IOException

Throws:

IOException

getBucket

public WebhookRelayAPI.Bucket getBucket(String idOrName)
                                 throws IOException

Throws:

IOException

findBucketByName

public WebhookRelayAPI.Bucket findBucketByName(String name)
                                        throws IOException

Returns the bucket matching the given name (or id), or null if none exists.

Throws:

IOException

findOrCreateBucket

public WebhookRelayAPI.Bucket findOrCreateBucket(String name)
                                          throws IOException

Finds an existing bucket by name, creating it (with its default public input) if it does not exist. The returned bucket is always re-fetched so that the auto-created input (and its public endpoint URL) is populated.

Throws:

IOException

createBucket

public WebhookRelayAPI.Bucket createBucket(String name)
                                    throws IOException

Throws:

IOException

createInput

public WebhookRelayAPI.Input createInput(String bucketId,
 String name)
                                  throws IOException

Throws:

IOException

createOutput

public WebhookRelayAPI.Output createOutput(String bucketId,
 String name,
 String destination)
                                    throws IOException

Throws:

IOException