Package org.azd.servicehooks.subscriptions

Class SubscriptionsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.servicehooks.subscriptions.SubscriptionsRequestBuilder

public class SubscriptionsRequestBuilder
extends BaseRequestBuilder

Provides functionality to manage Service hooks subscriptions Api.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubscriptionsRequestBuilder.GetQueryParameters	Represents the query parameters.
static class	SubscriptionsRequestBuilder.RequestConfiguration	Request configuration object for the query parameters.

Nested classes/interfaces inherited from class org.azd.abstractions.BaseRequestBuilder

BaseRequestBuilder.ProjectExcludeParameter

Field Summary

Fields inherited from class org.azd.abstractions.BaseRequestBuilder

accessTokenCredential, apiVersion, area, locationId, organizationUrl, serializer

Constructor Summary

Constructors

Constructor	Description
SubscriptionsRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)	Instantiates a new RequestBuilder instance and sets the default values.

Method Summary

Modifier and Type	Method	Description
ServiceHooksSubscription	create(ServiceHooksSubscription subscription)	Create a subscription.
CompletableFuture<ServiceHooksSubscription>	createAsync(ServiceHooksSubscription subscription)	Create a subscription.
SubscriptionsQuery	createQuery(SubscriptionsQuery query)	Query for service hook subscriptions.
CompletableFuture<SubscriptionsQuery>	createQueryAsync(SubscriptionsQuery query)	Query for service hook subscriptions.
Void	delete(String subscriptionId)	Delete a specific service hooks subscription.
CompletableFuture<Void>	deleteAsync(String subscriptionId)	Delete a specific service hooks subscription.
ServiceHooksSubscription	get(String subscriptionId)	Get a specific service hooks subscription.
CompletableFuture<ServiceHooksSubscription>	getAsync(String subscriptionId)	Get a specific service hooks subscription.
ServiceHooksSubscriptions	list()	Get a list of subscriptions.
ServiceHooksSubscriptions	list(Consumer<SubscriptionsRequestBuilder.RequestConfiguration> requestConfiguration)	Get a list of subscriptions.
CompletableFuture<ServiceHooksSubscriptions>	listAsync()	Get a list of subscriptions.
CompletableFuture<ServiceHooksSubscriptions>	listAsync(Consumer<SubscriptionsRequestBuilder.RequestConfiguration> requestConfiguration)	Get a list of subscriptions.

Methods inherited from class org.azd.abstractions.BaseRequestBuilder

builder

Methods inherited from class java.lang.Object

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

Constructor Details

SubscriptionsRequestBuilder

public SubscriptionsRequestBuilder(String organizationUrl,
 AccessTokenCredential accessTokenCredential)

Instantiates a new RequestBuilder instance and sets the default values.

Parameters:

organizationUrl - Represents organization location request url.

accessTokenCredential - Access token credential object.

Method Details

createAsync

public CompletableFuture<ServiceHooksSubscription> createAsync(ServiceHooksSubscription subscription)
                                                        throws AzDException

Create a subscription.

Parameters:

subscription - Subscription object to create a new subscription.

Returns:

ServiceHooksSubscription ServiceHooksSubscription

Throws:

AzDException - Default Api Exception handler.

createQueryAsync

public CompletableFuture<SubscriptionsQuery> createQueryAsync(SubscriptionsQuery query)
                                                       throws AzDException

Query for service hook subscriptions.

Parameters:

query - Subscription query object to query.

Returns:

Subscription query SubscriptionsQuery

Throws:

AzDException - Default Api Exception handler.

deleteAsync

public CompletableFuture<Void> deleteAsync(String subscriptionId)
                                    throws AzDException

Delete a specific service hooks subscription.

Parameters:

subscriptionId - ID for a subscription.

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<ServiceHooksSubscription> getAsync(String subscriptionId)
                                                     throws AzDException

Get a specific service hooks subscription.

Parameters:

subscriptionId - ID for a subscription.

Returns:

ServiceHooksSubscription ServiceHooksSubscription

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<ServiceHooksSubscriptions> listAsync()
                                                       throws AzDException

Get a list of subscriptions.

Returns:

ServiceHooksSubscriptions ServiceHooksSubscriptions

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<ServiceHooksSubscriptions> listAsync(Consumer<SubscriptionsRequestBuilder.RequestConfiguration> requestConfiguration)
                                                       throws AzDException

Get a list of subscriptions.

Parameters:

requestConfiguration - Represents the query parameters.

Returns:

ServiceHooksSubscriptions ServiceHooksSubscriptions

Throws:

AzDException - Default Api Exception handler.

create

public ServiceHooksSubscription create(ServiceHooksSubscription subscription)
                                throws AzDException

Create a subscription.

Parameters:

subscription - Subscription object to create a new subscription.

Returns:

ServiceHooksSubscription ServiceHooksSubscription

Throws:

AzDException - Default Api Exception handler.

createQuery

public SubscriptionsQuery createQuery(SubscriptionsQuery query)
                               throws AzDException

Query for service hook subscriptions.

Parameters:

query - Subscription query object to query.

Returns:

Subscription query SubscriptionsQuery

Throws:

AzDException - Default Api Exception handler.

delete

public Void delete(String subscriptionId)
            throws AzDException

Delete a specific service hooks subscription.

Parameters:

subscriptionId - ID for a subscription.

Throws:

AzDException - Default Api Exception handler.

get

public ServiceHooksSubscription get(String subscriptionId)
                             throws AzDException

Get a specific service hooks subscription.

Parameters:

subscriptionId - ID for a subscription.

Returns:

ServiceHooksSubscription ServiceHooksSubscription

Throws:

AzDException - Default Api Exception handler.

list

public ServiceHooksSubscriptions list()
                               throws AzDException

Get a list of subscriptions.

Returns:

ServiceHooksSubscriptions ServiceHooksSubscriptions

Throws:

AzDException - Default Api Exception handler.

list

public ServiceHooksSubscriptions list(Consumer<SubscriptionsRequestBuilder.RequestConfiguration> requestConfiguration)
                               throws AzDException

Get a list of subscriptions.

Parameters:

requestConfiguration - Represents the query parameters.

Returns:

ServiceHooksSubscriptions ServiceHooksSubscriptions

Throws:

AzDException - Default Api Exception handler.