org.jenkinsci.plugins.newrelicnotifier.api
Interface NewRelicClient

All Known Implementing Classes:

NewRelicClientImpl

public interface NewRelicClient

REST client interface for the New Relic API.

Method Summary

String	getApiEndpoint() Get API Endpoint URL for looking up credentials.
List<Application>	getApplications(String apiKey) Get the list of applications available to record deployment notifications for.
boolean	sendNotification(String apiKey, String applicationId, String description, String revision, String changelog, String user) Submit deployment notification

Method Detail

getApplications

List<Application> getApplications(String apiKey)
                                  throws IOException

Get the list of applications available to record deployment notifications for.

Parameters:

apiKey - New Relic API key

Returns:

A list of applications available for supplied API key.

Throws:

IOException

See Also:

https://docs.newrelic.com/docs/apm/apis/requirements/api-key

sendNotification

boolean sendNotification(String apiKey,
                         String applicationId,
                         String description,
                         String revision,
                         String changelog,
                         String user)
                         throws IOException

Submit deployment notification

Parameters:

apiKey - New Relic API key

applicationId - Application to register deployment for

description - Text annotation for the deployment

revision - The revision number from your source control system

changelog - A list of changes for this deployment

user - The name of the user/process that triggered this deployment

Returns:

Returns true if notifications was successful

Throws:

IOException

See Also:

https://docs.newrelic.com/docs/apm/apis/requirements/api-key

getApiEndpoint

String getApiEndpoint()

Get API Endpoint URL for looking up credentials.

Returns:

The endpoint URL for the New Relic API