org.ow2.proactive.notification.client.api

Class EventRestApi

java.lang.Object

org.ow2.proactive.notification.client.api.EventRestApi

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

Constructor Summary

Constructors

Constructor and Description
EventRestApi()
EventRestApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
Event	createEvent(String sessionid, EventRequest eventRequest) Creates an event
ApiResponse<Event>	createEventWithHttpInfo(String sessionid, EventRequest eventRequest) Creates an event
List<Event>	getAllEvents(String sessionid) Gets all events
ApiResponse<List<Event>>	getAllEventsWithHttpInfo(String sessionid) Gets all events
ApiClient	getApiClient() Get the API client
List<Event>	getEvents(String sessionid) Gets events by session id
ApiResponse<List<Event>>	getEventsWithHttpInfo(String sessionid) Gets events by session id
void	markAllAsReadOrUnread(String sessionid, Boolean hasRead, String readStatus, List<String> eventGroups, List<String> eventTypes, String bucketName, String projectName, String workflowName, Boolean myJobsOnly, String eventSeverities, Set<String> channels) Marks all users events as read/unread matching provided filters
ApiResponse<Void>	markAllAsReadOrUnreadWithHttpInfo(String sessionid, Boolean hasRead, String readStatus, List<String> eventGroups, List<String> eventTypes, String bucketName, String projectName, String workflowName, Boolean myJobsOnly, String eventSeverities, Set<String> channels) Marks all users events as read/unread matching provided filters
List<Event>	markAsReadOrUnread2(String sessionid, Boolean hasRead, List<Long> ids) Marks events as read/unread
ApiResponse<List<Event>>	markAsReadOrUnread2WithHttpInfo(String sessionid, Boolean hasRead, List<Long> ids) Marks events as read/unread
void	removeUserFromAllEvents(String sessionid, String readStatus, List<String> eventGroups, List<String> eventTypes, String bucketName, String projectName, String workflowName, Boolean myJobsOnly, String eventSeverities) Removes user from events matching provided filters, if the events users to notify is empty the event is deleted
ApiResponse<Void>	removeUserFromAllEventsWithHttpInfo(String sessionid, String readStatus, List<String> eventGroups, List<String> eventTypes, String bucketName, String projectName, String workflowName, Boolean myJobsOnly, String eventSeverities) Removes user from events matching provided filters, if the events users to notify is empty the event is deleted
void	removeUserFromEvents(String sessionid, List<Long> ids) Removes user from events, if the events users to notify is empty the event is deleted
ApiResponse<Void>	removeUserFromEventsWithHttpInfo(String sessionid, List<Long> ids) Removes user from events, if the events users to notify is empty the event is deleted
void	setApiClient(ApiClient apiClient) Set the API client

Methods inherited from class java.lang.Object

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

Constructor Detail

EventRestApi

public EventRestApi()

EventRestApi

