com.ocadotechnology.newrelic.apiclient.AlertsChannelsApi Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of newrelic-api-client Show documentation

NewRelic Alerts Configurator can be used to configure NewRelic alerts for your application. Instead of defining alerts through UI you can define them in code. It allows you to automatize alerts configuration, easily recover them in case of wipe out and have full history of changes in your version control system.

There is a newer version: 5.0.1

Show newest version

package com.ocadotechnology.newrelic.apiclient;

import com.ocadotechnology.newrelic.apiclient.model.channels.AlertsChannel;

import java.util.List;

public interface AlertsChannelsApi {
    /**
     * Lists all existing Alerts Channels.
     * This method supports pagination - which means it returns list of entries combined from all pages.
     *
     * @return list of all existing {@link AlertsChannel} from NewRelic
     */
    List list();

    /**
     * Creates Alerts Channel.
     * 
     * Although New Relic returns list of channels in its response this method assumes there will be exactly one channel returned.
     *
     * @param channel channel definition to be created
     * @return created {@link AlertsChannel}
     */
    AlertsChannel create(AlertsChannel channel);

    /**
     * Deletes Alerts Channel.
     *
     * @param channelId id of the channel to be deleted
     * @return deleted {@link AlertsChannel}
     */
    AlertsChannel delete(int channelId);

    /**
     * Removes Alerts Channel from Policy definition.
     *
     * @param policyId  id of the policy to be updated
     * @param channelId id of the channel to be removed from the given policy
     * @return {@link AlertsChannel} for the given channel id regardless of being part of the specified policy
     */
    AlertsChannel deleteFromPolicy(int policyId, int channelId);
}