java.lang.Object
- org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext

```
public class TopicIntegratorContext
extends Object
```
TopicIntegratorContext is the context for cataloging topics from an event broker server.

Constructor Summary

Constructors
Constructor	Description
`TopicIntegratorContext(EventBrokerClient eventBrokerClient, ConnectionManagerClient connectionManagerClient, DataManagerEventClient eventClient, String userId, String eventBrokerGUID, String eventBrokerName)`	Create a new client with no authentication embedded in the HTTP request.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`clearAssetConnection(String assetGUID, String connectionGUID)`	Remove a relationship between an asset and its connection.
`void`	`clearConnectorType(String connectionGUID, String connectorTypeGUID)`	Remove a relationship between a connection and a connector type.
`void`	`clearEmbeddedConnection(String connectionGUID, String embeddedConnectionGUID)`	Remove a relationship between a virtual connection and an embedded connection.
`void`	`clearEndpoint(String connectionGUID, String endpointGUID)`	Remove a relationship between a connection and an endpoint.
`void`	`clearSchemaTypes(String schemaAttributeGUID)`	Remove the linked schema types from a schema attribute.
`String`	`createConnection(ConnectionProperties connectionProperties)`	Create a new metadata element to represent a connection.
`String`	`createConnectionFromTemplate(String templateGUID, TemplateProperties templateProperties)`	Create a new metadata element to represent a connection using an existing metadata element as a template.
`String`	`createEndpoint(EndpointProperties endpointProperties)`	Create a new metadata element to represent an endpoint
`String`	`createEndpointFromTemplate(String networkAddress, String templateGUID, TemplateProperties templateProperties)`	Create a new metadata element to represent a endpoint using an existing metadata element as a template.
`String`	`createEnumSchemaType(EnumSchemaTypeProperties schemaTypeProperties, String validValuesSetGUID)`	Create a new metadata element to represent a schema type that has a fixed set of values that are described by a valid value set.
`String`	`createEventType(String topicGUID, EventTypeProperties properties)`	Create a new metadata element to represent a event type.
`String`	`createEventTypeFromTemplate(String templateGUID, String topicGUID, TemplateProperties templateProperties)`	Create a new metadata element to represent a event type using an existing metadata element as a template.
`String`	`createLiteralSchemaType(LiteralSchemaTypeProperties schemaTypeProperties)`	Create a new metadata element to represent a schema type that has a fixed value.
`String`	`createMapSchemaType(MapSchemaTypeProperties schemaTypeProperties, String mapFromSchemaTypeGUID, String mapToSchemaTypeGUID)`	Create a new metadata element to represent a schema type.
`String`	`createPrimitiveSchemaType(PrimitiveSchemaTypeProperties schemaTypeProperties)`	Create a new metadata element to represent a primitive schema type such as a string, integer or character.
`String`	`createSchemaAttribute(String schemaElementGUID, SchemaAttributeProperties schemaAttributeProperties)`	Create a new metadata element to represent a schema attribute.
`String`	`createSchemaAttributeFromTemplate(String schemaElementGUID, String templateGUID, TemplateProperties templateProperties)`	Create a new metadata element to represent a schema attribute using an existing metadata element as a template.
`String`	`createSchemaTypeChoice(SchemaTypeChoiceProperties schemaTypeProperties, List<String> schemaTypeOptionGUIDs)`	Create a new metadata element to represent a list of possible schema types that can be used for the attached schema attribute.
`String`	`createSchemaTypeFromTemplate(String templateGUID, TemplateProperties templateProperties)`	Create a new metadata element to represent a schema type using an existing metadata element as a template.
`String`	`createStructSchemaType(StructSchemaTypeProperties schemaTypeProperties)`	Create a new metadata element to represent a schema type.
`String`	`createTopic(TopicProperties topicProperties)`	Create a new metadata element to represent a topic.
`String`	`createTopicFromTemplate(String templateGUID, TemplateProperties templateProperties)`	Create a new metadata element to represent a topic using an existing metadata element as a template.
`List<ConnectionElement>`	`findConnections(String searchString, int startFrom, int pageSize)`	Retrieve the list of metadata elements that contain the search string.
`List<ConnectorTypeElement>`	`findConnectorTypes(String searchString, int startFrom, int pageSize)`	Retrieve the list of connector type metadata elements that contain the search string.
`List<EndpointElement>`	`findEndpoints(String searchString, int startFrom, int pageSize)`	Retrieve the list of endpoint metadata elements that contain the search string.
`List<EventTypeElement>`	`findEventTypes(String searchString, int startFrom, int pageSize)`	Retrieve the list of event type metadata elements that contain the search string.
`List<SchemaAttributeElement>`	`findSchemaAttributes(String searchString, String typeName, int startFrom, int pageSize)`	Retrieve the list of schema attribute metadata elements that contain the search string.
`List<SchemaTypeElement>`	`findSchemaType(String searchString, String typeName, int startFrom, int pageSize)`	Retrieve the list of schema type metadata elements that contain the search string.
`List<TopicElement>`	`findTopics(String searchString, int startFrom, int pageSize)`	Retrieve the list of topic metadata elements that contain the search string.
`List<ValidValueSetElement>`	`findValidValueSet(String searchString, int startFrom, int pageSize)`	Retrieve the list of valid value set metadata elements that contain the search string.
`ConnectionElement`	`getConnectionByGUID(String connectionGUID)`	Retrieve the metadata element with the supplied unique identifier.
`List<ConnectionElement>`	`getConnectionsByName(String name, int startFrom, int pageSize)`	Retrieve the list of metadata elements with a matching qualified or display name.
`ConnectorTypeElement`	`getConnectorTypeByGUID(String connectorTypeGUID)`	Retrieve the connector type metadata element with the supplied unique identifier.
`List<ConnectorTypeElement>`	`getConnectorTypesByName(String name, int startFrom, int pageSize)`	Retrieve the list of connector type metadata elements with a matching qualified or display name.
`EndpointElement`	`getEndpointByGUID(String endpointGUID)`	Retrieve the endpoint metadata element with the supplied unique identifier.
`List<EndpointElement>`	`getEndpointsByName(String name, int startFrom, int pageSize)`	Retrieve the list of endpoint metadata elements with a matching qualified or display name.
`EventTypeElement`	`getEventTypeByGUID(String guid)`	Retrieve the event type metadata element with the supplied unique identifier.
`List<EventTypeElement>`	`getEventTypesByName(String name, int startFrom, int pageSize)`	Retrieve the list of event type metadata elements with a matching qualified or display name.
`List<EventTypeElement>`	`getEventTypesForEventSet(String eventSetGUID, int startFrom, int pageSize)`	Return the list of event types associated with a topic.
`List<EventTypeElement>`	`getEventTypesForTopic(String topicGUID, int startFrom, int pageSize)`	Return the list of event types associated with a topic.
`List<TopicElement>`	`getMyTopics(int startFrom, int pageSize)`	Retrieve the list of topics created by this caller.
`List<SchemaAttributeElement>`	`getNestedAttributes(String parentSchemaElementGUID, int startFrom, int pageSize)`	Retrieve the list of schema attributes associated with a StructSchemaType or nested underneath a schema attribute.
`SchemaAttributeElement`	`getSchemaAttributeByGUID(String schemaAttributeGUID)`	Retrieve the schema attribute metadata element with the supplied unique identifier.
`List<SchemaAttributeElement>`	`getSchemaAttributesByName(String name, String typeName, int startFrom, int pageSize)`	Retrieve the list of schema attribute metadata elements with a matching qualified or display name.
`SchemaTypeElement`	`getSchemaTypeByGUID(String schemaTypeGUID)`	Retrieve the schema type metadata element with the supplied unique identifier.
`List<SchemaTypeElement>`	`getSchemaTypeByName(String name, String typeName, int startFrom, int pageSize)`	Retrieve the list of schema type metadata elements with a matching qualified or display name.
`SchemaTypeElement`	`getSchemaTypeForElement(String parentElementGUID, String parentElementTypeName)`	Return the schema type associated with a specific open metadata element (data asset, process or port).
`ElementHeader`	`getSchemaTypeParent(String schemaTypeGUID)`	Retrieve the header of the metadata element connected to a schema type.
`TopicElement`	`getTopicByGUID(String guid)`	Retrieve the topic metadata element with the supplied unique identifier.
`List<TopicElement>`	`getTopicsByName(String name, int startFrom, int pageSize)`	Retrieve the list of topic metadata elements with a matching qualified or display name.
`List<ValidValueSetElement>`	`getValidValueSetByName(String name, int startFrom, int pageSize)`	Retrieve the list of valid value set metadata elements with a matching qualified or display name.
`void`	`publishTopic(String topicGUID)`	Update the zones for the topic asset so that it becomes visible to consumers.
`void`	`registerListener(DataManagerEventListener listener)`	Register a listener object that will be passed each of the events published by the Data Manager OMAS.
`void`	`removeConnection(String connectionGUID)`	Remove the metadata element representing a connection.
`void`	`removeEndpoint(String endpointGUID)`	Remove the metadata element representing a endpoint.
`void`	`removeEventType(String eventTypeGUID, String qualifiedName)`	Remove the metadata element representing a event type.
`void`	`removeSchemaAttribute(String schemaAttributeGUID)`	Remove the metadata element representing a schema attribute.
`void`	`removeSchemaType(String schemaTypeGUID)`	Remove the metadata element representing a schema type.
`void`	`removeTopic(String topicGUID, String qualifiedName)`	Remove the metadata element representing a topic.
`void`	`setEventBrokerIsHome(boolean eventBrokerIsHome)`	Set up the flag that controls the ownership of metadata created for this Event Broker.
`void`	`setupAssetConnection(String assetGUID, String assetSummary, String connectionGUID)`	Create a relationship between an asset and its connection.
`void`	`setupConnectorType(String connectionGUID, String connectorTypeGUID)`	Create a relationship between a connection and a connector type.
`void`	`setupEmbeddedConnection(String connectionGUID, int position, String displayName, Map<String,Object> arguments, String embeddedConnectionGUID)`	Create a relationship between a virtual connection and an embedded connection.
`void`	`setupEndpoint(String connectionGUID, String endpointGUID)`	Create a relationship between a connection and an endpoint.
`void`	`setupSchemaType(String relationshipTypeName, String schemaAttributeGUID, String schemaTypeGUID)`	Connect a schema type to a schema attribute.
`void`	`updateConnection(String connectionGUID, boolean isMergeUpdate, ConnectionProperties connectionProperties)`	Update the metadata element representing a connection.
`void`	`updateEndpoint(boolean isMergeUpdate, String endpointGUID, EndpointProperties endpointProperties)`	Update the metadata element representing a endpoint.
`void`	`updateEventType(String eventTypeGUID, boolean isMergeUpdate, EventTypeProperties properties)`	Update the metadata element representing a event type.
`void`	`updateSchemaAttribute(String schemaAttributeGUID, boolean isMergeUpdate, SchemaAttributeProperties schemaAttributeProperties)`	Update the properties of the metadata element representing a schema attribute.
`void`	`updateSchemaType(String schemaTypeGUID, boolean isMergeUpdate, SchemaTypeProperties schemaTypeProperties)`	Update the metadata element representing a schema type.
`void`	`updateTopic(String topicGUID, boolean isMergeUpdate, TopicProperties topicProperties)`	Update the metadata element representing a topic.
`void`	`withdrawTopic(String topicGUID)`	Update the zones for the topic asset so that it is no longer visible to consumers.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TopicIntegratorContext
```
public TopicIntegratorContext(EventBrokerClient eventBrokerClient,
                              ConnectionManagerClient connectionManagerClient,
                              DataManagerEventClient eventClient,
                              String userId,
                              String eventBrokerGUID,
                              String eventBrokerName)
```
    Create a new client with no authentication embedded in the HTTP request.
    
    Parameters:
    
    eventBrokerClient - client to map request to
    
    connectionManagerClient - client for managing connections
    
    eventClient - client to register for events
    
    userId - integration daemon's userId
    
    eventBrokerGUID - unique identifier of the software server capability for the event broker
    
    eventBrokerName - unique name of the software server capability for the event broker
