Package org.openmetadata.service.resources.services.dashboard

Class DashboardServiceResource

java.lang.Object

org.openmetadata.service.resources.EntityResource<T,R>

org.openmetadata.service.resources.services.ServiceEntityResource<DashboardService,DashboardServiceRepository,DashboardConnection>

org.openmetadata.service.resources.services.dashboard.DashboardServiceResource

@Path("/v1/services/dashboardServices")
@Produces("application/json")
@Consumes("application/json")
public class DashboardServiceResource
extends ServiceEntityResource<DashboardService,DashboardServiceRepository,DashboardConnection>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DashboardServiceResource.DashboardServiceList

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

Method Summary

Modifier and Type	Method	Description
DashboardService	addHref(javax.ws.rs.core.UriInfo uriInfo, DashboardService service)
DashboardService	addTestConnectionResult(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, @Valid TestConnectionResult testConnectionResult)
javax.ws.rs.core.Response	create(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateDashboardService create)
javax.ws.rs.core.Response	createOrUpdate(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateDashboardService update)
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	delete(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean hardDelete, String name)
protected String	extractServiceType(DashboardService service)
DashboardService	get(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String fieldsParam, Include include)
DashboardService	getByName(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String name, String fieldsParam, Include include)
DashboardService	getVersion(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String version)
ResultList<DashboardService>	list(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String name, 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)
protected DashboardService	nullifyConnection(DashboardService service)
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	restoreDashboardService(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid RestoreEntity restore)

Methods inherited from class org.openmetadata.service.resources.services.ServiceEntityResource

decryptOrNullify, decryptOrNullify, nullifyRequiredConnectionParameters, unmask

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, 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 Detail

COLLECTION_PATH

public static final String COLLECTION_PATH

See Also:

Constant Field Values

Constructor Detail

DashboardServiceResource

public DashboardServiceResource(CollectionDAO dao,
                                Authorizer authorizer)

Method Detail

addHref

public DashboardService addHref(javax.ws.rs.core.UriInfo uriInfo,
                                DashboardService service)

Specified by:

addHref in class EntityResource<DashboardService,DashboardServiceRepository>

list

@GET
public ResultList<DashboardService> list(@Context
                                         javax.ws.rs.core.UriInfo uriInfo,
                                         @Context
                                         javax.ws.rs.core.SecurityContext securityContext,
                                         @QueryParam("name")
                                         String name,
                                         @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,
                                         @QueryParam("include") @DefaultValue("non-deleted")
                                         Include include)

get

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

getByName

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

addTestConnectionResult

@PUT
@Path("/{id}/testConnectionResult")
public DashboardService addTestConnectionResult(@Context
                                                javax.ws.rs.core.UriInfo uriInfo,
                                                @Context
                                                javax.ws.rs.core.SecurityContext securityContext,
                                                @PathParam("id")
                                                UUID id,
                                                @Valid
                                                @Valid TestConnectionResult testConnectionResult)

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 DashboardService 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 CreateDashboardService 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 CreateDashboardService update)

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)

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/{name}")
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("name")
                                        String name)

restoreDashboardService

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

nullifyConnection

protected DashboardService nullifyConnection(DashboardService service)

Specified by:

nullifyConnection in class ServiceEntityResource<DashboardService,DashboardServiceRepository,DashboardConnection>

extractServiceType

protected String extractServiceType(DashboardService service)

Specified by:

extractServiceType in class ServiceEntityResource<DashboardService,DashboardServiceRepository,DashboardConnection>