public EventRestApi(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

createEvent

public Event createEvent(String sessionid,
                         EventRequest eventRequest)
                  throws ApiException

Creates an event

Parameters:

sessionid - (required)

eventRequest - (required)

Returns:

Event

Throws:

ApiException - if fails to make API call

createEventWithHttpInfo

public ApiResponse<Event> createEventWithHttpInfo(String sessionid,
                                                  EventRequest eventRequest)
                                           throws ApiException

Creates an event

Parameters:

sessionid - (required)

eventRequest - (required)

Returns:

ApiResponse<Event>

Throws:

ApiException - if fails to make API call

getAllEvents

public List<Event> getAllEvents(String sessionid)
                         throws ApiException

Gets all events

Parameters:

sessionid - (required)

Returns:

List<Event>

Throws:

ApiException - if fails to make API call

getAllEventsWithHttpInfo

public ApiResponse<List<Event>> getAllEventsWithHttpInfo(String sessionid)
                                                  throws ApiException

Gets all events

Parameters:

sessionid - (required)

Returns:

ApiResponse<List<Event>>

Throws:

ApiException - if fails to make API call

getEvents

public List<Event> getEvents(String sessionid)
                      throws ApiException

Gets events by session id

Parameters:

sessionid - (required)

Returns:

List<Event>

Throws:

ApiException - if fails to make API call

getEventsWithHttpInfo

public ApiResponse<List<Event>> getEventsWithHttpInfo(String sessionid)
                                               throws ApiException

Gets events by session id

Parameters:

sessionid - (required)

Returns:

ApiResponse<List<Event>>

Throws:

ApiException - if fails to make API call

markAllAsReadOrUnread

public void markAllAsReadOrUnread(String sessionid,
                                  Boolean hasRead,
                                  String readStatus,
                                  List<String> eventGroups,
                                  List<String> eventTypes,
                                  String bucketName,
                                  String projectName,
                                  String workflowName,
                                  Boolean myJobsOnly,
                                  String eventSeverities,
                                  Set<String> channels)
                           throws ApiException

Marks all users events as read/unread matching provided filters

Parameters:

sessionid - (required)

hasRead - (required)

readStatus - (optional)

eventGroups - (optional)

eventTypes - (optional)

bucketName - (optional)

projectName - (optional)

workflowName - (optional)

myJobsOnly - (optional)

eventSeverities - (optional)

channels - (optional)

Throws:

ApiException - if fails to make API call

markAllAsReadOrUnreadWithHttpInfo

public ApiResponse<Void> markAllAsReadOrUnreadWithHttpInfo(String sessionid,
                                                           Boolean hasRead,
                                                           String readStatus,
                                                           List<String> eventGroups,
                                                           List<String> eventTypes,
                                                           String bucketName,
                                                           String projectName,
                                                           String workflowName,
                                                           Boolean myJobsOnly,
                                                           String eventSeverities,
                                                           Set<String> channels)
                                                    throws ApiException

Marks all users events as read/unread matching provided filters

Parameters:

sessionid - (required)

hasRead - (required)

readStatus - (optional)

eventGroups - (optional)

eventTypes - (optional)

bucketName - (optional)

projectName - (optional)

workflowName - (optional)

myJobsOnly - (optional)

eventSeverities - (optional)

channels - (optional)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

markAsReadOrUnread2

public List<Event> markAsReadOrUnread2(String sessionid,
                                       Boolean hasRead,
                                       List<Long> ids)
                                throws ApiException

Marks events as read/unread

Parameters:

sessionid - (required)

hasRead - (required)

ids - (optional)

Returns:

List<Event>

Throws:

ApiException - if fails to make API call

markAsReadOrUnread2WithHttpInfo

public ApiResponse<List<Event>> markAsReadOrUnread2WithHttpInfo(String sessionid,
                                                                Boolean hasRead,
                                                                List<Long> ids)
                                                         throws ApiException

Marks events as read/unread

Parameters:

sessionid - (required)

hasRead - (required)

ids - (optional)

Returns:

ApiResponse<List<Event>>

Throws:

ApiException - if fails to make API call

removeUserFromAllEvents

public void removeUserFromAllEvents(String sessionid,
                                    String readStatus,
                                    List<String> eventGroups,
                                    List<String> eventTypes,
                                    String bucketName,
                                    String projectName,
                                    String workflowName,
                                    Boolean myJobsOnly,
                                    String eventSeverities)
                             throws ApiException

Removes user from events matching provided filters, if the events users to notify is empty the event is deleted

Parameters:

sessionid - (required)

readStatus - (optional)

eventGroups - (optional)

eventTypes - (optional)

bucketName - (optional)

projectName - (optional)

workflowName - (optional)

myJobsOnly - (optional)

eventSeverities - (optional)

Throws:

ApiException - if fails to make API call

removeUserFromAllEventsWithHttpInfo

public ApiResponse<Void> removeUserFromAllEventsWithHttpInfo(String sessionid,
                                                             String readStatus,
                                                             List<String> eventGroups,
                                                             List<String> eventTypes,
                                                             String bucketName,
                                                             String projectName,
                                                             String workflowName,
                                                             Boolean myJobsOnly,
                                                             String eventSeverities)
                                                      throws ApiException

Removes user from events matching provided filters, if the events users to notify is empty the event is deleted

Parameters:

sessionid - (required)

readStatus - (optional)

eventGroups - (optional)

eventTypes - (optional)

bucketName - (optional)

projectName - (optional)

workflowName - (optional)

myJobsOnly - (optional)

eventSeverities - (optional)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

removeUserFromEvents

public void removeUserFromEvents(String sessionid,
                                 List<Long> ids)
                          throws ApiException

Removes user from events, if the events users to notify is empty the event is deleted

Parameters:

sessionid - (required)

ids - (optional)

Throws:

ApiException - if fails to make API call

removeUserFromEventsWithHttpInfo

public ApiResponse<Void> removeUserFromEventsWithHttpInfo(String sessionid,
                                                          List<Long> ids)
                                                   throws ApiException

Removes user from events, if the events users to notify is empty the event is deleted

Parameters:

sessionid - (required)

ids - (optional)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call