- Method Detail
  - setEventBrokerIsHome
```
public void setEventBrokerIsHome(boolean eventBrokerIsHome)
```
    Set up the flag that controls the ownership of metadata created for this Event Broker. Default is true.
    
    Parameters:
    
    eventBrokerIsHome - should the topic metadata be marked as owned by the event broker so others can not update?
  - registerListener
```
public void registerListener(DataManagerEventListener listener)
                      throws InvalidParameterException,
                             ConnectionCheckedException,
                             ConnectorCheckedException,
                             PropertyServerException,
                             UserNotAuthorizedException
```
    Register a listener object that will be passed each of the events published by the Data Manager OMAS.
    
    Parameters:
    
    listener - listener object
    
    Throws:
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.
    
    ConnectorCheckedException - there are errors in the initialization of the connector.
    
    PropertyServerException - there is a problem retrieving information from the property server(s).
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  - createTopic
```
public String createTopic(TopicProperties topicProperties)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException
```
    Create a new metadata element to represent a topic.
    
    Parameters:
    
    topicProperties - properties to store
    
    Returns:
    
    unique identifier of the new metadata element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createTopicFromTemplate
```
public String createTopicFromTemplate(String templateGUID,
                                      TemplateProperties templateProperties)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException
```
    Create a new metadata element to represent a topic using an existing metadata element as a template.
    
    Parameters:
    
    templateGUID - unique identifier of the metadata element to copy
    
    templateProperties - properties that override the template
    
    Returns:
    
    unique identifier of the new metadata element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - updateTopic
