Package org.odpi.openmetadata.accessservices.assetowner.api

Interface AssetOnboardingInterface

public interface AssetOnboardingInterface
AssetOnboardingInterface provides the client-side interface for an asset owner to set up the metadata about their asset. This includes defining its name, source and license.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    addAssetToCatalog(String userId, String typeName, String qualifiedName, String displayName, String description, Map<String,String> additionalProperties, Map<String,Object> extendedProperties)
    Add a simple asset description to the catalog.
    String
    addAssetToCatalog(String userId, org.odpi.openmetadata.frameworks.openmetadata.properties.assets.AssetProperties assetProperties)
    Add a comprehensive asset description to the catalog.
    String
    addAssetToCatalogUsingTemplate(String userId, String templateGUID, TemplateProperties templateProperties)
    Create a new metadata element to represent an asset using an existing asset as a template.
    String
    addCombinedSchemaToAsset(String userId, String assetGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaTypeProperties schemaType, List<org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaAttributeProperties> schemaAttributes)
    Stores the supplied schema details in the catalog and attaches it to the asset.
    void
    addConnectionToAsset(String userId, String assetGUID, String assetSummary, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
    Deprecated.
    String
    addSchemaAttribute(String userId, String assetGUID, String parentGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaAttributeProperties schemaAttribute)
    Adds an attribute to a complex schema type like a relational table, avro schema or a structured document.
    void
    addSchemaAttributes(String userId, String assetGUID, String parentGUID, List<org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaAttributeProperties> schemaAttributes)
    Adds attributes to a complex schema type like a relational table, avro schema or a structured document.
    String
    addSchemaTypeToAsset(String userId, String assetGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaTypeProperties schemaType)
    Stores the supplied schema type in the catalog and attaches it to the asset.
    void
    attachSchemaTypeToAsset(String userId, String assetGUID, String schemaTypeGUID)
    Links the supplied schema type directly to the asset.
    void
    clearAssetRelationship(String userId, String relationshipTypeName, String relationshipGUID)
    Remove the relationship between two elements.
    void
    clearSchemaElementAsCalculatedValue(String userId, String schemaElementGUID)
    Remove the calculated value designation from the schema element.
    void
    clearSchemaElementRelationship(String userId, String endOneGUID, String endTwoGUID, String relationshipTypeName)
    Remove a relationship between two schema elements.
    void
    clearSchemaTypeParent(String userId, String schemaTypeGUID, String parentElementGUID, String parentElementTypeName)
    Remove the relationship between a schema type and its parent data asset, process or port.
    String
    createAnchoredSchemaType(String userId, String anchorGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaTypeProperties schemaTypeProperties)
    Create a new metadata element to represent a schema type.
    String
    createSchemaAttributeFromTemplate(String userId, 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
    createSchemaType(String userId, org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaTypeProperties schemaTypeProperties)
    Create a new metadata element to represent a schema type.
    String
    createSchemaTypeFromTemplate(String userId, String templateGUID, TemplateProperties templateProperties)
    Create a new metadata element to represent a schema type using an existing metadata element as a template.
    void
    deleteAssetSchemaType(String userId, String assetGUID)
    Detaches and deletes an asset's schema.
    String
    detachSchemaTypeFromAsset(String userId, String assetGUID)
    Unlinks the schema from the asset but does not delete it.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.SchemaAttributeElement>
    findSchemaAttributes(String userId, String searchString, int startFrom, int pageSize)
    Retrieve the list of schema attribute metadata elements that contain the search string.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.SchemaTypeElement>
    findSchemaType(String userId, String searchString, int startFrom, int pageSize)
    Retrieve the list of schema type metadata elements that contain the search string.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.SchemaAttributeElement>
    getNestedSchemaAttributes(String userId, String parentSchemaElementGUID, int startFrom, int pageSize)
    Retrieve the list of schema attributes associated with a schema element.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.SchemaAttributeElement
    getSchemaAttributeByGUID(String userId, String schemaAttributeGUID)
    Retrieve the schema attribute metadata element with the supplied unique identifier.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.SchemaAttributeElement>
    getSchemaAttributesByName(String userId, String name, int startFrom, int pageSize)
    Retrieve the list of schema attribute metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.SchemaTypeElement
    getSchemaTypeByGUID(String userId, String schemaTypeGUID)
    Retrieve the schema type metadata element with the supplied unique identifier.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.SchemaTypeElement>
    getSchemaTypeByName(String userId, String name, int startFrom, int pageSize)
    Retrieve the list of schema type metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.SchemaTypeElement
    getSchemaTypeForElement(String userId, String parentElementGUID, String parentElementTypeName)
    Return the schema type associated with a specific open metadata element (data asset, process or port).
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader
    getSchemaTypeParent(String userId, String schemaTypeGUID)
    Retrieve the header of the metadata element connected to a schema type.
    void
    removeSchemaAttribute(String userId, String schemaAttributeGUID)
    Remove the metadata element representing a schema attribute.
    void
    removeSchemaType(String userId, String schemaTypeGUID)
    Remove the metadata element representing a schema type.
    void
    setSchemaElementAsCalculatedValue(String userId, String schemaElementGUID, String formula)
    Classify the schema type (or attribute if type is embedded) to indicate that it is a calculated value.
    String
    setupRelatedAsset(String userId, String relationshipTypeName, String fromAssetGUID, String toAssetGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipProperties relationshipProperties)
    Link two asset together.
    void
    setupSchemaElementRelationship(String userId, String endOneGUID, String endTwoGUID, String relationshipTypeName, org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipProperties properties)
    Create a relationship between two schema elements.
    void
    setupSchemaTypeParent(String userId, String schemaTypeGUID, String parentElementGUID, String parentElementTypeName, org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipProperties properties)
    Connect a schema type to a data asset, process or port.
    void
    updateAsset(String userId, String assetGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.assets.AssetProperties assetProperties)
    Update the metadata element representing an asset.
    void
    updateAssetRelationship(String userId, String relationshipTypeName, String relationshipGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipProperties relationshipProperties)
    Update relationship between two elements.
    void
    updateSchemaAttribute(String userId, String schemaAttributeGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaAttributeProperties schemaAttributeProperties)
    Update the properties of the metadata element representing a schema attribute.
    void
    updateSchemaType(String userId, String schemaTypeGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaTypeProperties schemaTypeProperties)
    Update the metadata element representing a schema type.

  • Method Details

    • addAssetToCatalog

      String addAssetToCatalog(String userId, String typeName, String qualifiedName, String displayName, String description, Map<String,String> additionalProperties, Map<String,Object> extendedProperties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Add a simple asset description to the catalog.
      Parameters:
      userId - calling user (assumed to be the owner)
      typeName - specific type of the asset - this must match a defined subtype
      qualifiedName - unique name for the asset in the catalog
      displayName - display name for the asset in the catalog
      description - description of the asset in the catalog
      additionalProperties - additional properties added by the caller
      extendedProperties - properties from the subtypes
      Returns:
      unique identifier (guid) of the asset
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - full path or userId is null
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem

    • addAssetToCatalog

      String addAssetToCatalog(String userId, org.odpi.openmetadata.frameworks.openmetadata.properties.assets.AssetProperties assetProperties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Add a comprehensive asset description to the catalog.
      Parameters:
      userId - calling user
      assetProperties - properties for the asset
      Returns:
      unique identifier (guid) of the asset
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - full path or userId is null
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem

    • addAssetToCatalogUsingTemplate

      String addAssetToCatalogUsingTemplate(String userId, String templateGUID, TemplateProperties templateProperties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Create a new metadata element to represent an asset using an existing asset as a template.
      Parameters:
      userId - calling user
      templateGUID - unique identifier of the metadata element to copy
      templateProperties - properties that override the template
      Returns:
      unique identifier of the new metadata element
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateAsset

      void updateAsset(String userId, String assetGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.assets.AssetProperties assetProperties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Update the metadata element representing an asset.
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the metadata element to update
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      assetProperties - new properties for this element
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setupRelatedAsset

      String setupRelatedAsset(String userId, String relationshipTypeName, String fromAssetGUID, String toAssetGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipProperties relationshipProperties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Link two asset together. Use information from the relationship type definition to ensure the fromAssetGUID and toAssetGUID are the right way around.
      Parameters:
      userId - calling user
      relationshipTypeName - type name of relationship to create
      fromAssetGUID - unique identifier of the asset at end 1 of the relationship
      toAssetGUID - unique identifier of the asset at end 2 of the relationship
      relationshipProperties - unique identifier for this relationship
      Returns:
      unique identifier of the relationship
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateAssetRelationship

      void updateAssetRelationship(String userId, String relationshipTypeName, String relationshipGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipProperties relationshipProperties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Update relationship between two elements.
      Parameters:
      userId - calling user
      relationshipTypeName - type name of relationship to update
      relationshipGUID - unique identifier of the relationship
      relationshipProperties - description and/or purpose of the relationship
      isMergeUpdate - should the new properties be merged with the existing properties, or replace them entirely
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearAssetRelationship

      void clearAssetRelationship(String userId, String relationshipTypeName, String relationshipGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Remove the relationship between two elements.
      Parameters:
      userId - calling user
      relationshipTypeName - type name of relationship to delete
      relationshipGUID - unique identifier of the relationship
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • addCombinedSchemaToAsset

      String addCombinedSchemaToAsset(String userId, String assetGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaTypeProperties schemaType, List<org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaAttributeProperties> schemaAttributes) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Stores the supplied schema details in the catalog and attaches it to the asset. If another schema is currently attached to the asset, it is unlinked and deleted. If more attributes need to be added in addition to the ones supplied then this can be done with addSchemaAttributesToSchemaType().
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset that the schema is to be attached to
      schemaType - schema type to create and attach directly to the asset.
      schemaAttributes - optional schema attributes.
      Returns:
      guid of the schema type or
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - full path or userId is null
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem

    • addSchemaTypeToAsset

      String addSchemaTypeToAsset(String userId, String assetGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaTypeProperties schemaType) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Stores the supplied schema type in the catalog and attaches it to the asset. If another schema is currently attached to the asset, it is unlinked and deleted.
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset that the schema is to be attached to
      schemaType - schema type to create and attach directly to the asset.
      Returns:
      guid of the new schema type or
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - full path or userId is null
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem

    • attachSchemaTypeToAsset

      void attachSchemaTypeToAsset(String userId, String assetGUID, String schemaTypeGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Links the supplied schema type directly to the asset. If this schema is either not found, or already attached to an asset, then an error occurs. If another schema is currently attached to the asset, it is unlinked and deleted.
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset that the schema is to be attached to
      schemaTypeGUID - unique identifier of the schema type to attach
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - full path or userId is null
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem

    • detachSchemaTypeFromAsset

      String detachSchemaTypeFromAsset(String userId, String assetGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Unlinks the schema from the asset but does not delete it. This means it can be reattached to a different asset.
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset that the schema is to be attached to
      Returns:
      guid of detached schema type
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - full path or userId is null
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem

    • deleteAssetSchemaType

      void deleteAssetSchemaType(String userId, String assetGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Detaches and deletes an asset's schema.
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset that the schema is to be attached to
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - full path or userId is null
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem

    • createSchemaType

      String createSchemaType(String userId, org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaTypeProperties schemaTypeProperties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Create a new metadata element to represent a schema type.
      Parameters:
      userId - calling user
      schemaTypeProperties - properties about the schema type to store
      Returns:
      unique identifier of the new schema type
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createAnchoredSchemaType

      String createAnchoredSchemaType(String userId, String anchorGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaTypeProperties schemaTypeProperties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Create a new metadata element to represent a schema type.
      Parameters:
      userId - calling user
      anchorGUID - unique identifier of the intended anchor of the schema type
      schemaTypeProperties - properties about the schema type to store
      Returns:
      unique identifier of the new schema type
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createSchemaTypeFromTemplate

      String createSchemaTypeFromTemplate(String userId, String templateGUID, TemplateProperties templateProperties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Create a new metadata element to represent a schema type using an existing metadata element as a template.
      Parameters:
      userId - calling user
      templateGUID - unique identifier of the metadata element to copy
      templateProperties - properties that override the template
      Returns:
      unique identifier of the new schema type
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateSchemaType

      void updateSchemaType(String userId, String schemaTypeGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaTypeProperties schemaTypeProperties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Update the metadata element representing a schema type.
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setupSchemaTypeParent

      void setupSchemaTypeParent(String userId, String schemaTypeGUID, String parentElementGUID, String parentElementTypeName, org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipProperties properties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Connect a schema type to a data asset, process or port.
      Parameters:
      userId - calling user
      schemaTypeGUID - unique identifier of the schema type to connect
      parentElementGUID - unique identifier of the open metadata element that this schema type is to be connected to
      parentElementTypeName - unique type name of the open metadata element that this schema type is to be connected to
      properties - properties for the relationship
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearSchemaTypeParent

      void clearSchemaTypeParent(String userId, String schemaTypeGUID, String parentElementGUID, String parentElementTypeName) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Remove the relationship between a schema type and its parent data asset, process or port.
      Parameters:
      userId - calling user
      schemaTypeGUID - unique identifier of the schema type to connect
      parentElementGUID - unique identifier of the open metadata element that this schema type is to be connected to
      parentElementTypeName - unique type name of the open metadata element that this schema type is to be connected to
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setupSchemaElementRelationship

      void setupSchemaElementRelationship(String userId, String endOneGUID, String endTwoGUID, String relationshipTypeName, org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipProperties properties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Create a relationship between two schema elements. The name of the desired relationship, and any properties (including effectivity dates) are passed on the API.
      Parameters:
      userId - calling user
      endOneGUID - unique identifier of the schema element at end one of the relationship
      endTwoGUID - unique identifier of the schema element at end two of the relationship
      relationshipTypeName - type of the relationship to create
      properties - relationship properties
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearSchemaElementRelationship

      void clearSchemaElementRelationship(String userId, String endOneGUID, String endTwoGUID, String relationshipTypeName) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Remove a relationship between two schema elements. The name of the desired relationship is passed on the API.
      Parameters:
      userId - calling user
      endOneGUID - unique identifier of the schema element at end one of the relationship
      endTwoGUID - unique identifier of the schema element at end two of the relationship
      relationshipTypeName - type of the relationship to delete
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • removeSchemaType

      void removeSchemaType(String userId, String schemaTypeGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Remove the metadata element representing a schema type.
      Parameters:
      userId - calling user
      schemaTypeGUID - unique identifier of the metadata element to remove
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • findSchemaType

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.SchemaTypeElement> findSchemaType(String userId, String searchString, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve the list of schema type metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getSchemaTypeForElement

      org.odpi.openmetadata.frameworks.openmetadata.metadataelements.SchemaTypeElement getSchemaTypeForElement(String userId, String parentElementGUID, String parentElementTypeName) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Return the schema type associated with a specific open metadata element (data asset, process or port).
      Parameters:
      userId - calling user
      parentElementGUID - unique identifier of the open metadata element that this schema type is to be connected to
      parentElementTypeName - unique type name of the open metadata element that this schema type is to be connected to
      Returns:
      metadata element describing the schema type associated with the requested parent element
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getSchemaTypeByName

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.SchemaTypeElement> getSchemaTypeByName(String userId, String name, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.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:
      userId - calling user
      name - name to search for
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getSchemaTypeByGUID

      org.odpi.openmetadata.frameworks.openmetadata.metadataelements.SchemaTypeElement getSchemaTypeByGUID(String userId, String schemaTypeGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve the schema type metadata element with the supplied unique identifier.
      Parameters:
      userId - calling user
      schemaTypeGUID - unique identifier of the requested metadata element
      Returns:
      requested metadata element
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getSchemaTypeParent

      org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader getSchemaTypeParent(String userId, String schemaTypeGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve the header of the metadata element connected to a schema type.
      Parameters:
      userId - calling user
      schemaTypeGUID - unique identifier of the requested metadata element
      Returns:
      header for parent element (data asset, process, port)
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • addSchemaAttributes

      void addSchemaAttributes(String userId, String assetGUID, String parentGUID, List<org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaAttributeProperties> schemaAttributes) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Adds attributes to a complex schema type like a relational table, avro schema or a structured document. This method can be called repeatedly to add many attributes to a schema.
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset that the schema is to be attached to
      parentGUID - unique identifier of the schema element to anchor these attributes to.
      schemaAttributes - list of schema attribute objects.
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - full path or userId is null
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem

    • addSchemaAttribute

      String addSchemaAttribute(String userId, String assetGUID, String parentGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaAttributeProperties schemaAttribute) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Adds an attribute to a complex schema type like a relational table, avro schema or a structured document. This method can be called repeatedly to add many attributes to a schema. Since the GUID is returned, it is possible to add nested schema attributes to another schema attribute.
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset that the schema is to be attached to
      parentGUID - unique identifier of the schema element to anchor these attributes to.
      schemaAttribute - schema attribute object to add to the schema.
      Returns:
      list of unique identifiers for the new schema attributes returned in the same order as the supplied attribute or
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - full path or userId is null
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem

    • createSchemaAttributeFromTemplate

      String createSchemaAttributeFromTemplate(String userId, String schemaElementGUID, String templateGUID, TemplateProperties templateProperties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Create a new metadata element to represent a schema attribute using an existing metadata element as a template.
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateSchemaAttribute

      void updateSchemaAttribute(String userId, String schemaAttributeGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaAttributeProperties schemaAttributeProperties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Update the properties of the metadata element representing a schema attribute.
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setSchemaElementAsCalculatedValue

      void setSchemaElementAsCalculatedValue(String userId, String schemaElementGUID, String formula) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Classify the schema type (or attribute if type is embedded) to indicate that it is a calculated value.
      Parameters:
      userId - calling user
      schemaElementGUID - unique identifier of the metadata element to update
      formula - description of the logic that maps data values to
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearSchemaElementAsCalculatedValue

      void clearSchemaElementAsCalculatedValue(String userId, String schemaElementGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Remove the calculated value designation from the schema element.
      Parameters:
      userId - calling user
      schemaElementGUID - unique identifier of the metadata element to update
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • removeSchemaAttribute

      void removeSchemaAttribute(String userId, String schemaAttributeGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Remove the metadata element representing a schema attribute.
      Parameters:
      userId - calling user
      schemaAttributeGUID - unique identifier of the metadata element to remove
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • findSchemaAttributes

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.SchemaAttributeElement> findSchemaAttributes(String userId, String searchString, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve the list of schema attribute metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getNestedSchemaAttributes

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.SchemaAttributeElement> getNestedSchemaAttributes(String userId, String parentSchemaElementGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve the list of schema attributes associated with a schema element.
      Parameters:
      userId - calling user
      parentSchemaElementGUID - unique identifier of the schema element of interest
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of associated metadata elements
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getSchemaAttributesByName

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.SchemaAttributeElement> getSchemaAttributesByName(String userId, String name, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.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:
      userId - calling user
      name - name to search for
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getSchemaAttributeByGUID

      org.odpi.openmetadata.frameworks.openmetadata.metadataelements.SchemaAttributeElement getSchemaAttributeByGUID(String userId, String schemaAttributeGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve the schema attribute metadata element with the supplied unique identifier.
      Parameters:
      userId - calling user
      schemaAttributeGUID - unique identifier of the requested metadata element
      Returns:
      matching metadata element
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • addConnectionToAsset

      @Deprecated void addConnectionToAsset(String userId, String assetGUID, String assetSummary, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Deprecated.
      Adds a connection to an asset. Assets can have multiple connections attached.
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset to attach the connection to
      assetSummary - summary of the asset that is stored in the relationship between the asset and the connection.
      connection - connection object. If the connection is already stored (matching guid) then the existing connection is used.
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - full path or userId is null
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem