Class AssetConsumer

    • Constructor Summary

      Constructors 
      Constructor Description
      AssetConsumer​(java.lang.String serverName, java.lang.String serverPlatformURLRoot)
      Create a new client with no authentication embedded in the HTTP request.
      AssetConsumer​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password)
      Create a new client that passes userId and password in each HTTP request.
      AssetConsumer​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password, AuditLog auditLog)
      Create a new client that passes userId and password in each HTTP request.
      AssetConsumer​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, org.odpi.openmetadata.accessservices.assetconsumer.client.rest.AssetConsumerRESTClient restClient, int maxPageSize, AuditLog auditLog)
      Create a new client that is going to be used in an OMAG Server (view service or integration service typically).
      AssetConsumer​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, AuditLog auditLog)
      Create a new client with no authentication embedded in the HTTP request.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String addCommentReply​(java.lang.String userId, java.lang.String assetGUID, java.lang.String commentGUID, CommentType commentType, java.lang.String commentText, boolean isPublic)
      Adds a comment to another comment.
      java.lang.String addCommentToAsset​(java.lang.String userId, java.lang.String assetGUID, CommentType commentType, java.lang.String commentText, boolean isPublic)
      Adds a comment to the asset.
      void addLikeToAsset​(java.lang.String userId, java.lang.String assetGUID, boolean isPublic)
      Adds a "LikeProperties" to the asset.
      void addLogMessageToAsset​(java.lang.String userId, java.lang.String assetGUID, java.lang.String connectorInstanceId, java.lang.String connectionName, java.lang.String connectorType, java.lang.String contextId, java.lang.String message)
      Creates an Audit log record about the asset.
      void addRatingToAsset​(java.lang.String userId, java.lang.String assetGUID, StarRating starRating, java.lang.String review, boolean isPublic)
      Adds a star rating and optional review text to the asset.
      void addTagToAsset​(java.lang.String userId, java.lang.String assetGUID, java.lang.String tagGUID, boolean isPublic)
      Adds a tag (either private of public) to an asset.
      void addTagToElement​(java.lang.String userId, java.lang.String elementGUID, java.lang.String tagGUID, boolean isPublic)
      Adds a tag (either private of public) to an element attached to an asset - such as schema element, glossary term, ...
      java.lang.String createPrivateTag​(java.lang.String userId, java.lang.String tagName, java.lang.String tagDescription)
      Creates a new private informal tag and returns the unique identifier for it.
      java.lang.String createPublicTag​(java.lang.String userId, java.lang.String tagName, java.lang.String tagDescription)
      Creates a new public informal tag and returns the unique identifier for it.
      void deleteTag​(java.lang.String userId, java.lang.String tagGUID)
      Removes a tag from the repository.
      java.util.List<java.lang.String> findAssets​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Return a list of assets with the requested search string in their name, qualified name or description.
      java.util.List<org.odpi.openmetadata.accessservices.assetconsumer.elements.MeaningElement> findMeanings​(java.lang.String userId, java.lang.String term, int startFrom, int pageSize)
      Return the full definition (meaning) of the terms matching the supplied name.
      java.util.List<org.odpi.openmetadata.accessservices.assetconsumer.elements.InformalTagElement> findMyTags​(java.lang.String userId, java.lang.String tag, int startFrom, int pageSize)
      Return the list of the calling user's private tags containing the supplied string in either the name or description.
      java.util.List<org.odpi.openmetadata.accessservices.assetconsumer.elements.InformalTagElement> findTags​(java.lang.String userId, java.lang.String tag, int startFrom, int pageSize)
      Return the list of tags containing the supplied string in either the name or description.
      java.lang.String getAssetForConnection​(java.lang.String userId, java.lang.String connectionGUID)
      Returns the unique identifier for the asset connected to the requested connection.
      java.lang.String getAssetForConnectionName​(java.lang.String userId, java.lang.String connectionName)
      Returns the asset corresponding to the supplied connection name.
      AssetUniverse getAssetProperties​(java.lang.String userId, java.lang.String assetGUID)
      Returns a comprehensive collection of properties about the requested asset.
      java.util.List<java.lang.String> getAssetsByMeaning​(java.lang.String userId, java.lang.String termGUID, int startFrom, int pageSize)
      Return the list of unique identifiers for assets that are linked to a specific (meaning) either directly or via fields in the schema.
      java.util.List<java.lang.String> getAssetsByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Return a list of assets with the requested name.
      java.util.List<java.lang.String> getAssetsByTag​(java.lang.String userId, java.lang.String tagGUID, int startFrom, int pageSize)
      Return the list of unique identifiers for assets that are linked to a specific tag either directly, or via one of its schema elements.
      java.util.List<java.lang.String> getAssetsByToken​(java.lang.String userId, java.lang.String assetToken, int startFrom, int pageSize)
      Returns a list of assets that match the token.
      Connector getConnectorByConnection​(java.lang.String userId, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
      Returns the connector corresponding to the supplied connection.
      Connector getConnectorByGUID​(java.lang.String userId, java.lang.String connectionGUID)
      Returns the connector corresponding to the supplied connection GUID.
      Connector getConnectorByName​(java.lang.String userId, java.lang.String connectionName)
      Returns the connector corresponding to the supplied connection name.
      Connector getConnectorForAsset​(java.lang.String userId, java.lang.String assetGUID)
      Returns the connector corresponding to the supplied asset GUID.
      org.odpi.openmetadata.accessservices.assetconsumer.elements.MeaningElement getMeaning​(java.lang.String userId, java.lang.String guid)
      Return the full definition (meaning) of a term using the unique identifier of the glossary term that contains the definition.
      java.util.List<org.odpi.openmetadata.accessservices.assetconsumer.elements.MeaningElement> getMeaningByName​(java.lang.String userId, java.lang.String term, int startFrom, int pageSize)
      Return the full definition (meaning) of the terms exactly matching the supplied name.
      java.util.List<org.odpi.openmetadata.accessservices.assetconsumer.elements.InformalTagElement> getMyTagsByName​(java.lang.String userId, java.lang.String tag, int startFrom, int pageSize)
      Return the list of the calling user's private tags exactly matching the supplied name.
      org.odpi.openmetadata.accessservices.assetconsumer.elements.InformalTagElement getTag​(java.lang.String userId, java.lang.String guid)
      Return the tag for the supplied unique identifier (guid).
      java.util.List<org.odpi.openmetadata.accessservices.assetconsumer.elements.InformalTagElement> getTagsByName​(java.lang.String userId, java.lang.String tag, int startFrom, int pageSize)
      Return the list of tags exactly matching the supplied name.
      void removeComment​(java.lang.String userId, java.lang.String assetGUID, java.lang.String commentGUID)
      Removes a comment added to the asset by this user.
      void removeLikeFromAsset​(java.lang.String userId, java.lang.String assetGUID)
      Removes a "LikeProperties" added to the asset by this user.
      void removeRatingFromAsset​(java.lang.String userId, java.lang.String assetGUID)
      Removes of a review that was added to the asset by this user.
      void removeTagFromAsset​(java.lang.String userId, java.lang.String assetGUID, java.lang.String tagGUID)
      Removes a tag from the asset that was added by this user.
      void removeTagFromElement​(java.lang.String userId, java.lang.String elementGUID, java.lang.String tagGUID)
      Removes a tag from an element attached to an asset - such as schema element, glossary term, ...
      void updateComment​(java.lang.String userId, java.lang.String assetGUID, java.lang.String commentGUID, CommentType commentType, java.lang.String commentText, boolean isPublic)
      Update an existing comment.
      void updateTagDescription​(java.lang.String userId, java.lang.String tagGUID, java.lang.String tagDescription)
      Updates the description of an existing tag (either private or public).
      • Methods inherited from class java.lang.Object

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