```
public void updateTopic(String topicGUID,
                        boolean isMergeUpdate,
                        TopicProperties topicProperties)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException
```
    Update the metadata element representing a topic.
    
    Parameters:
    
    topicGUID - unique identifier of the metadata element to update
    
    isMergeUpdate - are unspecified properties unchanged (true) or removed?
    
    topicProperties - new properties for this element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - publishTopic
```
public void publishTopic(String topicGUID)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException
```
    Update the zones for the topic asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the Data Manager OMAS).
    
    Parameters:
    
    topicGUID - unique identifier of the metadata element to publish
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - withdrawTopic
```
public void withdrawTopic(String topicGUID)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException
```
    Update the zones for the topic asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the Data Manager OMAS. This is the setting when the topic is first created).
    
    Parameters:
    
    topicGUID - unique identifier of the metadata element to withdraw
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - removeTopic
```
public void removeTopic(String topicGUID,
                        String qualifiedName)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException
```
    Remove the metadata element representing a topic.
    
    Parameters:
    
    topicGUID - unique identifier of the metadata element to remove
    
    qualifiedName - unique name of the metadata element to remove
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - findTopics
```
public List<TopicElement> findTopics(String searchString,
                                     int startFrom,
                                     int pageSize)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException
```
    Retrieve the list of topic metadata elements that contain the search string. The search string is treated as a regular expression.
    
    Parameters:
    
    searchString - string to find in the properties
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getTopicsByName
```
public List<TopicElement> getTopicsByName(String name,
                                          int startFrom,
                                          int pageSize)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException
```
    Retrieve the list of topic metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
    
    Parameters:
    
    name - name to search for
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getMyTopics
```
public List<TopicElement> getMyTopics(int startFrom,
                                      int pageSize)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException
```
    Retrieve the list of topics created by this caller.
    
    Parameters:
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getTopicByGUID
```
public TopicElement getTopicByGUID(String guid)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException
```
    Retrieve the topic metadata element with the supplied unique identifier.
    
    Parameters:
    
    guid - unique identifier of the requested metadata element
    
    Returns:
    
    matching metadata element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createEventType
