Package org.openmetadata.service.resources.teams

Class TeamResource

java.lang.Object

org.openmetadata.service.resources.EntityResource<Team,TeamRepository>

org.openmetadata.service.resources.teams.TeamResource

@Path("/v1/teams")
@Produces("application/json")
@Consumes("application/json")
public class TeamResource
extends EntityResource<Team,TeamRepository>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TeamResource.TeamHierarchyList
static class	TeamResource.TeamList

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

Method Summary

Modifier and Type	Method	Description
Team	addHref(javax.ws.rs.core.UriInfo uriInfo, Team team)
javax.ws.rs.core.Response	create(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateTeam ct)
javax.ws.rs.core.Response	createOrUpdate(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateTeam ct)
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)
@Valid String	exportCsv(javax.ws.rs.core.SecurityContext securityContext, String name)
@Valid Team	get(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String fieldsParam, Include include)
@Valid Team	getByName(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String name, String fieldsParam, Include include)
@Valid String	getCsvDocumentation(javax.ws.rs.core.SecurityContext securityContext, String name)
protected List<MetadataOperation>	getEntitySpecificOperations()
Team	getVersion(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String version)
@Valid CsvImportResult	importCsv(javax.ws.rs.core.SecurityContext securityContext, String name, boolean dryRun, String csv)
void	initialize(OpenMetadataApplicationConfig config)	Method used for initializing a resource, such as creating default policies, roles, etc.
@Valid ResultList<Team>	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, String parentTeam, Boolean isJoinable, Include include)
@Valid ResultList<TeamHierarchy>	listHierarchy(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @javax.validation.constraints.Min(1000L),@javax.validation.constraints.Max(1000000L) int limitParam, Boolean isJoinable)
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	restoreTeam(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid RestoreEntity restore)

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

COLLECTION_PATH

public static final String COLLECTION_PATH

See Also:

Constant Field Values

Constructor Detail

TeamResource

public TeamResource(CollectionDAO dao,
                    Authorizer authorizer)

Method Detail

addHref

public Team addHref(javax.ws.rs.core.UriInfo uriInfo,
                    Team team)

Specified by:

addHref in class EntityResource<Team,TeamRepository>

getEntitySpecificOperations

protected List<MetadataOperation> getEntitySpecificOperations()

Overrides:

getEntitySpecificOperations in class EntityResource<Team,TeamRepository>

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<Team,TeamRepository>

Throws:

IOException

listHierarchy

@GET
@Path("/hierarchy")
@Valid
public @Valid ResultList<TeamHierarchy> listHierarchy(@Context
                                                      javax.ws.rs.core.UriInfo uriInfo,
                                                      @Context
                                                      javax.ws.rs.core.SecurityContext securityContext,
                                                      @DefaultValue("10000") @Min(1000L) @Max(1000000L) @QueryParam("limit")
                                                      @javax.validation.constraints.Min(1000L),@javax.validation.constraints.Max(1000000L) int limitParam,
                                                      @QueryParam("isJoinable")
                                                      Boolean isJoinable)

list

@GET
@Valid
public @Valid ResultList<Team> 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("parentTeam")
                                    String parentTeam,
                                    @QueryParam("isJoinable")
                                    Boolean isJoinable,
                                    @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
@Valid
@Path("/{id}")
public @Valid Team 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
@Valid
@Path("/name/{name}")
public @Valid Team 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)

getVersion

@GET
@Path("/{id}/versions/{version}")
public Team 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 CreateTeam ct)

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 CreateTeam ct)

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)

restoreTeam

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

getCsvDocumentation

@GET
@Path("/documentation/csv")
@Valid
public @Valid String getCsvDocumentation(@Context
                                         javax.ws.rs.core.SecurityContext securityContext,
                                         @PathParam("name")
                                         String name)

exportCsv

@GET
@Path("/name/{name}/export")
@Produces("text/plain")
@Valid
public @Valid String exportCsv(@Context
                               javax.ws.rs.core.SecurityContext securityContext,
                               @PathParam("name")
                               String name)
                        throws IOException

Throws:

IOException

importCsv

@PUT
@Path("/name/{name}/import")
@Consumes("text/plain")
@Valid
public @Valid CsvImportResult importCsv(@Context
                                        javax.ws.rs.core.SecurityContext securityContext,
                                        @PathParam("name")
                                        String name,
                                        @DefaultValue("true") @QueryParam("dryRun")
                                        boolean dryRun,
                                        String csv)
                                 throws IOException

Throws:

IOException