forked from odpi/egeria-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of https://github.com/odpi/egeria-docs into dojod…
…ay1a
- Loading branch information
Showing
213 changed files
with
7,618 additions
and
5,331 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| <mxfile host="Electron" modified="2021-12-16T17:36:28.059Z" agent="5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/15.2.7 Chrome/93.0.4577.63 Electron/14.0.1 Safari/537.36" etag="9LF8MhJr-hcVrP3d5KQ9" version="15.2.7" type="device"><diagram id="GG5_nNqYO6-7ISTeHCT9" name="type-hierarchy">7Vpdc5s4FP01fkwGEGD8aDtJO9NtN9t0ZtOnHRnJRg1GVMiJ3V+/VyC+nZjUJkySeiYZ6UoI6Zx7j66AEZqvtx8EjoPPnNBwZBlkO0IXI8uaIAv+K8MuM5g2sjPLSjCibaXhhv2i2mho64YRmtQ6Ss5DyeK60edRRH1Zs2Eh+EO925KH9bvGeEVbhhsfh23rv4zIQFtNd1I2fKRsFehbe9Y4a1jjvLNeSRJgwh8qJnQ5QnPBucxK6+2chgq8HJfsuqtHWouJCRrJLhds8OYfI/5wn4x3t+EXZE+vbv87MzU/9zjc6BWP5tZoOoNBmdyp8mw2stwQbjFbCCitVKmw5IZvPGZ+boU5LMqe6drlLgc0kOsQSia0JVLwOzrnIRdpG3J9jy6W0IJDtorA5sM0KDTOliwMKx0Jpt7SB/tKYMKgU6VtTLFLjeLW91RIun0UM7NgAlyY8jWVYgdd9AWuocnT7mshXX8ofcGytS2ouIGjbVi736oYumQICpqk5xCGWoRJhf23XUzBPELTFG7BolULesE3EaFqdAXPQ8AkvYmxr1ofIHrB9hQ5Rvrbj/ky/VWIC+lS9kSB15EC1BcFltdClhIQDV3lQgZ8xSMcXpbWWR37ss9fnMca8R9Uyp1WQLyRvM4HwCV2t+r6cyevfq+2XWz14FltV9TIVOkgVBch9+8y0xVTa8476JuaXkGZWtDThMH6+Ub49CmgtEZKLFZUHnTqtgsIGmLJ7uszOT2fk9No4Ce8vMPvRAiRO7QQ5uFdYQ2WA4QxHiWFEjJYXos5QeOQ+bjR6y2KpW0OTZNttpB9CbHcMlnRSqh9z9UOyqVSqkoplP0L7Pi0AmtbHQXWsYcU2HyaxwrsV7qkAJJP8QLc5FiNJe7CddwOGgvBavmPaOxySSau20/wnpkuGjp629nmzw3gtWSUfMHrdsbZ5BATkioyDq8FjwEdRkvZXYOMWi5eKzFNr8tHmVdHzNrrHtHyEcLua8y7PzfqXDUDNuSZJljdMpXaorU5CmCUDvSIN72JLeHMNDt6FZr05VX2MAn0cDrtdNRpe9BEOJ/msTo9TRIq34E+I+N87Ayt0G6Ls6iLMBOa+ILFSpsP9v0jss91DXNybnX0DLsvz8hd7jVk3s9T5t/N1E+o6E7+LPqgortHKrq+9Jqnh9Tc4Rxvcu7UXA4Mk8rPa2ze2UT1KA3PKqZ1hLOZp9k6LrDEN+9h8zANe+Cdw9lzKhtQjAuC+gDb6Qg26iu1ctoHqd+Kj79jGn2mEhOIk6/q1dGbD5QzyxsPHSn2nkj5kyQdzyzqyGxvr3Kc8SA50ut7lZO/Jz78pNHqJd8Zo7rvoEkjv8lW0Mpv9g3USJxQ/kXCS6VK3uF9t8J0xCPldAQnQepzZt2XlP0aS5DsKLVYBipCPv9gwXqGL7SZqwSn84TqHpvQNl8wNc9FXQn2vAMD9U3vnreJTXqTAMeq6G9EuJsJ7N+pmDqk46XumKcRZMftstXu4dw1xj0Jcj6jV4geyiPhAHim1ddu5rYPYbWn7msMPg9/gIKaQzODkQFgtAqUTGwlTcECPCoD6Efx0SKJ9yUlKsOpY97KKRXgzMfhVDesGSHZnkoT9it9rZPtZLEKzxQfZzZyLtRYsI0menNrJTVaJKspqzadgGg0ae497Uc75vgl0xa3fXSrEZ1s4hjykpRAwgT1Zbh7im8Z0AbVBl/8UJ/TvVeOzfP+OIZq+dVftu2U306iy/8B</diagram></mxfile> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| <!-- SPDX-License-Identifier: CC-BY-4.0 --> | ||
| <!-- Copyright Contributors to the ODPi Egeria project 2020. --> | ||
|
|
||
| # Extended Properties | ||
|
|
||
| Extended properties provide a means to maintain the properties of elements that are [subtypes of the types](/egeria-docs/concepts/open-metadata-type-definitions) supported directly on an API. | ||
|
|
||
| For example, the [Data Manager OMAS](/egeria-docs/services/omas/data-manager/overview) has support for maintaining metadata about *Topics*. Topics are special types of [*assets*](/egeria-docs/concepts/asset) that provide a destination for exchanging events. | ||
|
|
||
| Model [0223 Events and Logs](/egeria-docs/types/2/0223-Events-and-Logs) extends the `Topic` type with a new type called `KafkaTopic` that introduces two new properties: `partitions` and `replicas`. `KafkaTopic` is used to represent a topic that is owned and managed by [*Apache Kafka*](https://kafka.apache.org/). The full type hierarchy for `KafkaTopic` is shown in Figure 1. | ||
|
|
||
|  | ||
| **Figure 1:** The type inheritance hierarchy for KafkaTopic. This shows all of the properties that are valid for an element of type `KafkaTopic`. Properties `qualifiedName` and `additionalProperties` are inherited from `Referenceable`; properties `name` and `description` are inherited from `Asset`; finally `topicType` is inherited from `Topic`. All of these properties are supported natively by the Data Manager OMAS. The `partitions` and `replicas` properties introduced by the `KafkaTopic` type are maintainable through `extendedProperties`. | ||
|
|
||
| The code snippet below shows a call to the Data Manager OMAS to create an element of type `KafkaTopic`. | ||
| The standard properties for a topic are set up first. Then the name of the subtype for the new element (null means `Topic`). Then any extended properties for the requested subtype are set up. | ||
| Finally any additional properties that the organization wants to store that are not defined in the type definitions go in `additionalProperties`. | ||
| ``` | ||
| TopicProperties topicProperties = new TopicProperties(); | ||
| /* | ||
| * Set up the standard properties - note displayName maps to the name property. | ||
| */ | ||
| topicProperties.setQualifiedName("Topic:myTopicName"); | ||
| topicProperties.setDisplayName("myTopicName"); | ||
| topicProperties.setDescription("Testing that topics can be catalogued"); | ||
| topicProperties.setTopicType("PLAINTEXT"); | ||
| /* | ||
| * Set up the specific type name for the new element. It must be a null | ||
| * (for a type of Topic) or a type name that is a subtype of Topic. | ||
| */ | ||
| topicProperties.setTypeName("KafkaTopic"); | ||
| /* | ||
| * Set up the properties that come from the subtypes of Topic. | ||
| */ | ||
| Map<String, Object> extendedProperties = new HashMap<>(); | ||
| extendedProperties.put("partitions", 1); | ||
| extendedProperties.put("replicas", 5) | ||
| topicProperties.setExtendedProperties(extendedProperties); | ||
| /* | ||
| * Set up additional properties. These do not need to be defined in any of the | ||
| * type definitions. | ||
| */ | ||
| Map<String, String> additionalProperties = new HashMap<>(); | ||
| additionalProperties.put("autoDefined", "true"); | ||
| additionalProperties.put("jsonPayload", "true"); | ||
| topicProperties.setAdditionalProperties(additionalProperties); | ||
| String topicGUID = dataManagerClient.createTopic(userId, | ||
| eventBrokerGUID | ||
| eventBrokerName, | ||
| eventBrokerIsHome, | ||
| topicProperties); | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
| --8<-- "snippets/abbr.md" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.