Package org.azd.servicehooks

Class ServiceHooksApi

java.lang.Object

org.azd.utils.AzDAsyncApi<ServiceHooksApi>

org.azd.servicehooks.ServiceHooksApi

All Implemented Interfaces:

ServiceHooksDetails

public class ServiceHooksApi
extends AzDAsyncApi<ServiceHooksApi>
implements ServiceHooksDetails

Service Hooks Api to manage service hooks service

Constructor Summary

Constructors

Constructor	Description
ServiceHooksApi(Connection connection)	Pass the connection object to work with Service hooks Api

Method Summary

Modifier and Type	Method	Description
ServiceHooksSubscription	createSubscription(ServiceHooks serviceHooks)	Create a subscription.
Void	deleteSubscription(String subscriptionId)	Delete a specific service hooks subscription.
ServiceHooksSubscription	getSubscription(String subscriptionId)	Get a specific service hooks subscription.
ServiceHooksSubscriptions	getSubscriptions()	Get a list of subscriptions.
ServiceHooksSubscriptions	getSubscriptions(String consumerActionId, String consumerId, String eventType, String publisherId)	Get a list of subscriptions.

Methods inherited from class org.azd.utils.AzDAsyncApi

createAsync

Methods inherited from class java.lang.Object

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

Constructor Details

ServiceHooksApi

public ServiceHooksApi(Connection connection)

Pass the connection object to work with Service hooks Api

Parameters:

connection - Connection object

Method Details

getSubscription

public ServiceHooksSubscription getSubscription(String subscriptionId)
                                         throws AzDException

Get a specific service hooks subscription.

Specified by:

getSubscription in interface ServiceHooksDetails

Parameters:

subscriptionId - ID for a subscription.

Returns:

ServiceHooksSubscription ServiceHooksSubscription

Throws:

AzDException - Default Api Exception handler.

getSubscriptions

public ServiceHooksSubscriptions getSubscriptions()
                                           throws AzDException

Get a list of subscriptions.

Specified by:

getSubscriptions in interface ServiceHooksDetails

Returns:

ServiceHooksSubscriptions ServiceHooksSubscriptions

Throws:

AzDException - Default Api Exception handler.

getSubscriptions

public ServiceHooksSubscriptions getSubscriptions(String consumerActionId,
 String consumerId,
 String eventType,
 String publisherId)
                                           throws AzDException

Get a list of subscriptions.

Specified by:

getSubscriptions in interface ServiceHooksDetails

Parameters:

consumerActionId - ID for a consumerActionId.

consumerId - ID for a consumer.

eventType - The event type to filter on (if any).

publisherId - ID for a subscription.

Returns:

ServiceHooksSubscriptions ServiceHooksSubscriptions

Throws:

AzDException - Default Api Exception handler.

deleteSubscription

public Void deleteSubscription(String subscriptionId)
                        throws AzDException

Delete a specific service hooks subscription.

Specified by:

deleteSubscription in interface ServiceHooksDetails

Parameters:

subscriptionId - ID for a subscription.

Throws:

AzDException - Default Api Exception handler.

createSubscription

public ServiceHooksSubscription createSubscription(ServiceHooks serviceHooks)
                                            throws AzDException

Create a subscription.

Specified by:

createSubscription in interface ServiceHooksDetails

Parameters:

serviceHooks - service hooks object ServiceHooks Reference: https://docs.microsoft.com/en-us/azure/devops/service-hooks/events?view=azure-devops#workitem.created

Returns:

ServiceHooksSubscription ServiceHooksSubscription

Throws:

AzDException - Default Api Exception handler.