org.ow2.proactive.notification.client.api

Class SubscriptionRestApi

java.lang.Object

org.ow2.proactive.notification.client.api.SubscriptionRestApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-02-12T14:56:03.264844-05:00[America/New_York]")
public class SubscriptionRestApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SubscriptionRestApi()
SubscriptionRestApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
JobSubscription	createJobSubscription(String sessionid, JobSubscriptionRequest jobSubscriptionRequest) Creates a new job subscription
ApiResponse<JobSubscription>	createJobSubscriptionWithHttpInfo(String sessionid, JobSubscriptionRequest jobSubscriptionRequest) Creates a new job subscription
Subscription	deleteSubscriptionById(String sessionid, Long id) Deletes a users job subscription
ApiResponse<Subscription>	deleteSubscriptionByIdWithHttpInfo(String sessionid, Long id) Deletes a users job subscription
ApiClient	getApiClient() Get the API client
Subscription	getChannelSubscription(String sessionid) Retrieves the channel subscription of a user
ApiResponse<Subscription>	getChannelSubscriptionWithHttpInfo(String sessionid) Retrieves the channel subscription of a user
Subscription	getJobPlannerSubscription(String sessionid) Retrieves the job planner subscription of a user
ApiResponse<Subscription>	getJobPlannerSubscriptionWithHttpInfo(String sessionid) Retrieves the job planner subscription of a user
List<Subscription>	getJobSubscriptions(String sessionid) Retrieves the job subscriptions of a user
ApiResponse<List<Subscription>>	getJobSubscriptionsWithHttpInfo(String sessionid) Retrieves the job subscriptions of a user
Subscription	getPcaSubscription(String sessionid) Retrieves the PCA subscription of a user
ApiResponse<Subscription>	getPcaSubscriptionWithHttpInfo(String sessionid) Retrieves the PCA subscription of a user
Subscription	getRmSubscription(String sessionid) Retrieves the RM subscription of a user
ApiResponse<Subscription>	getRmSubscriptionWithHttpInfo(String sessionid) Retrieves the RM subscription of a user
Subscription	getSchedulerSubscription(String sessionid) Creates a new scheduler subscription
ApiResponse<Subscription>	getSchedulerSubscriptionWithHttpInfo(String sessionid) Creates a new scheduler subscription
Map<String,Boolean>	isNotificationMethodsAvailable(String sessionId) Gets available notification methods
ApiResponse<Map<String,Boolean>>	isNotificationMethodsAvailableWithHttpInfo(String sessionId) Gets available notification methods
void	setApiClient(ApiClient apiClient) Set the API client
Subscription	updateChannelSubscription(String sessionid, ChannelSubscriptionUpdate channelSubscriptionUpdate) Updates a channel subscription
ApiResponse<Subscription>	updateChannelSubscriptionWithHttpInfo(String sessionid, ChannelSubscriptionUpdate channelSubscriptionUpdate) Updates a channel subscription
Subscription	updateJobPlannerSubscription(String sessionid, JobPlannerSubscriptionUpdate jobPlannerSubscriptionUpdate) Updates a job planner subscription
ApiResponse<Subscription>	updateJobPlannerSubscriptionWithHttpInfo(String sessionid, JobPlannerSubscriptionUpdate jobPlannerSubscriptionUpdate) Updates a job planner subscription
JobSubscription	updateJobSubscription(String sessionid, JobSubscriptionUpdate jobSubscriptionUpdate) Updates a job subscription
ApiResponse<JobSubscription>	updateJobSubscriptionWithHttpInfo(String sessionid, JobSubscriptionUpdate jobSubscriptionUpdate) Updates a job subscription
Subscription	updatePcaSubscription(String sessionid, PcaSubscriptionUpdate pcaSubscriptionUpdate) Updates a PCA subscription
ApiResponse<Subscription>	updatePcaSubscriptionWithHttpInfo(String sessionid, PcaSubscriptionUpdate pcaSubscriptionUpdate) Updates a PCA subscription
Subscription	updateRmSubscription(String sessionid, RmSubscriptionUpdate rmSubscriptionUpdate) Updates a RM subscription
ApiResponse<Subscription>	updateRmSubscriptionWithHttpInfo(String sessionid, RmSubscriptionUpdate rmSubscriptionUpdate) Updates a RM subscription
Subscription	updateSchedulerSubscription(String sessionid, SchedulerSubscriptionUpdate schedulerSubscriptionUpdate) Updates a scheduler subscription
ApiResponse<Subscription>	updateSchedulerSubscriptionWithHttpInfo(String sessionid, SchedulerSubscriptionUpdate schedulerSubscriptionUpdate) Updates a scheduler subscription

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionRestApi

