Class ConnectionExchangeRESTServices
java.lang.Object
org.odpi.openmetadata.accessservices.assetmanager.server.ConnectionExchangeRESTServices
ConnectionExchangeRESTServices is the server-side for managing Connections, Endpoints and ConnectorTypes.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionclearAssetConnection
(String serverName, String userId, String assetGUID, String connectionGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Remove a relationship between an asset and its connection.clearConnectorType
(String serverName, String userId, String connectionGUID, String connectorTypeGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Remove a relationship between a connection and a connector type.clearEmbeddedConnection
(String serverName, String userId, String connectionGUID, String embeddedConnectionGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Remove a relationship between a virtual connection and an embedded connection.clearEndpoint
(String serverName, String userId, String connectionGUID, String endpointGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Remove a relationship between a connection and an endpoint.createConnection
(String serverName, String userId, boolean assetManagerIsHome, ConnectionRequestBody requestBody) Create a new metadata element to represent the root of a connection.createConnectionFromTemplate
(String serverName, String userId, String templateGUID, boolean assetManagerIsHome, TemplateRequestBody requestBody) Create a new metadata element to represent a connection using an existing metadata element as a template.createConnectorType
(String serverName, String userId, boolean assetManagerIsHome, ConnectorTypeRequestBody requestBody) Create a new metadata element to represent the root of an asset.createConnectorTypeFromTemplate
(String serverName, String userId, String templateGUID, boolean assetManagerIsHome, TemplateRequestBody requestBody) Create a new metadata element to represent an asset using an existing metadata element as a template.createEndpoint
(String serverName, String userId, boolean assetManagerIsHome, EndpointRequestBody requestBody) Create a new metadata element to represent a network endpoint.createEndpointFromTemplate
(String serverName, String userId, String templateGUID, boolean assetManagerIsHome, TemplateRequestBody requestBody) Create a new metadata element to represent a network endpoint using an existing metadata element as a template.findConnections
(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, SearchStringRequestBody requestBody) Retrieve the list of connection metadata elements that contain the search string.findConnectorTypes
(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, SearchStringRequestBody requestBody) Retrieve the list of connector type metadata elements that contain the search string.findEndpoints
(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, SearchStringRequestBody requestBody) Retrieve the list of network endpoint metadata elements that contain the search string.getConnectionByGUID
(String serverName, String userId, String connectionGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the connection metadata element with the supplied unique identifier.getConnectionsByName
(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, NameRequestBody requestBody) Retrieve the list of connection metadata elements with a matching qualified or display name.getConnectionsForAssetManager
(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the list of connections created on behalf of the named asset manager.getConnectorTypeByGUID
(String serverName, String userId, String connectorTypeGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the connector type metadata element with the supplied unique identifier.getConnectorTypesByName
(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, NameRequestBody requestBody) Retrieve the list of connector type metadata elements with a matching qualified or display name.getConnectorTypesForAssetManager
(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the list of assets created on behalf of the named asset manager.getEndpointByGUID
(String serverName, String userId, String endpointGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the network endpoint metadata element with the supplied unique identifier.getEndpointsByName
(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, NameRequestBody requestBody) Retrieve the list of network endpoint metadata elements with a matching qualified or display name.getEndpointsForAssetManager
(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the list of endpoints created on behalf of the named asset manager.removeConnection
(String serverName, String userId, String connectionGUID, boolean forLineage, boolean forDuplicateProcessing, UpdateRequestBody requestBody) Remove the metadata element representing a connection.removeConnectorType
(String serverName, String userId, String connectorTypeGUID, boolean forLineage, boolean forDuplicateProcessing, UpdateRequestBody requestBody) Remove the metadata element representing an asset.removeEndpoint
(String serverName, String userId, String endpointGUID, boolean forLineage, boolean forDuplicateProcessing, UpdateRequestBody requestBody) Remove the metadata element representing a network endpoint.setupAssetConnection
(String serverName, String userId, boolean assetManagerIsHome, String assetGUID, String connectionGUID, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody) Create a relationship between an asset and its connection.setupConnectorType
(String serverName, String userId, String connectionGUID, String connectorTypeGUID, boolean assetManagerIsHome, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody) Create a relationship between a connection and a connector type.setupEmbeddedConnection
(String serverName, String userId, String connectionGUID, String embeddedConnectionGUID, boolean assetManagerIsHome, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody) Create a relationship between a virtual connection and an embedded connection.setupEndpoint
(String serverName, String userId, String connectionGUID, String endpointGUID, boolean assetManagerIsHome, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody) Create a relationship between a connection and an endpoint.updateConnection
(String serverName, String userId, String connectionGUID, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, ConnectionRequestBody requestBody) Update the metadata element representing an asset.updateConnectorType
(String serverName, String userId, String connectorTypeGUID, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, ConnectorTypeRequestBody requestBody) Update the metadata element representing an asset.updateEndpoint
(String serverName, String userId, String endpointGUID, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, EndpointRequestBody requestBody) Update the metadata element representing an asset.
-
Constructor Details
-
ConnectionExchangeRESTServices
public ConnectionExchangeRESTServices()Default constructor
-
-
Method Details
-
createConnection
public GUIDResponse createConnection(String serverName, String userId, boolean assetManagerIsHome, ConnectionRequestBody requestBody) Create a new metadata element to represent the root of a connection.- Parameters:
serverName
- name of the server to route the request touserId
- calling userassetManagerIsHome
- ensure that only the asset manager can update this connectionrequestBody
- properties to store- Returns:
- unique identifier of the new metadata element or 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 GUIDResponse createConnectionFromTemplate(String serverName, String userId, String templateGUID, boolean assetManagerIsHome, TemplateRequestBody requestBody) Create a new metadata element to represent a connection using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new connection.- Parameters:
serverName
- name of the server to route the request touserId
- calling usertemplateGUID
- unique identifier of the metadata element to copyassetManagerIsHome
- ensure that only the asset manager can update this connectionrequestBody
- properties to store- Returns:
- unique identifier of the new metadata element or 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 VoidResponse updateConnection(String serverName, String userId, String connectionGUID, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, ConnectionRequestBody requestBody) Update the metadata element representing an asset.- Parameters:
serverName
- name of the server to route the request touserId
- calling userconnectionGUID
- unique identifier of the metadata element to updateisMergeUpdate
- should the new properties be merged with existing properties (true) or completely replace them (false)?forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties to store- Returns:
- void or 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 VoidResponse setupConnectorType(String serverName, String userId, String connectionGUID, String connectorTypeGUID, boolean assetManagerIsHome, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody) Create a relationship between a connection and a connector type.- Parameters:
serverName
- name of the server to route the request touserId
- calling userconnectionGUID
- unique identifier of the connection in the external asset managerconnectorTypeGUID
- unique identifier of the connector type in the external asset managerassetManagerIsHome
- ensure that only the asset manager can update this relationshipforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties to store- Returns:
- void or 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 VoidResponse clearConnectorType(String serverName, String userId, String connectionGUID, String connectorTypeGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Remove a relationship between a connection and a connector type.- Parameters:
serverName
- name of the server to route the request touserId
- calling userconnectionGUID
- unique identifier of the connection in the external asset managerconnectorTypeGUID
- unique identifier of the connector type in the external asset managerforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties to store- Returns:
- void or 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 VoidResponse setupEndpoint(String serverName, String userId, String connectionGUID, String endpointGUID, boolean assetManagerIsHome, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody) Create a relationship between a connection and an endpoint.- Parameters:
serverName
- name of the server to route the request touserId
- calling userconnectionGUID
- unique identifier of the connection in the external asset managerendpointGUID
- unique identifier of the endpoint in the external asset managerassetManagerIsHome
- ensure that only the asset manager can update this relationshipforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties to store- Returns:
- void or 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 VoidResponse clearEndpoint(String serverName, String userId, String connectionGUID, String endpointGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Remove a relationship between a connection and an endpoint.- Parameters:
serverName
- name of the server to route the request touserId
- calling userconnectionGUID
- unique identifier of the connection in the external asset managerendpointGUID
- unique identifier of the endpoint in the external asset managerforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties to store- Returns:
- void or 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 VoidResponse setupEmbeddedConnection(String serverName, String userId, String connectionGUID, String embeddedConnectionGUID, boolean assetManagerIsHome, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody) Create a relationship between a virtual connection and an embedded connection.- Parameters:
serverName
- name of the server to route the request touserId
- calling userconnectionGUID
- unique identifier of the virtual connection in the external asset managerembeddedConnectionGUID
- unique identifier of the embedded connection in the external asset managerassetManagerIsHome
- ensure that only the asset manager can update this relationshipforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties to store- Returns:
- void or 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 VoidResponse clearEmbeddedConnection(String serverName, String userId, String connectionGUID, String embeddedConnectionGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Remove a relationship between a virtual connection and an embedded connection.- Parameters:
serverName
- name of the server to route the request touserId
- calling userconnectionGUID
- unique identifier of the virtual connection in the external asset managerembeddedConnectionGUID
- unique identifier of the embedded connection in the external asset managerforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties to store- Returns:
- void or 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 VoidResponse setupAssetConnection(String serverName, String userId, boolean assetManagerIsHome, String assetGUID, String connectionGUID, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody) Create a relationship between an asset and its connection.- Parameters:
serverName
- name of the server to route the request touserId
- calling userassetManagerIsHome
- ensure that only the asset manager can update this relationshipassetGUID
- unique identifier of the assetconnectionGUID
- unique identifier of the connectionforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties to store- Returns:
- void or 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 VoidResponse clearAssetConnection(String serverName, String userId, String assetGUID, String connectionGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Remove a relationship between an asset and its connection.- Parameters:
serverName
- name of the server to route the request touserId
- calling userassetGUID
- unique identifier of the assetconnectionGUID
- unique identifier of the connectionforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties to store- Returns:
- void or 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 VoidResponse removeConnection(String serverName, String userId, String connectionGUID, boolean forLineage, boolean forDuplicateProcessing, UpdateRequestBody requestBody) Remove the metadata element representing a connection. This will delete the connection and all anchored elements such as schema and comments.- Parameters:
serverName
- name of the server to route the request touserId
- calling userconnectionGUID
- unique identifier of the metadata element to removeforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for query- Returns:
- void or 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 ConnectionsResponse findConnections(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, SearchStringRequestBody requestBody) Retrieve the list of connection metadata elements that contain the search string. The search string is treated as a regular expression.- Parameters:
serverName
- name of the server to route the request touserId
- calling userstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for query- Returns:
- list of matching metadata elements or 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 ConnectionsResponse getConnectionsByName(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, NameRequestBody requestBody) Retrieve the list of connection metadata elements with a matching qualified or display name. There are no wildcards supported on this request.- Parameters:
serverName
- name of the server to route the request touserId
- calling userstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for query- Returns:
- list of matching metadata elements or 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)
-
getConnectionsForAssetManager
public ConnectionsResponse getConnectionsForAssetManager(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the list of connections created on behalf of the named asset manager.- Parameters:
serverName
- name of the server to route the request touserId
- calling userstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for query- Returns:
- list of matching metadata elements or 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 ConnectionResponse getConnectionByGUID(String serverName, String userId, String connectionGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the connection metadata element with the supplied unique identifier.- Parameters:
serverName
- name of the server to route the request touserId
- calling userconnectionGUID
- unique identifier of the requested metadata elementforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for query- Returns:
- matching metadata element or 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 GUIDResponse createEndpoint(String serverName, String userId, boolean assetManagerIsHome, EndpointRequestBody requestBody) Create a new metadata element to represent a network endpoint.- Parameters:
serverName
- name of the server to route the request touserId
- calling userassetManagerIsHome
- ensure that only the asset manager can update this endpointrequestBody
- properties to store- Returns:
- unique identifier of the new metadata element or 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 GUIDResponse createEndpointFromTemplate(String serverName, String userId, String templateGUID, boolean assetManagerIsHome, TemplateRequestBody requestBody) Create a new metadata element to represent a network endpoint using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new endpoint.- Parameters:
serverName
- name of the server to route the request touserId
- calling userassetManagerIsHome
- ensure that only the asset manager can update this endpointtemplateGUID
- unique identifier of the metadata element to copyrequestBody
- properties to store- Returns:
- unique identifier of the new metadata element or 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 VoidResponse updateEndpoint(String serverName, String userId, String endpointGUID, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, EndpointRequestBody requestBody) Update the metadata element representing an asset.- Parameters:
serverName
- name of the server to route the request touserId
- calling userendpointGUID
- unique identifier of the metadata element to updateisMergeUpdate
- should the new properties be merged with existing properties (true) or completely replace them (false)?forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties to store- Returns:
- void or 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 VoidResponse removeEndpoint(String serverName, String userId, String endpointGUID, boolean forLineage, boolean forDuplicateProcessing, UpdateRequestBody requestBody) Remove the metadata element representing a network endpoint. This will delete the endpoint and all anchored elements such as schema and comments.- Parameters:
serverName
- name of the server to route the request touserId
- calling userendpointGUID
- unique identifier of the metadata element to removeforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for query- Returns:
- void or 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 EndpointsResponse findEndpoints(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, SearchStringRequestBody requestBody) Retrieve the list of network endpoint metadata elements that contain the search string. The search string is treated as a regular expression.- Parameters:
serverName
- name of the server to route the request touserId
- calling userstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for query- Returns:
- list of matching metadata elements or 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 EndpointsResponse getEndpointsByName(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, NameRequestBody requestBody) Retrieve the list of network endpoint metadata elements with a matching qualified or display name. There are no wildcards supported on this request.- Parameters:
serverName
- name of the server to route the request touserId
- calling userstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for query- Returns:
- list of matching metadata elements or 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)
-
getEndpointsForAssetManager
public EndpointsResponse getEndpointsForAssetManager(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the list of endpoints created on behalf of the named asset manager.- Parameters:
serverName
- name of the server to route the request touserId
- calling userstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties to store- Returns:
- list of matching metadata elements or 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 EndpointResponse getEndpointByGUID(String serverName, String userId, String endpointGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the network endpoint metadata element with the supplied unique identifier.- Parameters:
serverName
- name of the server to route the request touserId
- calling userendpointGUID
- unique identifier of the requested metadata elementforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties to store- Returns:
- matching metadata element or 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)
-
createConnectorType
public GUIDResponse createConnectorType(String serverName, String userId, boolean assetManagerIsHome, ConnectorTypeRequestBody requestBody) Create a new metadata element to represent the root of an asset.- Parameters:
serverName
- name of the server to route the request touserId
- calling userassetManagerIsHome
- ensure that only the asset manager can update this assetrequestBody
- properties to store- Returns:
- unique identifier of the new metadata element or 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)
-
createConnectorTypeFromTemplate
public GUIDResponse createConnectorTypeFromTemplate(String serverName, String userId, String templateGUID, boolean assetManagerIsHome, TemplateRequestBody requestBody) Create a new metadata element to represent an asset using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new asset.- Parameters:
serverName
- name of the server to route the request touserId
- calling usertemplateGUID
- unique identifier of the metadata element to copyassetManagerIsHome
- ensure that only the asset manager can update this assetrequestBody
- properties to store- Returns:
- unique identifier of the new metadata element or 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)
-
updateConnectorType
public VoidResponse updateConnectorType(String serverName, String userId, String connectorTypeGUID, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, ConnectorTypeRequestBody requestBody) Update the metadata element representing an asset.- Parameters:
serverName
- name of the server to route the request touserId
- calling userconnectorTypeGUID
- unique identifier of the metadata element to updateisMergeUpdate
- should the new properties be merged with existing properties (true) or completely replace them (false)?forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties to store- Returns:
- void or 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)
-
removeConnectorType
public VoidResponse removeConnectorType(String serverName, String userId, String connectorTypeGUID, boolean forLineage, boolean forDuplicateProcessing, UpdateRequestBody requestBody) Remove the metadata element representing an asset. This will delete the asset and all anchored elements such as schema and comments.- Parameters:
serverName
- name of the server to route the request touserId
- calling userconnectorTypeGUID
- unique identifier of the metadata element to removeforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties to store- Returns:
- void or 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 ConnectorTypesResponse findConnectorTypes(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, SearchStringRequestBody requestBody) Retrieve the list of connector type metadata elements that contain the search string. The search string is treated as a regular expression.- Parameters:
serverName
- name of the server to route the request touserId
- calling userstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for query- Returns:
- list of matching metadata elements or 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 ConnectorTypesResponse getConnectorTypesByName(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, NameRequestBody requestBody) Retrieve the list of connector type metadata elements with a matching qualified or display name. There are no wildcards supported on this request.- Parameters:
serverName
- name of the server to route the request touserId
- calling userstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties to store- Returns:
- list of matching metadata elements or 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)
-
getConnectorTypesForAssetManager
public ConnectorTypesResponse getConnectorTypesForAssetManager(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the list of assets created on behalf of the named asset manager.- Parameters:
serverName
- name of the server to route the request touserId
- calling userstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for query- Returns:
- list of matching metadata elements or 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 ConnectorTypeResponse getConnectorTypeByGUID(String serverName, String userId, String connectorTypeGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the connector type metadata element with the supplied unique identifier.- Parameters:
serverName
- name of the server to route the request touserId
- calling userconnectorTypeGUID
- unique identifier of the requested metadata elementforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for query- Returns:
- matching metadata element or 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)
-