```
public String createEventType(String topicGUID,
                              EventTypeProperties properties)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException
```
    Create a new metadata element to represent a event type.
    
    Parameters:
    
    topicGUID - unique identifier of the topic where the event type is located
    
    properties - properties about the event type
    
    Returns:
    
    unique identifier of the new event type
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createEventTypeFromTemplate
```
public String createEventTypeFromTemplate(String templateGUID,
                                          String topicGUID,
                                          TemplateProperties templateProperties)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException
```
    Create a new metadata element to represent a event type using an existing metadata element as a template.
    
    Parameters:
    
    templateGUID - unique identifier of the metadata element to copy
    
    topicGUID - unique identifier of the topic where the event type is located
    
    templateProperties - properties that override the template
    
    Returns:
    
    unique identifier of the new event type
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - updateEventType
```
public void updateEventType(String eventTypeGUID,
                            boolean isMergeUpdate,
                            EventTypeProperties properties)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException
```
    Update the metadata element representing a event type.
    
    Parameters:
    
    eventTypeGUID - unique identifier of the metadata element to update
    
    isMergeUpdate - are unspecified properties unchanged (true) or removed?
    
    properties - new properties for the metadata element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - removeEventType
```
public void removeEventType(String eventTypeGUID,
                            String qualifiedName)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException
```
    Remove the metadata element representing a event type.
    
    Parameters:
    
    eventTypeGUID - unique identifier of the metadata element to remove
    
    qualifiedName - unique name of the metadata element to remove
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - findEventTypes
```
public List<EventTypeElement> findEventTypes(String searchString,
                                             int startFrom,
                                             int pageSize)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException
```
    Retrieve the list of event type metadata elements that contain the search string. The search string is treated as a regular expression.
    
    Parameters:
    
    searchString - string to find in the properties
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getEventTypesForEventSet
```
public List<EventTypeElement> getEventTypesForEventSet(String eventSetGUID,
                                                       int startFrom,
                                                       int pageSize)
                                                throws InvalidParameterException,
                                                       UserNotAuthorizedException,
                                                       PropertyServerException
```
    Return the list of event types associated with a topic.
    
    Parameters:
    
    eventSetGUID - unique identifier of the topic to query
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of metadata elements describing the event types associated with the requested topic
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getEventTypesForTopic
```
public List<EventTypeElement> getEventTypesForTopic(String topicGUID,
                                                    int startFrom,
                                                    int pageSize)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException
```
    Return the list of event types associated with a topic.
    
    Parameters:
    
    topicGUID - unique identifier of the topic to query
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of metadata elements describing the event types associated with the requested topic
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getEventTypesByName
```
public List<EventTypeElement> getEventTypesByName(String name,
                                                  int startFrom,
                                                  int pageSize)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException
```
    Retrieve the list of event type metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
    
    Parameters:
    
    name - name to search for
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getEventTypeByGUID
```
public EventTypeElement getEventTypeByGUID(String guid)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
```
    Retrieve the event type metadata element with the supplied unique identifier.
    
    Parameters:
    
    guid - unique identifier of the requested metadata element
    
    Returns:
    
    requested metadata element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createPrimitiveSchemaType