public SubscriptionRestApi()

SubscriptionRestApi

public SubscriptionRestApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

Get the API client

Returns:

API client

setApiClient

public void setApiClient(ApiClient apiClient)

Set the API client

Parameters:

apiClient - an instance of API client

createJobSubscription

public JobSubscription createJobSubscription(String sessionid,
                                             JobSubscriptionRequest jobSubscriptionRequest)
                                      throws ApiException

Creates a new job subscription

Parameters:

sessionid - (required)

jobSubscriptionRequest - (required)

Returns:

JobSubscription

Throws:

ApiException - if fails to make API call

createJobSubscriptionWithHttpInfo

public ApiResponse<JobSubscription> createJobSubscriptionWithHttpInfo(String sessionid,
                                                                      JobSubscriptionRequest jobSubscriptionRequest)
                                                               throws ApiException

Creates a new job subscription

Parameters:

sessionid - (required)

jobSubscriptionRequest - (required)

Returns:

ApiResponse<JobSubscription>

Throws:

ApiException - if fails to make API call

deleteSubscriptionById

public Subscription deleteSubscriptionById(String sessionid,
                                           Long id)
                                    throws ApiException

Deletes a users job subscription

Parameters:

sessionid - (required)

id - (required)

Returns:

Subscription

Throws:

ApiException - if fails to make API call

deleteSubscriptionByIdWithHttpInfo

public ApiResponse<Subscription> deleteSubscriptionByIdWithHttpInfo(String sessionid,
                                                                    Long id)
                                                             throws ApiException

Deletes a users job subscription

Parameters:

sessionid - (required)

id - (required)

Returns:

ApiResponse<Subscription>

Throws:

ApiException - if fails to make API call

getChannelSubscription

public Subscription getChannelSubscription(String sessionid)
                                    throws ApiException

Retrieves the channel subscription of a user

Parameters:

sessionid - (required)

Returns:

Subscription

Throws:

ApiException - if fails to make API call

getChannelSubscriptionWithHttpInfo

public ApiResponse<Subscription> getChannelSubscriptionWithHttpInfo(String sessionid)
                                                             throws ApiException

Retrieves the channel subscription of a user

Parameters:

sessionid - (required)

Returns:

ApiResponse<Subscription>

Throws:

ApiException - if fails to make API call

getJobPlannerSubscription

public Subscription getJobPlannerSubscription(String sessionid)
                                       throws ApiException

Retrieves the job planner subscription of a user

Parameters:

sessionid - (required)

Returns:

Subscription

Throws:

ApiException - if fails to make API call

getJobPlannerSubscriptionWithHttpInfo

public ApiResponse<Subscription> getJobPlannerSubscriptionWithHttpInfo(String sessionid)
                                                                throws ApiException

Retrieves the job planner subscription of a user

Parameters:

sessionid - (required)

Returns:

ApiResponse<Subscription>

Throws:

ApiException - if fails to make API call

getJobSubscriptions

public List<Subscription> getJobSubscriptions(String sessionid)
                                       throws ApiException

Retrieves the job subscriptions of a user

Parameters:

sessionid - (required)

Returns:

List<Subscription>

Throws:

