Package org.openmetadata.service.resources.services.metadata

Class MetadataServiceResource

java.lang.Object

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

org.openmetadata.service.resources.services.ServiceEntityResource<MetadataService,MetadataServiceRepository,MetadataConnection>

org.openmetadata.service.resources.services.metadata.MetadataServiceResource

@Path("/v1/services/metadataServices")
@Produces("application/json")
@Consumes("application/json")
public class MetadataServiceResource
extends ServiceEntityResource<MetadataService,MetadataServiceRepository,MetadataConnection>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetadataServiceResource.MetadataServiceList

Field Summary

Fields

Modifier and Type	Field	Description
static String	COLLECTION_PATH
static String	FIELDS
static String	OPENMETADATA_SERVICE

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

Method Summary

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

OPENMETADATA_SERVICE

public static final String OPENMETADATA_SERVICE

See Also:

Constant Field Values

COLLECTION_PATH

public static final String COLLECTION_PATH

See Also:

Constant Field Values

FIELDS

public static final String FIELDS

See Also:

Constant Field Values

Constructor Detail

MetadataServiceResource

public MetadataServiceResource(CollectionDAO dao,
                               Authorizer authorizer)

Method Detail

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<MetadataService,MetadataServiceRepository>

Throws:

IOException

addHref

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

Specified by:

addHref in class EntityResource<MetadataService,MetadataServiceRepository>

getEntitySpecificOperations

protected List<MetadataOperation> getEntitySpecificOperations()

Overrides:

getEntitySpecificOperations in class EntityResource<MetadataService,MetadataServiceRepository>

list

@GET
public ResultList<MetadataService> 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 MetadataService 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 MetadataService 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 MetadataService 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 MetadataService 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 CreateMetadataService 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 CreateMetadataService 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)

restoreTable

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

nullifyConnection

protected MetadataService nullifyConnection(MetadataService service)

Specified by:

nullifyConnection in class ServiceEntityResource<MetadataService,MetadataServiceRepository,MetadataConnection>

extractServiceType

protected String extractServiceType(MetadataService service)

Specified by:

extractServiceType in class ServiceEntityResource<MetadataService,MetadataServiceRepository,MetadataConnection>