```
public String createPrimitiveSchemaType(PrimitiveSchemaTypeProperties schemaTypeProperties)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException
```
    Create a new metadata element to represent a primitive schema type such as a string, integer or character.
    
    Parameters:
    
    schemaTypeProperties - properties about the schema type to store
    
    Returns:
    
    unique identifier of the new schema type
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createLiteralSchemaType
```
public String createLiteralSchemaType(LiteralSchemaTypeProperties schemaTypeProperties)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException
```
    Create a new metadata element to represent a schema type that has a fixed value.
    
    Parameters:
    
    schemaTypeProperties - properties about the schema type to store
    
    Returns:
    
    unique identifier of the new schema type
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createEnumSchemaType
```
public String createEnumSchemaType(EnumSchemaTypeProperties schemaTypeProperties,
                                   String validValuesSetGUID)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException
```
    Create a new metadata element to represent a schema type that has a fixed set of values that are described by a valid value set.
    
    Parameters:
    
    schemaTypeProperties - properties about the schema type to store
    
    validValuesSetGUID - unique identifier of the valid values set to used
    
    Returns:
    
    unique identifier of the new schema type
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getValidValueSetByName
```
public List<ValidValueSetElement> getValidValueSetByName(String name,
                                                         int startFrom,
                                                         int pageSize)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         PropertyServerException
```
    Retrieve the list of valid value set metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
    
    Parameters:
    
    name - name to search for
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - findValidValueSet
```
public List<ValidValueSetElement> findValidValueSet(String searchString,
                                                    int startFrom,
                                                    int pageSize)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException
```
    Retrieve the list of valid value set metadata elements that contain the search string. The search string is treated as a regular expression.
    
    Parameters:
    
    searchString - string to find in the properties
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createStructSchemaType
```
public String createStructSchemaType(StructSchemaTypeProperties schemaTypeProperties)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException
```
    Create a new metadata element to represent a schema type.
    
    Parameters:
    
    schemaTypeProperties - properties about the schema type to store
    
    Returns:
    
    unique identifier of the new schema type
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createSchemaTypeChoice
```
public String createSchemaTypeChoice(SchemaTypeChoiceProperties schemaTypeProperties,
                                     List<String> schemaTypeOptionGUIDs)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException
```
    Create a new metadata element to represent a list of possible schema types that can be used for the attached schema attribute.
    
    Parameters:
    
    schemaTypeProperties - properties about the schema type to store
    
    Returns:
    
    unique identifier of the new schema type
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createMapSchemaType
```
public String createMapSchemaType(MapSchemaTypeProperties schemaTypeProperties,
                                  String mapFromSchemaTypeGUID,
                                  String mapToSchemaTypeGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
```
    Create a new metadata element to represent a schema type.
    
    Parameters:
    
    schemaTypeProperties - properties about the schema type to store
    
    mapFromSchemaTypeGUID - unique identifier of the the domain of the map
    
    mapToSchemaTypeGUID - unique identifier of the the range of the map
    
    Returns:
    
    unique identifier of the new schema type
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createSchemaTypeFromTemplate
```
public String createSchemaTypeFromTemplate(String templateGUID,
                                           TemplateProperties templateProperties)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
```
    Create a new metadata element to represent a schema type using an existing metadata element as a template.
    
    Parameters:
    
    templateGUID - unique identifier of the metadata element to copy
    
    templateProperties - properties that override the template
    
    Returns:
    
    unique identifier of the new schema type
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - updateSchemaType
```
public void updateSchemaType(String schemaTypeGUID,
                             boolean isMergeUpdate,
                             SchemaTypeProperties schemaTypeProperties)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
```
    Update the metadata element representing a schema type. It is possible to use the subtype property classes or set up specialized properties in extended properties.
    
    Parameters:
    
    schemaTypeGUID - unique identifier of the metadata element to update
    
    isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
    
    schemaTypeProperties - new properties for the metadata element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - removeSchemaType
```
public void removeSchemaType(String schemaTypeGUID)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
```
    Remove the metadata element representing a schema type.
    
    Parameters:
    
    schemaTypeGUID - unique identifier of the metadata element to remove
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - findSchemaType
```
public List<SchemaTypeElement> findSchemaType(String searchString,
                                              String typeName,
                                              int startFrom,
                                              int pageSize)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException
```
    Retrieve the list of schema type metadata elements that contain the search string. The search string is treated as a regular expression.
    
    Parameters:
    
    searchString - string to find in the properties
    
    typeName - optional type name for the schema type - used to restrict the search results
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getSchemaTypeForElement
```
public SchemaTypeElement getSchemaTypeForElement(String parentElementGUID,
                                                 String parentElementTypeName)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException
```
    Return the schema type associated with a specific open metadata element (data asset, process or port).
    
    Parameters:
    
    parentElementGUID - unique identifier of the open metadata element that this schema type is connected to
    
    parentElementTypeName - unique type name of the open metadata element that this schema type is connected to
    
    Returns:
    
    metadata element describing the schema type associated with the requested parent element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getSchemaTypeByName
