@RestController
@RequestMapping(value="/servers/{serverName}/open-metadata/access-services/data-manager/users/{userId}")
public class EventBrokerResource
extends Object
| Constructor and Description |
|---|
EventBrokerResource()
Default constructor
|
| Modifier and Type | Method and Description |
|---|---|
GUIDResponse |
createEventType(String serverName,
String userId,
String eventBrokerGUID,
String eventBrokerName,
String topicGUID,
EventTypeProperties eventTypeProperties)
Create a new metadata element to represent a event type.
|
GUIDResponse |
createEventTypeFromTemplate(String serverName,
String userId,
String eventBrokerGUID,
String eventBrokerName,
String templateGUID,
String topicGUID,
TemplateProperties templateProperties)
Create a new metadata element to represent a event type using an existing metadata element as a template.
|
GUIDResponse |
createTopic(String serverName,
String userId,
String eventBrokerGUID,
String eventBrokerName,
TopicProperties topicProperties)
Create a new metadata element to represent a topic.
|
GUIDResponse |
createTopicFromTemplate(String serverName,
String userId,
String eventBrokerGUID,
String eventBrokerName,
String templateGUID,
TemplateProperties templateProperties)
Create a new metadata element to represent a topic using an existing metadata element as a template.
|
EventTypesResponse |
findEventTypes(String serverName,
String userId,
String searchString,
int startFrom,
int pageSize)
Retrieve the list of event type metadata elements that contain the search string.
|
TopicsResponse |
findTopics(String serverName,
String userId,
String searchString,
int startFrom,
int pageSize)
Retrieve the list of topic metadata elements that contain the search string.
|
EventTypeResponse |
getEventTypeByGUID(String serverName,
String userId,
String guid)
Retrieve the event type metadata element with the supplied unique identifier.
|
EventTypesResponse |
getEventTypesByName(String serverName,
String userId,
String name,
int startFrom,
int pageSize)
Retrieve the list of event type metadata elements with a matching qualified or display name.
|
EventTypesResponse |
getEventTypesForEventSet(String serverName,
String userId,
String eventSetGUID,
int startFrom,
int pageSize)
Return the list of event types associated with a EventSet.
|
EventTypesResponse |
getEventTypesForTopic(String serverName,
String userId,
String topicGUID,
int startFrom,
int pageSize)
Return the list of schemas associated with a topic.
|
TopicResponse |
getTopicByGUID(String serverName,
String userId,
String guid)
Retrieve the topic metadata element with the supplied unique identifier.
|
TopicsResponse |
getTopicsByName(String serverName,
String userId,
String name,
int startFrom,
int pageSize)
Retrieve the list of topic metadata elements with a matching qualified or display name.
|
TopicsResponse |
getTopicsForEventBroker(String serverName,
String userId,
String eventBrokerGUID,
String eventBrokerName,
int startFrom,
int pageSize)
Retrieve the list of topics created by this topic manager.
|
VoidResponse |
publishTopic(String serverName,
String userId,
String topicGUID,
NullRequestBody nullRequestBody)
Update the zones for the topic asset so that it becomes visible to consumers.
|
VoidResponse |
removeEventType(String serverName,
String userId,
String eventBrokerGUID,
String eventBrokerName,
String eventTypeGUID,
String qualifiedName,
NullRequestBody nullRequestBody)
Remove the metadata element representing a event type.
|
VoidResponse |
removeTopic(String serverName,
String userId,
String eventBrokerGUID,
String eventBrokerName,
String topicGUID,
String qualifiedName,
NullRequestBody nullRequestBody)
Remove the metadata element representing a topic.
|
VoidResponse |
updateEventType(String serverName,
String userId,
String eventBrokerGUID,
String eventBrokerName,
String eventTypeGUID,
boolean isMergeUpdate,
EventTypeProperties eventTypeProperties)
Update the metadata element representing a event type.
|
VoidResponse |
updateTopic(String serverName,
String userId,
String eventBrokerGUID,
String eventBrokerName,
String topicGUID,
boolean isMergeUpdate,
TopicProperties topicProperties)
Update the metadata element representing a topic.
|
VoidResponse |
withdrawTopic(String serverName,
String userId,
String topicGUID,
NullRequestBody nullRequestBody)
Update the zones for the topic asset so that it is no longer visible to consumers.
|
@PostMapping(path="/event-brokers/{eventBrokerGUID}/{eventBrokerName}/topics")
public GUIDResponse createTopic(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String eventBrokerGUID,
@PathVariable
String eventBrokerName,
@RequestBody
TopicProperties topicProperties)
serverName - name of the service to route the request to.userId - calling usereventBrokerGUID - unique identifier of software server capability representing the owning event brokereventBrokerName - unique name of software server capability representing the owning event brokertopicProperties - properties to store@PostMapping(path="/event-brokers/{eventBrokerGUID}/{eventBrokerName}/topics/from-template/{templateGUID}")
public GUIDResponse createTopicFromTemplate(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String eventBrokerGUID,
@PathVariable
String eventBrokerName,
@PathVariable
String templateGUID,
@RequestBody
TemplateProperties templateProperties)
serverName - name of the service to route the request to.userId - calling usereventBrokerGUID - unique identifier of software server capability representing the owning event brokereventBrokerName - unique name of software server capability representing the owning event brokertemplateGUID - unique identifier of the metadata element to copytemplateProperties - properties that override the template@PostMapping(path="/event-brokers/{eventBrokerGUID}/{eventBrokerName}/topics/{topicGUID}")
public VoidResponse updateTopic(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String eventBrokerGUID,
@PathVariable
String eventBrokerName,
@PathVariable
String topicGUID,
@RequestParam
boolean isMergeUpdate,
@RequestBody
TopicProperties topicProperties)
serverName - name of the service to route the request to.userId - calling usereventBrokerGUID - unique identifier of software server capability representing the owning event brokereventBrokerName - unique name of software server capability representing the owning event brokertopicGUID - unique identifier of the metadata element to updateisMergeUpdate - are unspecified properties unchanged (true) or removed?topicProperties - new properties for this element@PostMapping(path="/topics/{topicGUID}/publish")
public VoidResponse publishTopic(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String topicGUID,
@RequestBody(required=false)
NullRequestBody nullRequestBody)
serverName - name of the service to route the request to.userId - calling usertopicGUID - unique identifier of the metadata element to publishnullRequestBody - empty request body@PostMapping(path="/topics/{topicGUID}/withdraw")
public VoidResponse withdrawTopic(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String topicGUID,
@RequestBody(required=false)
NullRequestBody nullRequestBody)
serverName - name of the service to route the request to.userId - calling usertopicGUID - unique identifier of the metadata element to withdrawnullRequestBody - empty request body@PostMapping(path="/event-brokers/{eventBrokerGUID}/{eventBrokerName}/topics/{topicGUID}/{qualifiedName}/delete")
public VoidResponse removeTopic(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String eventBrokerGUID,
@PathVariable
String eventBrokerName,
@PathVariable
String topicGUID,
@PathVariable
String qualifiedName,
@RequestBody(required=false)
NullRequestBody nullRequestBody)
serverName - name of the service to route the request to.userId - calling usereventBrokerGUID - unique identifier of software server capability representing the owning event brokereventBrokerName - unique name of software server capability representing the owning event brokertopicGUID - unique identifier of the metadata element to removequalifiedName - unique name of the metadata element to removenullRequestBody - empty request body@GetMapping(path="/topics/by-search-string/{searchString}")
public TopicsResponse findTopics(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String searchString,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of the service to route the request to.userId - calling usersearchString - string to find in the propertiesstartFrom - paging start pointpageSize - maximum results that can be returned@GetMapping(path="/topics/by-name/{name}")
public TopicsResponse getTopicsByName(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String name,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of the service to route the request to.userId - calling username - name to search forstartFrom - paging start pointpageSize - maximum results that can be returned@GetMapping(path="/event-brokers/{eventBrokerGUID}/{eventBrokerName}/topics")
public TopicsResponse getTopicsForEventBroker(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String eventBrokerGUID,
@PathVariable
String eventBrokerName,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of the service to route the request to.userId - calling usereventBrokerGUID - unique identifier of software server capability representing the owning event brokereventBrokerName - unique name of software server capability representing the owning event brokerstartFrom - paging start pointpageSize - maximum results that can be returned@GetMapping(path="/topics/{guid}")
public TopicResponse getTopicByGUID(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid)
serverName - name of the service to route the request to.userId - calling userguid - unique identifier of the requested metadata element@PostMapping(path="/event-brokers/{eventBrokerGUID}/{eventBrokerName}/topics/{topicGUID}/event-types")
public GUIDResponse createEventType(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String eventBrokerGUID,
@PathVariable
String eventBrokerName,
@PathVariable
String topicGUID,
@RequestBody
EventTypeProperties eventTypeProperties)
serverName - name of the service to route the request to.userId - calling usereventBrokerGUID - unique identifier of software server capability representing the owning event brokereventBrokerName - unique name of software server capability representing the owning event brokertopicGUID - unique identifier of the topic where the event type is locatedeventTypeProperties - properties about the event type@PostMapping(path="/event-brokers/{eventBrokerGUID}/{eventBrokerName}/topics/{topicGUID}/event-types/from-template/{templateGUID}")
public GUIDResponse createEventTypeFromTemplate(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String eventBrokerGUID,
@PathVariable
String eventBrokerName,
@PathVariable
String templateGUID,
@PathVariable
String topicGUID,
@RequestBody
TemplateProperties templateProperties)
serverName - name of the service to route the request to.userId - calling usereventBrokerGUID - unique identifier of software server capability representing the owning event brokereventBrokerName - unique name of software server capability representing the owning event brokertemplateGUID - unique identifier of the metadata element to copytopicGUID - unique identifier of the topic where the event type is locatedtemplateProperties - properties that override the template@PostMapping(path="/event-brokers/{eventBrokerGUID}/{eventBrokerName}/topics/event-types/{eventTypeGUID}")
public VoidResponse updateEventType(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String eventBrokerGUID,
@PathVariable
String eventBrokerName,
@PathVariable
String eventTypeGUID,
@RequestParam
boolean isMergeUpdate,
@RequestBody
EventTypeProperties eventTypeProperties)
serverName - name of the service to route the request to.userId - calling usereventBrokerGUID - unique identifier of software server capability representing the owning event brokereventBrokerName - unique name of software server capability representing the owning event brokereventTypeGUID - unique identifier of the metadata element to updateisMergeUpdate - are unspecified properties unchanged (true) or removed?eventTypeProperties - new properties for the metadata element@PostMapping(path="/event-brokers/{eventBrokerGUID}/{eventBrokerName}/topics/event-types/{eventTypeGUID}/{qualifiedName}/delete")
public VoidResponse removeEventType(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String eventBrokerGUID,
@PathVariable
String eventBrokerName,
@PathVariable
String eventTypeGUID,
@PathVariable
String qualifiedName,
@RequestBody(required=false)
NullRequestBody nullRequestBody)
serverName - name of the service to route the request to.userId - calling usereventBrokerGUID - unique identifier of software server capability representing the owning event brokereventBrokerName - unique name of software server capability representing the owning event brokereventTypeGUID - unique identifier of the metadata element to removequalifiedName - unique name of the metadata element to removenullRequestBody - empty request body@GetMapping(path="/topics/event-types/by-search-string/{searchString}")
public EventTypesResponse findEventTypes(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String searchString,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of the service to route the request to.userId - calling usersearchString - string to find in the propertiesstartFrom - paging start pointpageSize - maximum results that can be returned@GetMapping(path="/event-sets/{eventSetGUID}/event-types")
public EventTypesResponse getEventTypesForEventSet(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String eventSetGUID,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of the service to route the request to.userId - calling usereventSetGUID - unique identifier of the event set to querystartFrom - paging start pointpageSize - maximum results that can be returned@GetMapping(path="/topics/{topicGUID}/event-types")
public EventTypesResponse getEventTypesForTopic(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String topicGUID,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of the service to route the request to.userId - calling usertopicGUID - unique identifier of the topic to querystartFrom - paging start pointpageSize - maximum results that can be returned@GetMapping(path="/topics/event-types/by-name/{name}")
public EventTypesResponse getEventTypesByName(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String name,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of the service to route the request to.userId - calling username - name to search forstartFrom - paging start pointpageSize - maximum results that can be returned@GetMapping(path="/topics/event-types/{guid}")
public EventTypeResponse getEventTypeByGUID(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid)
serverName - name of the service to route the request to.userId - calling userguid - unique identifier of the requested metadata elementCopyright © 2018–2021 LF AI & Data Foundation. All rights reserved.