Package org.odpi.openmetadata.accessservices.assetmanager.server

Class ConnectionExchangeRESTServices

java.lang.Object
org.odpi.openmetadata.accessservices.assetmanager.server.ConnectionExchangeRESTServices
public class ConnectionExchangeRESTServices extends Object
ConnectionExchangeRESTServices is the server-side for managing Connections, Endpoints and ConnectorTypes.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConnectionExchangeRESTServices()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearAssetConnection(String serverName, String userId, String assetGUID, String connectionGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
    Remove a relationship between an asset and its connection.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearConnectorType(String serverName, String userId, String connectionGUID, String connectorTypeGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
    Remove a relationship between a connection and a connector type.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearEmbeddedConnection(String serverName, String userId, String connectionGUID, String embeddedConnectionGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
    Remove a relationship between a virtual connection and an embedded connection.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearEndpoint(String serverName, String userId, String connectionGUID, String endpointGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
    Remove a relationship between a connection and an endpoint.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createConnection(String serverName, String userId, boolean assetManagerIsHome, org.odpi.openmetadata.accessservices.assetmanager.rest.ConnectionRequestBody requestBody)
    Create a new metadata element to represent the root of a connection.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createConnectionFromTemplate(String serverName, String userId, String templateGUID, boolean assetManagerIsHome, org.odpi.openmetadata.accessservices.assetmanager.rest.TemplateRequestBody requestBody)
    Create a new metadata element to represent a connection using an existing metadata element as a template.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createConnectorType(String serverName, String userId, boolean assetManagerIsHome, org.odpi.openmetadata.accessservices.assetmanager.rest.ConnectorTypeRequestBody requestBody)
    Create a new metadata element to represent the root of an asset.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createConnectorTypeFromTemplate(String serverName, String userId, String templateGUID, boolean assetManagerIsHome, org.odpi.openmetadata.accessservices.assetmanager.rest.TemplateRequestBody requestBody)
    Create a new metadata element to represent an asset using an existing metadata element as a template.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createEndpoint(String serverName, String userId, boolean assetManagerIsHome, org.odpi.openmetadata.accessservices.assetmanager.rest.EndpointRequestBody requestBody)
    Create a new metadata element to represent a network endpoint.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createEndpointFromTemplate(String serverName, String userId, String templateGUID, boolean assetManagerIsHome, org.odpi.openmetadata.accessservices.assetmanager.rest.TemplateRequestBody requestBody)
    Create a new metadata element to represent a network endpoint using an existing metadata element as a template.
    org.odpi.openmetadata.accessservices.assetmanager.rest.ConnectionsResponse
    findConnections(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.SearchStringRequestBody requestBody)
    Retrieve the list of connection metadata elements that contain the search string.
    org.odpi.openmetadata.accessservices.assetmanager.rest.ConnectorTypesResponse
    findConnectorTypes(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.SearchStringRequestBody requestBody)
    Retrieve the list of connector type metadata elements that contain the search string.
    org.odpi.openmetadata.accessservices.assetmanager.rest.EndpointsResponse
    findEndpoints(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.SearchStringRequestBody requestBody)
    Retrieve the list of network endpoint metadata elements that contain the search string.
    org.odpi.openmetadata.accessservices.assetmanager.rest.ConnectionResponse
    getConnectionByGUID(String serverName, String userId, String connectionGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
    Retrieve the connection metadata element with the supplied unique identifier.
    org.odpi.openmetadata.accessservices.assetmanager.rest.ConnectionsResponse
    getConnectionsByName(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.NameRequestBody requestBody)
    Retrieve the list of connection metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.accessservices.assetmanager.rest.ConnectionsResponse
    getConnectionsForAssetManager(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
    Retrieve the list of connections created on behalf of the named asset manager.
    org.odpi.openmetadata.accessservices.assetmanager.rest.ConnectorTypeResponse
    getConnectorTypeByGUID(String serverName, String userId, String connectorTypeGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
    Retrieve the connector type metadata element with the supplied unique identifier.
    org.odpi.openmetadata.accessservices.assetmanager.rest.ConnectorTypesResponse
    getConnectorTypesByName(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.NameRequestBody requestBody)
    Retrieve the list of connector type metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.accessservices.assetmanager.rest.ConnectorTypesResponse
    getConnectorTypesForAssetManager(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
    Retrieve the list of assets created on behalf of the named asset manager.
    org.odpi.openmetadata.accessservices.assetmanager.rest.EndpointResponse
    getEndpointByGUID(String serverName, String userId, String endpointGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
    Retrieve the network endpoint metadata element with the supplied unique identifier.
    org.odpi.openmetadata.accessservices.assetmanager.rest.EndpointsResponse
    getEndpointsByName(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.NameRequestBody requestBody)
    Retrieve the list of network endpoint metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.accessservices.assetmanager.rest.EndpointsResponse
    getEndpointsForAssetManager(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
    Retrieve the list of endpoints created on behalf of the named asset manager.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeConnection(String serverName, String userId, String connectionGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.UpdateRequestBody requestBody)
    Remove the metadata element representing a connection.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeConnectorType(String serverName, String userId, String connectorTypeGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.UpdateRequestBody requestBody)
    Remove the metadata element representing an asset.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeEndpoint(String serverName, String userId, String endpointGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.UpdateRequestBody requestBody)
    Remove the metadata element representing a network endpoint.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setupAssetConnection(String serverName, String userId, boolean assetManagerIsHome, String assetGUID, String connectionGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.RelationshipRequestBody requestBody)
    Create a relationship between an asset and its connection.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setupConnectorType(String serverName, String userId, String connectionGUID, String connectorTypeGUID, boolean assetManagerIsHome, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.RelationshipRequestBody requestBody)
    Create a relationship between a connection and a connector type.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setupEmbeddedConnection(String serverName, String userId, String connectionGUID, String embeddedConnectionGUID, boolean assetManagerIsHome, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.RelationshipRequestBody requestBody)
    Create a relationship between a virtual connection and an embedded connection.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setupEndpoint(String serverName, String userId, String connectionGUID, String endpointGUID, boolean assetManagerIsHome, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.RelationshipRequestBody requestBody)
    Create a relationship between a connection and an endpoint.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateConnection(String serverName, String userId, String connectionGUID, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ConnectionRequestBody requestBody)
    Update the metadata element representing an asset.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateConnectorType(String serverName, String userId, String connectorTypeGUID, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ConnectorTypeRequestBody requestBody)
    Update the metadata element representing an asset.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateEndpoint(String serverName, String userId, String endpointGUID, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EndpointRequestBody requestBody)
    Update the metadata element representing an asset.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ConnectionExchangeRESTServices

      public ConnectionExchangeRESTServices()
      Default constructor

  • Method Details

    • createConnection

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createConnection(String serverName, String userId, boolean assetManagerIsHome, org.odpi.openmetadata.accessservices.assetmanager.rest.ConnectionRequestBody requestBody)
      Create a new metadata element to represent the root of a connection.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      assetManagerIsHome - ensure that only the asset manager can update this connection
      requestBody - 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 org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createConnectionFromTemplate(String serverName, String userId, String templateGUID, boolean assetManagerIsHome, org.odpi.openmetadata.accessservices.assetmanager.rest.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 to
      userId - calling user
      templateGUID - unique identifier of the metadata element to copy
      assetManagerIsHome - ensure that only the asset manager can update this connection
      requestBody - 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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateConnection(String serverName, String userId, String connectionGUID, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ConnectionRequestBody requestBody)
      Update the metadata element representing an asset.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      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)?
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setupConnectorType(String serverName, String userId, String connectionGUID, String connectorTypeGUID, boolean assetManagerIsHome, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.RelationshipRequestBody requestBody)
      Create a relationship between a connection and a connector type.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      connectionGUID - unique identifier of the connection in the external asset manager
      connectorTypeGUID - unique identifier of the connector type in the external asset manager
      assetManagerIsHome - ensure that only the asset manager can update this relationship
      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)

    • clearConnectorType

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearConnectorType(String serverName, String userId, String connectionGUID, String connectorTypeGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
      Remove a relationship between a connection and a connector type.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      connectionGUID - unique identifier of the connection in the external asset manager
      connectorTypeGUID - unique identifier of the connector type in the external asset manager
      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)

    • setupEndpoint

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setupEndpoint(String serverName, String userId, String connectionGUID, String endpointGUID, boolean assetManagerIsHome, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.RelationshipRequestBody requestBody)
      Create a relationship between a connection and an endpoint.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      connectionGUID - unique identifier of the connection in the external asset manager
      endpointGUID - unique identifier of the endpoint in the external asset manager
      assetManagerIsHome - ensure that only the asset manager can update this relationship
      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)

    • clearEndpoint

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearEndpoint(String serverName, String userId, String connectionGUID, String endpointGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
      Remove a relationship between a connection and an endpoint.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      connectionGUID - unique identifier of the connection in the external asset manager
      endpointGUID - unique identifier of the endpoint in the external asset manager
      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)

    • setupEmbeddedConnection

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setupEmbeddedConnection(String serverName, String userId, String connectionGUID, String embeddedConnectionGUID, boolean assetManagerIsHome, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.RelationshipRequestBody requestBody)
      Create a relationship between a virtual connection and an embedded connection.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      connectionGUID - unique identifier of the virtual connection in the external asset manager
      embeddedConnectionGUID - unique identifier of the embedded connection in the external asset manager
      assetManagerIsHome - ensure that only the asset manager can update this relationship
      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)

    • clearEmbeddedConnection

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearEmbeddedConnection(String serverName, String userId, String connectionGUID, String embeddedConnectionGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
      Remove a relationship between a virtual connection and an embedded connection.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      connectionGUID - unique identifier of the virtual connection in the external asset manager
      embeddedConnectionGUID - unique identifier of the embedded connection in the external asset manager
      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)

    • setupAssetConnection

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setupAssetConnection(String serverName, String userId, boolean assetManagerIsHome, String assetGUID, String connectionGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.RelationshipRequestBody requestBody)
      Create a relationship between an asset and its connection.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      assetManagerIsHome - ensure that only the asset manager can update this relationship
      assetGUID - unique identifier of the asset
      connectionGUID - unique identifier of the connection
      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)

    • clearAssetConnection

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearAssetConnection(String serverName, String userId, String assetGUID, String connectionGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
      Remove a relationship between an asset and its connection.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      assetGUID - unique identifier of the asset
      connectionGUID - unique identifier of the connection
      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)

    • removeConnection

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeConnection(String serverName, String userId, String connectionGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.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 to
      userId - calling user
      connectionGUID - unique identifier of the metadata element to remove
      forLineage - 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 org.odpi.openmetadata.accessservices.assetmanager.rest.ConnectionsResponse findConnections(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.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 to
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - 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 org.odpi.openmetadata.accessservices.assetmanager.rest.ConnectionsResponse getConnectionsByName(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.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 to
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - 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 org.odpi.openmetadata.accessservices.assetmanager.rest.ConnectionsResponse getConnectionsForAssetManager(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.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 to
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - 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 org.odpi.openmetadata.accessservices.assetmanager.rest.ConnectionResponse getConnectionByGUID(String serverName, String userId, String connectionGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
      Retrieve the connection metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      connectionGUID - unique identifier of the requested metadata element
      forLineage - 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 org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createEndpoint(String serverName, String userId, boolean assetManagerIsHome, org.odpi.openmetadata.accessservices.assetmanager.rest.EndpointRequestBody requestBody)
      Create a new metadata element to represent a network endpoint.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      assetManagerIsHome - ensure that only the asset manager can update this endpoint
      requestBody - 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 org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createEndpointFromTemplate(String serverName, String userId, String templateGUID, boolean assetManagerIsHome, org.odpi.openmetadata.accessservices.assetmanager.rest.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 to
      userId - calling user
      assetManagerIsHome - ensure that only the asset manager can update this endpoint
      templateGUID - unique identifier of the metadata element to copy
      requestBody - 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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateEndpoint(String serverName, String userId, String endpointGUID, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EndpointRequestBody requestBody)
      Update the metadata element representing an asset.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      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)?
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeEndpoint(String serverName, String userId, String endpointGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.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 to
      userId - calling user
      endpointGUID - unique identifier of the metadata element to remove
      forLineage - 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 org.odpi.openmetadata.accessservices.assetmanager.rest.EndpointsResponse findEndpoints(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.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 to
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - 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 org.odpi.openmetadata.accessservices.assetmanager.rest.EndpointsResponse getEndpointsByName(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.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 to
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - 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 org.odpi.openmetadata.accessservices.assetmanager.rest.EndpointsResponse getEndpointsForAssetManager(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.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 to
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - 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 org.odpi.openmetadata.accessservices.assetmanager.rest.EndpointResponse getEndpointByGUID(String serverName, String userId, String endpointGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
      Retrieve the network endpoint metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      endpointGUID - unique identifier of the requested metadata element
      forLineage - 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 org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createConnectorType(String serverName, String userId, boolean assetManagerIsHome, org.odpi.openmetadata.accessservices.assetmanager.rest.ConnectorTypeRequestBody requestBody)
      Create a new metadata element to represent the root of an asset.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      assetManagerIsHome - ensure that only the asset manager can update this asset
      requestBody - 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 org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createConnectorTypeFromTemplate(String serverName, String userId, String templateGUID, boolean assetManagerIsHome, org.odpi.openmetadata.accessservices.assetmanager.rest.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 to
      userId - calling user
      templateGUID - unique identifier of the metadata element to copy
      assetManagerIsHome - ensure that only the asset manager can update this asset
      requestBody - 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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateConnectorType(String serverName, String userId, String connectorTypeGUID, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ConnectorTypeRequestBody requestBody)
      Update the metadata element representing an asset.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      connectorTypeGUID - unique identifier of the metadata element to update
      isMergeUpdate - 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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeConnectorType(String serverName, String userId, String connectorTypeGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.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 to
      userId - calling user
      connectorTypeGUID - unique identifier of the metadata element to remove
      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)

    • findConnectorTypes

      public org.odpi.openmetadata.accessservices.assetmanager.rest.ConnectorTypesResponse findConnectorTypes(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.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 to
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - 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 org.odpi.openmetadata.accessservices.assetmanager.rest.ConnectorTypesResponse getConnectorTypesByName(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.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 to
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - 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 org.odpi.openmetadata.accessservices.assetmanager.rest.ConnectorTypesResponse getConnectorTypesForAssetManager(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.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 to
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - 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 org.odpi.openmetadata.accessservices.assetmanager.rest.ConnectorTypeResponse getConnectorTypeByGUID(String serverName, String userId, String connectorTypeGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
      Retrieve the connector type metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      connectorTypeGUID - unique identifier of the requested metadata element
      forLineage - 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)