```
public List<SchemaTypeElement> getSchemaTypeByName(String name,
                                                   String typeName,
                                                   int startFrom,
                                                   int pageSize)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException
```
    Retrieve the list of schema type metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
    
    Parameters:
    
    name - name to search for
    
    typeName - optional type name for the schema type - used to restrict the search results
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getSchemaTypeByGUID
```
public SchemaTypeElement getSchemaTypeByGUID(String schemaTypeGUID)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException
```
    Retrieve the schema type metadata element with the supplied unique identifier.
    
    Parameters:
    
    schemaTypeGUID - unique identifier of the requested metadata element
    
    Returns:
    
    requested metadata element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getSchemaTypeParent
```
public ElementHeader getSchemaTypeParent(String schemaTypeGUID)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException
```
    Retrieve the header of the metadata element connected to a schema type.
    
    Parameters:
    
    schemaTypeGUID - unique identifier of the requested metadata element
    
    Returns:
    
    header for parent element (data asset, process, port)
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createSchemaAttribute
```
public String createSchemaAttribute(String schemaElementGUID,
                                    SchemaAttributeProperties schemaAttributeProperties)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException
```
    Create a new metadata element to represent a schema attribute.
    
    Parameters:
    
    schemaElementGUID - unique identifier of the schemaType or Schema Attribute where the schema attribute is nested underneath
    
    schemaAttributeProperties - properties for the schema attribute
    
    Returns:
    
    unique identifier of the new metadata element for the schema attribute
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createSchemaAttributeFromTemplate
```
public String createSchemaAttributeFromTemplate(String schemaElementGUID,
                                                String templateGUID,
                                                TemplateProperties templateProperties)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException
```
    Create a new metadata element to represent a schema attribute using an existing metadata element as a template.
    
    Parameters:
    
    schemaElementGUID - unique identifier of the schemaType or Schema Attribute where the schema attribute is connected to
    
    templateGUID - unique identifier of the metadata element to copy
    
    templateProperties - properties that override the template
    
    Returns:
    
    unique identifier of the new metadata element for the schema attribute
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - setupSchemaType
```
public void setupSchemaType(String relationshipTypeName,
                            String schemaAttributeGUID,
                            String schemaTypeGUID)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException
```
    Connect a schema type to a schema attribute.
    
    Parameters:
    
    relationshipTypeName - name of relationship to create
    
    schemaAttributeGUID - unique identifier of the schema attribute
    
    schemaTypeGUID - unique identifier of the schema type to connect
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - clearSchemaTypes
```
public void clearSchemaTypes(String schemaAttributeGUID)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
```
    Remove the linked schema types from a schema attribute.
    
    Parameters:
    
    schemaAttributeGUID - unique identifier of the schema attribute
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - updateSchemaAttribute
```
public void updateSchemaAttribute(String schemaAttributeGUID,
                                  boolean isMergeUpdate,
                                  SchemaAttributeProperties schemaAttributeProperties)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
```
    Update the properties of the metadata element representing a schema attribute.
    
    Parameters:
    
    schemaAttributeGUID - unique identifier of the schema attribute to update
    
    isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
    
    schemaAttributeProperties - new properties for the schema attribute
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - removeSchemaAttribute
```
public void removeSchemaAttribute(String schemaAttributeGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
```
    Remove the metadata element representing a schema attribute.
    
    Parameters:
    
    schemaAttributeGUID - unique identifier of the metadata element to remove
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - findSchemaAttributes
```
public List<SchemaAttributeElement> findSchemaAttributes(String searchString,
                                                         String typeName,
                                                         int startFrom,
                                                         int pageSize)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         PropertyServerException
```
    Retrieve the list of schema attribute metadata elements that contain the search string. The search string is treated as a regular expression.
    
    Parameters:
    
    searchString - string to find in the properties
    
    typeName - optional type name for the schema type - used to restrict the search results
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getNestedAttributes
```
public List<SchemaAttributeElement> getNestedAttributes(String parentSchemaElementGUID,
                                                        int startFrom,
                                                        int pageSize)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        PropertyServerException
```
    Retrieve the list of schema attributes associated with a StructSchemaType or nested underneath a schema attribute.
    
    Parameters:
    
    parentSchemaElementGUID - unique identifier of the schemaType of interest
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of associated metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getSchemaAttributesByName
```
public List<SchemaAttributeElement> getSchemaAttributesByName(String name,
                                                              String typeName,
                                                              int startFrom,
                                                              int pageSize)
                                                       throws InvalidParameterException,
                                                              UserNotAuthorizedException,
                                                              PropertyServerException
```
    Retrieve the list of schema attribute metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
    
    Parameters:
    
    name - name to search for
    
    typeName - optional type name for the schema type - used to restrict the search results
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getSchemaAttributeByGUID
```
public SchemaAttributeElement getSchemaAttributeByGUID(String schemaAttributeGUID)
                                                throws InvalidParameterException,
                                                       UserNotAuthorizedException,
                                                       PropertyServerException
```
    Retrieve the schema attribute metadata element with the supplied unique identifier.
    
    Parameters:
    
    schemaAttributeGUID - unique identifier of the requested metadata element
    
    Returns:
    
    matching metadata element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createConnection