ApiException - if fails to make API call

getJobSubscriptionsWithHttpInfo

public ApiResponse<List<Subscription>> getJobSubscriptionsWithHttpInfo(String sessionid)
                                                                throws ApiException

Retrieves the job subscriptions of a user

Parameters:

sessionid - (required)

Returns:

ApiResponse<List<Subscription>>

Throws:

ApiException - if fails to make API call

getPcaSubscription

public Subscription getPcaSubscription(String sessionid)
                                throws ApiException

Retrieves the PCA subscription of a user

Parameters:

sessionid - (required)

Returns:

Subscription

Throws:

ApiException - if fails to make API call

getPcaSubscriptionWithHttpInfo

public ApiResponse<Subscription> getPcaSubscriptionWithHttpInfo(String sessionid)
                                                         throws ApiException

Retrieves the PCA subscription of a user

Parameters:

sessionid - (required)

Returns:

ApiResponse<Subscription>

Throws:

ApiException - if fails to make API call

getRmSubscription

public Subscription getRmSubscription(String sessionid)
                               throws ApiException

Retrieves the RM subscription of a user

Parameters:

sessionid - (required)

Returns:

Subscription

Throws:

ApiException - if fails to make API call

getRmSubscriptionWithHttpInfo

public ApiResponse<Subscription> getRmSubscriptionWithHttpInfo(String sessionid)
                                                        throws ApiException

Retrieves the RM subscription of a user

Parameters:

sessionid - (required)

Returns:

ApiResponse<Subscription>

Throws:

ApiException - if fails to make API call

getSchedulerSubscription

public Subscription getSchedulerSubscription(String sessionid)
                                      throws ApiException

Creates a new scheduler subscription

Parameters:

sessionid - (required)

Returns:

Subscription

Throws:

ApiException - if fails to make API call

getSchedulerSubscriptionWithHttpInfo

public ApiResponse<Subscription> getSchedulerSubscriptionWithHttpInfo(String sessionid)
                                                               throws ApiException

Creates a new scheduler subscription

Parameters:

sessionid - (required)

Returns:

ApiResponse<Subscription>

Throws:

ApiException - if fails to make API call

isNotificationMethodsAvailable

public Map<String,Boolean> isNotificationMethodsAvailable(String sessionId)
                                                   throws ApiException

Gets available notification methods

Parameters:

sessionId - (required)

Returns:

Map<String, Boolean>

Throws:

ApiException - if fails to make API call

isNotificationMethodsAvailableWithHttpInfo

public ApiResponse<Map<String,Boolean>> isNotificationMethodsAvailableWithHttpInfo(String sessionId)
                                                                            throws ApiException

Gets available notification methods

Parameters:

sessionId - (required)

Returns:

ApiResponse<Map<String, Boolean>>

Throws:

ApiException - if fails to make API call

updateChannelSubscription

public Subscription updateChannelSubscription(String sessionid,
                                              ChannelSubscriptionUpdate channelSubscriptionUpdate)
                                       throws ApiException

Updates a channel subscription

Parameters:

sessionid - (required)

channelSubscriptionUpdate - (required)

Returns:

Subscription

Throws:

ApiException - if fails to make API call

updateChannelSubscriptionWithHttpInfo

public ApiResponse<Subscription> updateChannelSubscriptionWithHttpInfo(String sessionid,
                                                                       ChannelSubscriptionUpdate channelSubscriptionUpdate)
                                                                throws ApiException

Updates a channel subscription

Parameters:

sessionid - (required)

channelSubscriptionUpdate - (required)

Returns:

ApiResponse<Subscription>

Throws:

ApiException - if fails to make API call

updateJobPlannerSubscription

public Subscription updateJobPlannerSubscription(String sessionid,
                                                 JobPlannerSubscriptionUpdate jobPlannerSubscriptionUpdate)
                                          throws ApiException

Updates a job planner subscription

Parameters:

sessionid - (required)

