Package org.openmetadata.service.resources.services.storage

Class StorageServiceResource

java.lang.Object

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

org.openmetadata.service.resources.services.ServiceEntityResource<StorageService,StorageServiceRepository,StorageConnection>

org.openmetadata.service.resources.services.storage.StorageServiceResource

@Path("/v1/services/storageServices")
@Produces("application/json")
@Consumes("application/json")
public class StorageServiceResource
extends ServiceEntityResource<StorageService,StorageServiceRepository,StorageConnection>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StorageServiceResource.StorageServiceList

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

Method Summary

Modifier and Type	Method	Description
StorageService	addHref(javax.ws.rs.core.UriInfo uriInfo, StorageService service)
StorageService	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 CreateStorageService create)
javax.ws.rs.core.Response	createOrUpdate(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateStorageService 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 fqn)
protected String	extractServiceType(StorageService service)
StorageService	get(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String fieldsParam, Include include)
StorageService	getByName(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String name, String fieldsParam, Include include)
protected List<MetadataOperation>	getEntitySpecificOperations()
StorageService	getVersion(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String version)
ResultList<StorageService>	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)
protected StorageService	nullifyConnection(StorageService 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	restoreStorageService(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, 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

StorageServiceResource

public StorageServiceResource(CollectionDAO dao,
                              Authorizer authorizer)

Method Detail

addHref

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

Specified by:

addHref in class EntityResource<StorageService,StorageServiceRepository>

getEntitySpecificOperations

protected List<MetadataOperation> getEntitySpecificOperations()

Overrides:

getEntitySpecificOperations in class EntityResource<StorageService,StorageServiceRepository>

list

@GET
public ResultList<StorageService> list(@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,
                                       @QueryParam("include") @DefaultValue("non-deleted")
                                       Include include)

get

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

restoreStorageService

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

nullifyConnection

protected StorageService nullifyConnection(StorageService service)

Specified by:

nullifyConnection in class ServiceEntityResource<StorageService,StorageServiceRepository,StorageConnection>

extractServiceType

protected String extractServiceType(StorageService service)

Specified by:

extractServiceType in class ServiceEntityResource<StorageService,StorageServiceRepository,StorageConnection>