```
public String createConnection(ConnectionProperties connectionProperties)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException
```
    Create a new metadata element to represent a connection.
    
    Parameters:
    
    connectionProperties - properties about the connection to store
    
    Returns:
    
    unique identifier of the new connection
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createConnectionFromTemplate
```
public String createConnectionFromTemplate(String templateGUID,
                                           TemplateProperties templateProperties)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
```
    Create a new metadata element to represent a connection using an existing metadata element as a template.
    
    Parameters:
    
    templateGUID - unique identifier of the metadata element to copy
    
    templateProperties - properties that override the template
    
    Returns:
    
    unique identifier of the new connection
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - updateConnection
```
public void updateConnection(String connectionGUID,
                             boolean isMergeUpdate,
                             ConnectionProperties connectionProperties)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
```
    Update the metadata element representing a connection. It is possible to use the subtype property classes or set up specialized properties in extended properties.
    
    Parameters:
    
    connectionGUID - unique identifier of the metadata element to update
    
    isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
    
    connectionProperties - new properties for the metadata element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - setupConnectorType
```
public void setupConnectorType(String connectionGUID,
                               String connectorTypeGUID)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException
```
    Create a relationship between a connection and a connector type.
    
    Parameters:
    
    connectionGUID - unique identifier of the connection
    
    connectorTypeGUID - unique identifier of the connector type
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - clearConnectorType
```
public void clearConnectorType(String connectionGUID,
                               String connectorTypeGUID)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException
```
    Remove a relationship between a connection and a connector type.
    
    Parameters:
    
    connectionGUID - unique identifier of the connection
    
    connectorTypeGUID - unique identifier of the connector type
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - setupEndpoint
```
public void setupEndpoint(String connectionGUID,
                          String endpointGUID)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException
```
    Create a relationship between a connection and an endpoint.
    
    Parameters:
    
    connectionGUID - unique identifier of the connection
    
    endpointGUID - unique identifier of the endpoint
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - clearEndpoint
```
public void clearEndpoint(String connectionGUID,
                          String endpointGUID)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException
```
    Remove a relationship between a connection and an endpoint.
    
    Parameters:
    
    connectionGUID - unique identifier of the connection
    
    endpointGUID - unique identifier of the endpoint
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - setupEmbeddedConnection
```
public void setupEmbeddedConnection(String connectionGUID,
                                    int position,
                                    String displayName,
                                    Map<String,Object> arguments,
                                    String embeddedConnectionGUID)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException
```
    Create a relationship between a virtual connection and an embedded connection.
    
    Parameters:
    
    connectionGUID - unique identifier of the virtual connection
    
    position - which order should this connection be processed
    
    arguments - What additional properties should be passed to the embedded connector via the configuration properties
    
    displayName - what does this connector signify?
    
    embeddedConnectionGUID - unique identifier of the embedded connection
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - clearEmbeddedConnection
```
public void clearEmbeddedConnection(String connectionGUID,
                                    String embeddedConnectionGUID)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException
```
    Remove a relationship between a virtual connection and an embedded connection.
    
    Parameters:
    
    connectionGUID - unique identifier of the virtual connection
    
    embeddedConnectionGUID - unique identifier of the embedded connection
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - setupAssetConnection
```
public void setupAssetConnection(String assetGUID,
                                 String assetSummary,
                                 String connectionGUID)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException
```
    Create a relationship between an asset and its connection.
    
    Parameters:
    
    assetGUID - unique identifier of the asset
    
    assetSummary - summary of the asset that is stored in the relationship between the asset and the connection.
    
    connectionGUID - unique identifier of the connection
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - clearAssetConnection
```
public void clearAssetConnection(String assetGUID,
                                 String connectionGUID)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException
```
    Remove a relationship between an asset and its connection.
    
    Parameters:
    
    assetGUID - unique identifier of the asset
    
    connectionGUID - unique identifier of the connection
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - removeConnection
```
public void removeConnection(String connectionGUID)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
```
    Remove the metadata element representing a connection.
    
    Parameters:
    
    connectionGUID - unique identifier of the metadata element to remove
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - findConnections
```
public List<ConnectionElement> findConnections(String searchString,
                                               int startFrom,
                                               int pageSize)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException
```
    Retrieve the list of metadata elements that contain the search string. The search string is treated as a regular expression.
    
    Parameters:
    
    searchString - string to find in the properties
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getConnectionsByName
```
public List<ConnectionElement> getConnectionsByName(String name,
                                                    int startFrom,
                                                    int pageSize)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException
```
    Retrieve the list of metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
    
    Parameters:
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getConnectionByGUID
```
public ConnectionElement getConnectionByGUID(String connectionGUID)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException
```
    Retrieve the metadata element with the supplied unique identifier.
    
    Parameters:
    
    connectionGUID - unique identifier of the requested metadata element
    
    Returns:
    
    requested metadata element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createEndpoint
