Package org.openmetadata.service.resources.system

Class SystemResource

java.lang.Object

org.openmetadata.service.resources.system.SystemResource

@Path("/v1/system")
@Produces("application/json")
@Consumes("application/json")
public class SystemResource
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SystemResource.SettingsList

Field Summary

Fields

Modifier and Type	Field	Description
static String	COLLECTION_PATH

Constructor Summary

Constructors

Constructor	Description
SystemResource(CollectionDAO dao, Authorizer authorizer)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	createOrUpdateSetting(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid Settings settingName)
Settings	getSettingByName(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String name)
void	initialize(OpenMetadataApplicationConfig config)
ResultList<Settings>	list(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext)
EntitiesCount	listEntitiesCount(javax.ws.rs.core.UriInfo uriInfo, Include include)
ServicesCount	listServicesCount(javax.ws.rs.core.UriInfo uriInfo, Include include)
javax.ws.rs.core.Response	patch(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String settingName, javax.json.JsonPatch patch)
javax.ws.rs.core.Response	restoreDefaultEmailSetting(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String name)

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

SystemResource

public SystemResource(CollectionDAO dao,
                      Authorizer authorizer)

Method Detail

initialize

public void initialize(OpenMetadataApplicationConfig config)

list

@GET
@Path("/settings")
public ResultList<Settings> list(@Context
                                 javax.ws.rs.core.UriInfo uriInfo,
                                 @Context
                                 javax.ws.rs.core.SecurityContext securityContext)

getSettingByName

@GET
@Path("/settings/{name}")
public Settings getSettingByName(@Context
                                 javax.ws.rs.core.UriInfo uriInfo,
                                 @Context
                                 javax.ws.rs.core.SecurityContext securityContext,
                                 @PathParam("name")
                                 String name)

createOrUpdateSetting

@PUT
@Path("/settings")
public javax.ws.rs.core.Response createOrUpdateSetting(@Context
                                                       javax.ws.rs.core.UriInfo uriInfo,
                                                       @Context
                                                       javax.ws.rs.core.SecurityContext securityContext,
                                                       @Valid
                                                       @Valid Settings settingName)

patch

@PATCH
@Path("/settings/{settingName}")
@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("settingName")
                                       String settingName,
                                       javax.json.JsonPatch patch)

restoreDefaultEmailSetting

@PUT
@Path("/restore/default/email")
public javax.ws.rs.core.Response restoreDefaultEmailSetting(@Context
                                                            javax.ws.rs.core.UriInfo uriInfo,
                                                            @Context
                                                            javax.ws.rs.core.SecurityContext securityContext,
                                                            @PathParam("settingName")
                                                            String name)

listEntitiesCount

@GET
@Path("/entities/count")
public EntitiesCount listEntitiesCount(@Context
                                       javax.ws.rs.core.UriInfo uriInfo,
                                       @QueryParam("include") @DefaultValue("non-deleted")
                                       Include include)

listServicesCount

@GET
@Path("/services/count")
public ServicesCount listServicesCount(@Context
                                       javax.ws.rs.core.UriInfo uriInfo,
                                       @QueryParam("include") @DefaultValue("non-deleted")
                                       Include include)