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 String	COLLECTION_PATH
static 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(CollectionDAO dao, Authorizer authorizer)

Method Summary

Modifier and Type	Method	Description
EventSubscription	addHref(javax.ws.rs.core.UriInfo uriInfo, EventSubscription entity)
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 List<SubscriptionResourceDescriptor>	getDescriptors()
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)
EventSubscription	getEventSubscription(CreateEventSubscription create, String user)
@Valid SubscriptionStatus	getEventSubscriptionStatusById(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
@Valid SubscriptionStatus	getEventSubscriptionStatusByName(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String name)
EventSubscription	getEventSubscriptionVersion(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String version)
void	initialize(OpenMetadataApplicationConfig config)	Method used for initializing a resource, such as creating default policies, roles, etc.
ResultList<SubscriptionResourceDescriptor>	listEventSubResources(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext)
List<Function>	listEventSubscriptionFunctions(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext)
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 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)
javax.ws.rs.core.Response	triggerDataInsightJob(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
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, addViewOperation, copy, 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 Detail

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 Detail

EventSubscriptionResource

public EventSubscriptionResource(CollectionDAO dao,
                                 Authorizer authorizer)

Method Detail

addHref

public EventSubscription addHref(javax.ws.rs.core.UriInfo uriInfo,
                                 EventSubscription entity)

Specified by:

addHref in class EntityResource<EventSubscription,EventSubscriptionRepository>

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("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)

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)

triggerDataInsightJob

@PUT
@Path("/trigger/{id}")
public javax.ws.rs.core.Response triggerDataInsightJob(@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

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)

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 InterruptedException,
                                                                org.quartz.SchedulerException

Throws:

InterruptedException

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 InterruptedException,
                                                               org.quartz.SchedulerException

Throws:

InterruptedException

org.quartz.SchedulerException

getEventSubscriptionStatusByName

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

getEventSubscriptionStatusById

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

listEventSubscriptionFunctions

@GET
@Path("/functions")
public List<Function> listEventSubscriptionFunctions(@Context
                                                     javax.ws.rs.core.UriInfo uriInfo,
                                                     @Context
                                                     javax.ws.rs.core.SecurityContext securityContext)

listEventSubResources

@GET
@Path("/resources")
public ResultList<SubscriptionResourceDescriptor> listEventSubResources(@Context
                                                                        javax.ws.rs.core.UriInfo uriInfo,
                                                                        @Context
                                                                        javax.ws.rs.core.SecurityContext securityContext)

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)

getEventSubscription

public EventSubscription getEventSubscription(CreateEventSubscription create,
                                              String user)

getDescriptors

public static List<SubscriptionResourceDescriptor> getDescriptors()
                                                           throws IOException

Throws:

IOException