```
public String createEndpoint(EndpointProperties endpointProperties)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
```
    Create a new metadata element to represent an endpoint
    
    Parameters:
    
    endpointProperties - properties about the endpoint to store
    
    Returns:
    
    unique identifier of the new endpoint
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createEndpointFromTemplate
```
public String createEndpointFromTemplate(String networkAddress,
                                         String templateGUID,
                                         TemplateProperties templateProperties)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException
```
    Create a new metadata element to represent a endpoint using an existing metadata element as a template.
    
    Parameters:
    
    networkAddress - location of the endpoint
    
    templateGUID - unique identifier of the metadata element to copy
    
    templateProperties - descriptive properties that override the template
    
    Returns:
    
    unique identifier of the new endpoint
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - updateEndpoint
```
public void updateEndpoint(boolean isMergeUpdate,
                           String endpointGUID,
                           EndpointProperties endpointProperties)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException
```
    Update the metadata element representing a endpoint. It is possible to use the subtype property classes or set up specialized properties in extended properties.
    
    Parameters:
    
    endpointGUID - unique identifier of the metadata element to update
    
    isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
    
    endpointProperties - new properties for the metadata element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - removeEndpoint
```
public void removeEndpoint(String endpointGUID)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException
```
    Remove the metadata element representing a endpoint.
    
    Parameters:
    
    endpointGUID - unique identifier of the metadata element to remove
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - findEndpoints
```
public List<EndpointElement> findEndpoints(String searchString,
                                           int startFrom,
                                           int pageSize)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
```
    Retrieve the list of endpoint metadata elements that contain the search string. The search string is treated as a regular expression.
    
    Parameters:
    
    searchString - string to find in the properties
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getEndpointsByName
```
public List<EndpointElement> getEndpointsByName(String name,
                                                int startFrom,
                                                int pageSize)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException
```
    Retrieve the list of endpoint metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
    
    Parameters:
    
    name - name to search for
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getEndpointByGUID
```
public EndpointElement getEndpointByGUID(String endpointGUID)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException
```
    Retrieve the endpoint metadata element with the supplied unique identifier.
    
    Parameters:
    
    endpointGUID - unique identifier of the requested metadata element
    
    Returns:
    
    requested metadata element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - findConnectorTypes
```
public List<ConnectorTypeElement> findConnectorTypes(String searchString,
                                                     int startFrom,
                                                     int pageSize)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException
```
    Retrieve the list of connector type metadata elements that contain the search string. The search string is treated as a regular expression.
    
    Parameters:
    
    searchString - string to find in the properties
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getConnectorTypesByName
```
public List<ConnectorTypeElement> getConnectorTypesByName(String name,
                                                          int startFrom,
                                                          int pageSize)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          PropertyServerException
```
    Retrieve the list of connector type metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
    
    Parameters:
    
    name - name to search for
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getConnectorTypeByGUID
```
public ConnectorTypeElement getConnectorTypeByGUID(String connectorTypeGUID)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException
```
    Retrieve the connector type metadata element with the supplied unique identifier.
    
    Parameters:
    
    connectorTypeGUID - unique identifier of the requested metadata element
    
    Returns:
    
    requested metadata element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)

Class TopicIntegratorContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TopicIntegratorContext

Method Detail

setEventBrokerIsHome

registerListener

createTopic

createTopicFromTemplate

updateTopic

publishTopic

withdrawTopic

removeTopic

findTopics

getTopicsByName

getMyTopics

getTopicByGUID

createEventType

createEventTypeFromTemplate

updateEventType

removeEventType

findEventTypes

getEventTypesForEventSet

getEventTypesForTopic

getEventTypesByName

getEventTypeByGUID

createPrimitiveSchemaType

createLiteralSchemaType

createEnumSchemaType

getValidValueSetByName

findValidValueSet

createStructSchemaType

createSchemaTypeChoice

createMapSchemaType

createSchemaTypeFromTemplate

updateSchemaType

removeSchemaType

findSchemaType

getSchemaTypeForElement

getSchemaTypeByName

getSchemaTypeByGUID

getSchemaTypeParent

createSchemaAttribute

createSchemaAttributeFromTemplate

setupSchemaType

clearSchemaTypes

updateSchemaAttribute

removeSchemaAttribute

findSchemaAttributes

getNestedAttributes

getSchemaAttributesByName

getSchemaAttributeByGUID

createConnection

createConnectionFromTemplate

updateConnection

setupConnectorType

clearConnectorType

setupEndpoint

clearEndpoint

setupEmbeddedConnection

clearEmbeddedConnection

setupAssetConnection

clearAssetConnection

removeConnection

findConnections

getConnectionsByName

getConnectionByGUID

createEndpoint

createEndpointFromTemplate

updateEndpoint

removeEndpoint

findEndpoints

getEndpointsByName

getEndpointByGUID

findConnectorTypes

getConnectorTypesByName

getConnectorTypeByGUID