Package org.openmetadata.service.resources.analytics

Class WebAnalyticEventResource

java.lang.Object

org.openmetadata.service.resources.EntityResource<WebAnalyticEvent,WebAnalyticEventRepository>

org.openmetadata.service.resources.analytics.WebAnalyticEventResource

@Path("/v1/analytics/web/events")
@Produces("application/json")
@Consumes("application/json")
public class WebAnalyticEventResource
extends EntityResource<WebAnalyticEvent,WebAnalyticEventRepository>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebAnalyticEventResource.WebAnalyticEventDataList
static class	WebAnalyticEventResource.WebAnalyticEventList

Field Summary

Fields

Modifier and Type	Field	Description
static String	COLLECTION_PATH

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
WebAnalyticEventResource(CollectionDAO dao, Authorizer authorizer)

Method Summary

Modifier and Type	Method	Description
WebAnalyticEvent	addHref(javax.ws.rs.core.UriInfo uriInfo, WebAnalyticEvent entity)
javax.ws.rs.core.Response	addReportResult(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid WebAnalyticEventData webAnalyticEventData)
javax.ws.rs.core.Response	create(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateWebAnalyticEvent create)
javax.ws.rs.core.Response	createOrUpdate(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateWebAnalyticEvent create)
javax.ws.rs.core.Response	delete(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean hardDelete, String fqn)
javax.ws.rs.core.Response	delete(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean hardDelete, UUID id)
javax.ws.rs.core.Response	deleteWebAnalyticEventData(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, WebAnalyticEventType name, Long timestamp)
WebAnalyticEvent	get(javax.ws.rs.core.UriInfo uriInfo, UUID id, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, Include include)
WebAnalyticEvent	getByName(javax.ws.rs.core.UriInfo uriInfo, String fqn, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, Include include)
WebAnalyticEvent	getVersion(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<WebAnalyticEvent>	list(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, Include include)
EntityHistory	listVersions(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
ResultList<WebAnalyticEventData>	listWebAnalyticEventData(javax.ws.rs.core.SecurityContext securityContext, @NonNull String eventType, @NonNull Long startTs, @NonNull Long endTs)
javax.ws.rs.core.Response	restoreWebAnalyticEvent(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid RestoreEntity restore)
javax.ws.rs.core.Response	updateDescription(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, javax.json.JsonPatch patch)

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

addHref, addViewOperation, copy, create, createOrUpdate, delete, deleteByName, exportCsvInternal, getByNameInternal, getByNameInternal, getEntityReference, getEntityReferences, getEntitySpecificOperations, 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

Constructor Detail

WebAnalyticEventResource

public WebAnalyticEventResource(CollectionDAO dao,
                                Authorizer authorizer)

Method Detail

addHref

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

Specified by:

addHref in class EntityResource<WebAnalyticEvent,WebAnalyticEventRepository>

initialize

public void initialize(OpenMetadataApplicationConfig config)
                throws IOException

Description copied from class: EntityResource

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

Overrides:

initialize in class EntityResource<WebAnalyticEvent,WebAnalyticEventRepository>

Throws:

IOException

list

@GET
public ResultList<WebAnalyticEvent> list(@Context
                                         javax.ws.rs.core.UriInfo uriInfo,
                                         @Context
                                         javax.ws.rs.core.SecurityContext securityContext,
                                         @QueryParam("fields")
                                         String fieldsParam,
                                         @DefaultValue("10") @QueryParam("limit") @Min(0L) @Max(1000000L)
                                         @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(1000000L) int limitParam,
                                         @QueryParam("before")
                                         String before,
                                         @QueryParam("after")
                                         String after,
                                         @QueryParam("include") @DefaultValue("non-deleted")
                                         Include include)

create

@POST
public javax.ws.rs.core.Response create(@Context
                                        javax.ws.rs.core.UriInfo uriInfo,
                                        @Context
                                        javax.ws.rs.core.SecurityContext securityContext,
                                        @Valid
                                        @Valid CreateWebAnalyticEvent create)

createOrUpdate

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

get

@GET
@Path("/{id}")
public WebAnalyticEvent get(@Context
                            javax.ws.rs.core.UriInfo uriInfo,
                            @PathParam("id")
                            UUID id,
                            @Context
                            javax.ws.rs.core.SecurityContext securityContext,
                            @QueryParam("fields")
                            String fieldsParam,
                            @QueryParam("include") @DefaultValue("non-deleted")
                            Include include)

updateDescription

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

delete

@DELETE
@Path("/{id}")
public javax.ws.rs.core.Response delete(@Context
                                        javax.ws.rs.core.UriInfo uriInfo,
                                        @Context
                                        javax.ws.rs.core.SecurityContext securityContext,
                                        @QueryParam("hardDelete") @DefaultValue("false")
                                        boolean hardDelete,
                                        @PathParam("id")
                                        UUID id)

delete

@DELETE
@Path("/name/{fqn}")
public javax.ws.rs.core.Response delete(@Context
                                        javax.ws.rs.core.UriInfo uriInfo,
                                        @Context
                                        javax.ws.rs.core.SecurityContext securityContext,
                                        @QueryParam("hardDelete") @DefaultValue("false")
                                        boolean hardDelete,
                                        @PathParam("fqn")
                                        String fqn)

restoreWebAnalyticEvent

@PUT
@Path("/restore")
public javax.ws.rs.core.Response restoreWebAnalyticEvent(@Context
                                                         javax.ws.rs.core.UriInfo uriInfo,
                                                         @Context
                                                         javax.ws.rs.core.SecurityContext securityContext,
                                                         @Valid
                                                         @Valid RestoreEntity restore)

getByName

@GET
@Path("/name/{fqn}")
public WebAnalyticEvent getByName(@Context
                                  javax.ws.rs.core.UriInfo uriInfo,
                                  @PathParam("fqn")
                                  String fqn,
                                  @Context
                                  javax.ws.rs.core.SecurityContext securityContext,
                                  @QueryParam("fields")
                                  String fieldsParam,
                                  @QueryParam("include") @DefaultValue("non-deleted")
                                  Include include)

listVersions

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

getVersion

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

addReportResult

@PUT
@Path("/collect")
public javax.ws.rs.core.Response addReportResult(@Context
                                                 javax.ws.rs.core.UriInfo uriInfo,
                                                 @Context
                                                 javax.ws.rs.core.SecurityContext securityContext,
                                                 @Valid
                                                 @Valid WebAnalyticEventData webAnalyticEventData)

deleteWebAnalyticEventData

@DELETE
@Path("/{name}/{timestamp}/collect")
public javax.ws.rs.core.Response deleteWebAnalyticEventData(@Context
                                                            javax.ws.rs.core.UriInfo uriInfo,
                                                            @Context
                                                            javax.ws.rs.core.SecurityContext securityContext,
                                                            @PathParam("name")
                                                            WebAnalyticEventType name,
                                                            @PathParam("timestamp")
                                                            Long timestamp)

listWebAnalyticEventData

@GET
@Path("/collect")
public ResultList<WebAnalyticEventData> listWebAnalyticEventData(@Context
                                                                 javax.ws.rs.core.SecurityContext securityContext,
                                                                 @NonNull @QueryParam("eventType")
                                                                 @NonNull String eventType,
                                                                 @NonNull @QueryParam("startTs")
                                                                 @NonNull Long startTs,
                                                                 @NonNull @QueryParam("endTs")
                                                                 @NonNull Long endTs)