Package org.openmetadata.service.resources.bots

Class BotResource

java.lang.Object

org.openmetadata.service.resources.EntityResource<Bot,BotRepository>

org.openmetadata.service.resources.bots.BotResource

@Path("/v1/bots")
@Produces("application/json")
@Consumes("application/json")
public class BotResource
extends EntityResource<Bot,BotRepository>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BotResource.BotList

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

Method Summary

Modifier and Type	Method	Description
Bot	addHref(javax.ws.rs.core.UriInfo uriInfo, Bot entity)
javax.ws.rs.core.Response	create(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateBot create)
javax.ws.rs.core.Response	createOrUpdate(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateBot create)
javax.ws.rs.core.Response	delete(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean hardDelete, String name)
javax.ws.rs.core.Response	delete(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean hardDelete, UUID id)
Bot	get(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, Include include, UUID id)
Bot	getByName(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String name, Include include)
Bot	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<Bot>	list(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @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)
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	restoreBot(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid RestoreEntity restore)
protected void	upgrade()	Method used for upgrading a resource such as adding new fields to entities, etc.

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, listInternal, listInternal, listVersionsInternal, listVersionsInternal, patchInternal, restoreEntity

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

BotResource

public BotResource(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<Bot,BotRepository>

Throws:

IOException

upgrade

protected void upgrade()

Description copied from class: EntityResource

Method used for upgrading a resource such as adding new fields to entities, etc. that can't be done in bootstrap migrate

Overrides:

upgrade in class EntityResource<Bot,BotRepository>

addHref

public Bot addHref(javax.ws.rs.core.UriInfo uriInfo,
                   Bot entity)

Specified by:

addHref in class EntityResource<Bot,BotRepository>

list

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

getByName

@GET
@Path("/name/{name}")
public Bot getByName(@Context
                     javax.ws.rs.core.UriInfo uriInfo,
                     @Context
                     javax.ws.rs.core.SecurityContext securityContext,
                     @PathParam("name")
                     String name,
                     @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)

getVersion

@GET
@Path("/{id}/versions/{version}")
public Bot 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 CreateBot 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 CreateBot create)

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,
                                        @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)

restoreBot

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