Package org.openmetadata.service.resources.events.subscription

Class EventSubscriptionResource

java.lang.Object

org.openmetadata.service.resources.EntityResource<EventSubscription,EventSubscriptionRepository>

org.openmetadata.service.resources.events.subscription.EventSubscriptionResource

@Path("/v1/events/subscriptions")
@Produces("application/json")
@Consumes("application/json")
public class EventSubscriptionResource
extends EntityResource<EventSubscription,EventSubscriptionRepository>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EventSubscriptionResource.EventSubResourceDescriptorList
static class	EventSubscriptionResource.EventSubscriptionList

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COLLECTION_PATH
static final String	FIELDS

Fields inherited from class org.openmetadata.service.resources.EntityResource

allowedFields, authorizer, entityClass, entityType, fieldsToViewOperations, repository, VIEW_ALL_OPERATIONS, VIEW_BASIC_OPERATIONS

Constructor Summary

Constructors

Constructor	Description
EventSubscriptionResource(Authorizer authorizer)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	checkIfThePublisherProcessedALlEvents(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
javax.ws.rs.core.Response	createEventSubscription(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateEventSubscription request)
javax.ws.rs.core.Response	createOrUpdateEventSubscription(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateEventSubscription create)
@Valid javax.ws.rs.core.Response	deleteEventSubscription(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
javax.ws.rs.core.Response	deleteEventSubscriptionByName(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String name)
static <T> List<T>	getDescriptorsFromFile(String fileName, Class<T> classType)
protected List<MetadataOperation>	getEntitySpecificOperations()
@Valid EventSubscription	getEventsSubscriptionById(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String fieldsParam)
EventSubscription	getEventsSubscriptionByName(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String name, String fieldsParam)
@Valid SubscriptionStatus	getEventSubscriptionStatusById(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, UUID destinationId)
@Valid SubscriptionStatus	getEventSubscriptionStatusByName(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String name, UUID destinationId)
EventSubscription	getEventSubscriptionVersion(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String version)
static List<FilterResourceDescriptor>	getNotificationsFilterDescriptors()
static List<FilterResourceDescriptor>	getObservabilityFilterDescriptors()
void	initialize(OpenMetadataApplicationConfig config)	Method used for initializing a resource, such as creating default policies, roles, etc.
ResultList<FilterResourceDescriptor>	listEventSubResources(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, CreateEventSubscription.AlertType alertType)
ResultList<EventSubscription>	listEventSubscriptions(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(1000000L) int limitParam, String alertType, String before, String after)
EntityHistory	listEventSubscriptionVersions(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
javax.ws.rs.core.Response	patchEventSubscription(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, javax.json.JsonPatch patch)
void	validateCondition(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String expression)

Methods inherited from class org.openmetadata.service.resources.EntityResource

addHref, addHref, addViewOperation, create, createOrUpdate, delete, deleteByName, exportCsvInternal, getByNameInternal, getByNameInternal, getEntityReference, getEntityReferences, getFields, getInternal, getInternal, getResourceContext, getResourceContextById, getResourceContextByName, getVersionInternal, getVersionInternal, importCsvInternal, listInternal, listInternal, listVersionsInternal, listVersionsInternal, patchInternal, restoreEntity, upgrade

Methods inherited from class java.lang.Object

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

Field Details

COLLECTION_PATH

public static final String COLLECTION_PATH

See Also:

• Constant Field Values

FIELDS

public static final String FIELDS

See Also:

• Constant Field Values

Constructor Details

EventSubscriptionResource

public EventSubscriptionResource(Authorizer authorizer)

Method Details

getEntitySpecificOperations

protected List<MetadataOperation> getEntitySpecificOperations()

Overrides:

getEntitySpecificOperations in class EntityResource<EventSubscription,EventSubscriptionRepository>

initialize

public void initialize(OpenMetadataApplicationConfig config)

Description copied from class: EntityResource

Method used for initializing a resource, such as creating default policies, roles, etc.

Overrides:

initialize in class EntityResource<EventSubscription,EventSubscriptionRepository>

listEventSubscriptions

@GET
public ResultList<EventSubscription> listEventSubscriptions(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("fields")
 String fieldsParam,
 @DefaultValue("10") @Min(0L) @Max(1000000L) @QueryParam("limit")
 @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(1000000L) int limitParam,
 @QueryParam("alertType")
 String alertType,
 @QueryParam("before")
 String before,
 @QueryParam("after")
 String after)

getEventsSubscriptionById

@GET
@Path("/{id}")
@Valid
public @Valid EventSubscription getEventsSubscriptionById(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id,
 @QueryParam("fields")
 String fieldsParam)

getEventsSubscriptionByName

@GET
@Path("/name/{eventSubscriptionName}")
public EventSubscription getEventsSubscriptionByName(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("eventSubscriptionName")
 String name,
 @QueryParam("fields")
 String fieldsParam)

createEventSubscription

@POST
public javax.ws.rs.core.Response createEventSubscription(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @Valid
 @Valid CreateEventSubscription request)
                                                  throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

createOrUpdateEventSubscription

@PUT
public javax.ws.rs.core.Response createOrUpdateEventSubscription(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @Valid
 @Valid CreateEventSubscription create)

patchEventSubscription

@PATCH
@Path("/{id}")
@Consumes("application/json-patch+json")
public javax.ws.rs.core.Response patchEventSubscription(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id,
 javax.json.JsonPatch patch)

listEventSubscriptionVersions

@GET
@Path("/{id}/versions")
public EntityHistory listEventSubscriptionVersions(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id)

checkIfThePublisherProcessedALlEvents

@GET
@Path("/{id}/processedEvents")
public javax.ws.rs.core.Response checkIfThePublisherProcessedALlEvents(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id)

getEventSubscriptionVersion

@GET
@Path("/{id}/versions/{version}")
public EventSubscription getEventSubscriptionVersion(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id,
 @PathParam("version")
 String version)

deleteEventSubscription

@DELETE
@Path("/{id}")
@Valid
public @Valid javax.ws.rs.core.Response deleteEventSubscription(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id)
                                                         throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

deleteEventSubscriptionByName

@DELETE
@Path("/name/{name}")
public javax.ws.rs.core.Response deleteEventSubscriptionByName(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("name")
 String name)
                                                        throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

getEventSubscriptionStatusByName

@GET
@Path("/name/{eventSubscriptionName}/status/{destinationId}")
@Valid
public @Valid SubscriptionStatus getEventSubscriptionStatusByName(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("eventSubscriptionName")
 String name,
 @PathParam("destinationId")
 UUID destinationId)

getEventSubscriptionStatusById

@GET
@Path("/{eventSubscriptionId}/status/{destinationId}")
@Valid
public @Valid SubscriptionStatus getEventSubscriptionStatusById(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("eventSubscriptionId")
 UUID id,
 @PathParam("destinationId")
 UUID destinationId)

listEventSubResources

@GET
@Path("/{alertType}/resources")
public ResultList<FilterResourceDescriptor> listEventSubResources(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("alertType")
 CreateEventSubscription.AlertType alertType)

validateCondition

@GET
@Path("/validation/condition/{expression}")
public void validateCondition(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("expression")
 String expression)

getNotificationsFilterDescriptors

public static List<FilterResourceDescriptor> getNotificationsFilterDescriptors()
                                                                        throws IOException

Throws:

IOException

getObservabilityFilterDescriptors

public static List<FilterResourceDescriptor> getObservabilityFilterDescriptors()
                                                                        throws IOException

Throws:

IOException

getDescriptorsFromFile

public static <T> List<T> getDescriptorsFromFile(String fileName,
 Class<T> classType)
                                          throws IOException

Throws:

IOException