jobPlannerSubscriptionUpdate - (required)

Returns:

Subscription

Throws:

ApiException - if fails to make API call

updateJobPlannerSubscriptionWithHttpInfo

public ApiResponse<Subscription> updateJobPlannerSubscriptionWithHttpInfo(String sessionid,
                                                                          JobPlannerSubscriptionUpdate jobPlannerSubscriptionUpdate)
                                                                   throws ApiException

Updates a job planner subscription

Parameters:

sessionid - (required)

jobPlannerSubscriptionUpdate - (required)

Returns:

ApiResponse<Subscription>

Throws:

ApiException - if fails to make API call

updateJobSubscription

public JobSubscription updateJobSubscription(String sessionid,
                                             JobSubscriptionUpdate jobSubscriptionUpdate)
                                      throws ApiException

Updates a job subscription

Parameters:

sessionid - (required)

jobSubscriptionUpdate - (required)

Returns:

JobSubscription

Throws:

ApiException - if fails to make API call

updateJobSubscriptionWithHttpInfo

public ApiResponse<JobSubscription> updateJobSubscriptionWithHttpInfo(String sessionid,
                                                                      JobSubscriptionUpdate jobSubscriptionUpdate)
                                                               throws ApiException

Updates a job subscription

Parameters:

sessionid - (required)

jobSubscriptionUpdate - (required)

Returns:

ApiResponse<JobSubscription>

Throws:

ApiException - if fails to make API call

updatePcaSubscription

public Subscription updatePcaSubscription(String sessionid,
                                          PcaSubscriptionUpdate pcaSubscriptionUpdate)
                                   throws ApiException

Updates a PCA subscription

Parameters:

sessionid - (required)

pcaSubscriptionUpdate - (required)

Returns:

Subscription

Throws:

ApiException - if fails to make API call

updatePcaSubscriptionWithHttpInfo

public ApiResponse<Subscription> updatePcaSubscriptionWithHttpInfo(String sessionid,
                                                                   PcaSubscriptionUpdate pcaSubscriptionUpdate)
                                                            throws ApiException

Updates a PCA subscription

Parameters:

sessionid - (required)

pcaSubscriptionUpdate - (required)

Returns:

ApiResponse<Subscription>

Throws:

ApiException - if fails to make API call

updateRmSubscription

public Subscription updateRmSubscription(String sessionid,
                                         RmSubscriptionUpdate rmSubscriptionUpdate)
                                  throws ApiException

Updates a RM subscription

Parameters:

sessionid - (required)

rmSubscriptionUpdate - (required)

Returns:

Subscription

Throws:

ApiException - if fails to make API call

updateRmSubscriptionWithHttpInfo

public ApiResponse<Subscription> updateRmSubscriptionWithHttpInfo(String sessionid,
                                                                  RmSubscriptionUpdate rmSubscriptionUpdate)
                                                           throws ApiException

Updates a RM subscription

Parameters:

sessionid - (required)

rmSubscriptionUpdate - (required)

Returns:

ApiResponse<Subscription>

Throws:

ApiException - if fails to make API call

updateSchedulerSubscription

public Subscription updateSchedulerSubscription(String sessionid,
                                                SchedulerSubscriptionUpdate schedulerSubscriptionUpdate)
                                         throws ApiException

Updates a scheduler subscription

Parameters:

sessionid - (required)

schedulerSubscriptionUpdate - (required)

Returns:

Subscription

Throws:

ApiException - if fails to make API call

updateSchedulerSubscriptionWithHttpInfo

public ApiResponse<Subscription> updateSchedulerSubscriptionWithHttpInfo(String sessionid,
                                                                         SchedulerSubscriptionUpdate schedulerSubscriptionUpdate)
                                                                  throws ApiException

Updates a scheduler subscription

Parameters:

sessionid - (required)

schedulerSubscriptionUpdate - (required)

Returns:

ApiResponse<Subscription>

Throws:

ApiException - if fails to make API call