Package org.openmetadata.service.resources.databases

Class StoredProcedureResource

java.lang.Object

org.openmetadata.service.resources.EntityResource<StoredProcedure,StoredProcedureRepository>

org.openmetadata.service.resources.databases.StoredProcedureResource

@Path("/v1/storedProcedures")
@Produces("application/json")
@Consumes("application/json")
public class StoredProcedureResource
extends EntityResource<StoredProcedure,StoredProcedureRepository>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StoredProcedureResource.StoredProcedureList

Field Summary

Fields

Modifier and Type	Field	Description
static final 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
StoredProcedureResource(Authorizer authorizer)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	addFollower(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, UUID userId)
StoredProcedure	addHref(javax.ws.rs.core.UriInfo uriInfo, StoredProcedure storedProcedure)
javax.ws.rs.core.Response	create(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateStoredProcedure create)
javax.ws.rs.core.Response	createOrUpdate(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateStoredProcedure create)
javax.ws.rs.core.Response	delete(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean hardDelete, boolean recursive, String fqn)
javax.ws.rs.core.Response	delete(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean recursive, boolean hardDelete, UUID id)
javax.ws.rs.core.Response	deleteFollower(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String userId)
StoredProcedure	get(javax.ws.rs.core.UriInfo uriInfo, UUID id, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, Include include)
StoredProcedure	getByName(javax.ws.rs.core.UriInfo uriInfo, String fqn, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, Include include)
StoredProcedure	getVersion(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String version)
ResultList<StoredProcedure>	list(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, String databaseSchemaParam, @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)
javax.ws.rs.core.Response	patch(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, javax.json.JsonPatch patch)
javax.ws.rs.core.Response	restoreDatabaseSchema(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid RestoreEntity restore)
javax.ws.rs.core.Response	updateVote(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, @Valid VoteRequest request)

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

addHref, addViewOperation, create, createOrUpdate, delete, deleteByName, exportCsvInternal, getByNameInternal, getByNameInternal, getEntityReference, getEntityReferences, getEntitySpecificOperations, getFields, getInternal, getInternal, getResourceContext, getResourceContextById, getResourceContextByName, getVersionInternal, getVersionInternal, importCsvInternal, initialize, 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

Constructor Details

StoredProcedureResource

public StoredProcedureResource(Authorizer authorizer)

Method Details

addHref

public StoredProcedure addHref(javax.ws.rs.core.UriInfo uriInfo,
 StoredProcedure storedProcedure)

Overrides:

addHref in class EntityResource<StoredProcedure,StoredProcedureRepository>

list

@GET
public ResultList<StoredProcedure> list(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("fields")
 String fieldsParam,
 @QueryParam("databaseSchema")
 String databaseSchemaParam,
 @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)

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)

get

@GET
@Path("/{id}")
public StoredProcedure 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)

getByName

@GET
@Path("/name/{fqn}")
public StoredProcedure 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)

getVersion

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

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 CreateStoredProcedure create)

patch

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

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 CreateStoredProcedure create)

addFollower

@PUT
@Path("/{id}/followers")
public javax.ws.rs.core.Response addFollower(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id,
 UUID userId)

deleteFollower

@DELETE
@Path("/{id}/followers/{userId}")
public javax.ws.rs.core.Response deleteFollower(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id,
 @PathParam("userId")
 String userId)

updateVote

@PUT
@Path("/{id}/vote")
public javax.ws.rs.core.Response updateVote(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id,
 @Valid
 @Valid VoteRequest request)

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,
 @DefaultValue("false") @QueryParam("recursive")
 boolean recursive,
 @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,
 @QueryParam("recursive") @DefaultValue("false")
 boolean recursive,
 @PathParam("fqn")
 String fqn)

restoreDatabaseSchema

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