Index (asset-consumer-api 5.3 API)

A C D E F G H N O P R S T U V W
All Classes and Interfaces|All Packages

A

addCommentReply(String, String, String, CommentType, String, boolean) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerFeedbackInterface: Adds a comment to another comment.
addCommentToAsset(String, String, CommentType, String, boolean) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerFeedbackInterface: Adds a comment to the asset.
addLikeToAsset(String, String, boolean) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerFeedbackInterface: Adds a "LikeProperties" to the asset.
addLogMessageToAsset(String, String, String, String, String, String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerLoggingInterface: Creates an Audit log record about the asset.
addRatingToAsset(String, String, StarRating, String, boolean) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerFeedbackInterface: Adds a star rating and optional review text to the asset.
addTagToAsset(String, String, String, boolean) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface: Adds a tag (either private of public) to an asset.
addTagToElement(String, String, String, boolean) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface: Adds a tag (either private of public) to an element attached to an asset - such as schema element, glossary term, ...
ASSET_AUDIT_LOG - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerAuditCode: OMAS-ASSET-CONSUMER-0008 - Audit message for asset {0}: {1}
AssetConsumerAssetInterface - Interface in org.odpi.openmetadata.accessservices.assetconsumer.api: AssetConsumerAssetInterface supports queries to retrieve information about an asset.
AssetConsumerAuditCode - Enum Class in org.odpi.openmetadata.accessservices.assetconsumer.ffdc: The AssetConsumerAuditCode is used to define the message content for the OMRS Audit Log.
AssetConsumerErrorCode - Enum Class in org.odpi.openmetadata.accessservices.assetconsumer.ffdc: The AssetConsumerErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the Asset Consumer OMAS.
AssetConsumerEventInterface - Interface in org.odpi.openmetadata.accessservices.assetconsumer.api: AssetConsumerEventInterface defines how a client gets access to the events produced by the Asset Consumer OMAS
AssetConsumerEventListener - Class in org.odpi.openmetadata.accessservices.assetconsumer.api: AssetConsumerEventListener is the interface that a client implements to register to receive the events from the Asset Consumer OMAS.
AssetConsumerEventListener() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerEventListener
AssetConsumerEventType - Enum Class in org.odpi.openmetadata.accessservices.assetconsumer.events: AssetConsumerEventType describes the different types of events produced by the Asset Consumer OMAS.
AssetConsumerFeedbackInterface - Interface in org.odpi.openmetadata.accessservices.assetconsumer.api: AssetConsumerFeedbackInterface supports the ability to add and remove feedback for an asset.
AssetConsumerGlossaryInterface - Interface in org.odpi.openmetadata.accessservices.assetconsumer.api: AssetConsumerGlossaryInterface supports the lookup of the meaning of a glossary term.
AssetConsumerLoggingInterface - Interface in org.odpi.openmetadata.accessservices.assetconsumer.api: AssetConsumerLoggingInterface supports the ability to add log messages to the local server's audit log about an asset.
AssetConsumerOutTopicEvent - Class in org.odpi.openmetadata.accessservices.assetconsumer.events: AssetConsumerOutTopicEvent describes the structure of the events emitted by the Asset Consumer OMAS that are about assets.
AssetConsumerOutTopicEvent() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerOutTopicEvent: Default Constructor
AssetConsumerOutTopicEvent(AssetConsumerOutTopicEvent) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerOutTopicEvent: Copy/clone constructor
AssetConsumerTaggingInterface - Interface in org.odpi.openmetadata.accessservices.assetconsumer.api: AssetConsumerTaggingInterface support the management and use of informal tags, whether public or private.

C

createPrivateTag(String, String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface: Creates a new private informal tag and returns the unique identifier for it.
createPublicTag(String, String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface: Creates a new public informal tag and returns the unique identifier for it.

D

deleteTag(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface: Removes an informal tag from the repository.

E

ELEMENT_CLASSIFIED - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType: A classification has been added to an element.
ELEMENT_DECLASSIFIED - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType: A classification has been removed from an element.
ELEMENT_DELETED - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType: An element and all its anchored elements have been deleted.
ELEMENT_GUID_CHANGED - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType: An element's GUID has changed.
ELEMENT_HOME_CHANGED - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType: An element's home has changed.
ELEMENT_RECLASSIFIED - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType: The properties for a classification attached to an element have been updated.
ELEMENT_RESTORED - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType: An element that was once deleted has been restored.
ELEMENT_TYPE_CHANGED - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType: An element's type has changed.
ELEMENT_UPDATED - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType: An element's properties has been updated.
equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerOutTopicEvent: Compare the values of the supplied object with those stored in the current object.

F

findAssets(String, String, int, int) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerAssetInterface: Return a list of assets with the requested search string in their name, qualified name or description.
findMeanings(String, String, int, int) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerGlossaryInterface: Return the full definition (meaning) of the terms matching the supplied name.
findMyTags(String, String, int, int) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface: Return the list of the calling user's private tags containing the supplied string in either the name or description.
findTags(String, String, int, int) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface: Return the list of tags containing the supplied string in either the name or description.

G

getAssetForConnection(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerAssetInterface: Returns the unique identifier for the asset connected to the requested connection.
getAssetForConnectionName(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerAssetInterface: Returns the asset corresponding to the supplied connection name.
getAssetProperties(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerAssetInterface: Returns a comprehensive collection of properties about the requested asset.
getAssetsByMeaning(String, String, int, int) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerGlossaryInterface: Return the list of unique identifiers for assets that are linked to a specific (meaning) either directly or via fields in the schema.
getAssetsByName(String, String, int, int) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerAssetInterface: Return a list of assets with the requested name.
getAssetsByTag(String, String, int, int) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface: Return the list of unique identifiers for assets that are linked to a specific tag either directly, or via one of its schema elements.
getAssetsByToken(String, String, int, int) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerAssetInterface: Returns a list of assets that match the token which may be the GUID or the qualified name.
getClassificationName() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerOutTopicEvent: Return the name of the classification if the event relates to classifications.
getElementHeader() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerOutTopicEvent: Return details of the subject of the event.
getElementProperties() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerOutTopicEvent: Return the map of properties for the element provided with the event.
getEventTime() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerOutTopicEvent: Return the time that the element was updated.
getEventType() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerOutTopicEvent: Return the event type.
getEventTypeCode() - Method in enum class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType: Return the int identifier used for indexing based on the enum.
getEventTypeDescription() - Method in enum class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType: Return the default description for the enum value - used when natural resource bundle is not available.
getEventTypeName() - Method in enum class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType: Return the string name used for messages that include the enum.
getEventVersionId() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerOutTopicEvent: Return the event version id.
getMeaning(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerGlossaryInterface: Return the full definition (meaning) of a term using the unique identifier of the glossary term that contains the definition.
getMeaningByName(String, String, int, int) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerGlossaryInterface: Return the full definition (meaning) of the terms exactly matching the supplied name.
getMessageDefinition() - Method in enum class org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerAuditCode: Retrieve a message definition object for logging.
getMessageDefinition() - Method in enum class org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerErrorCode: Retrieve a message definition object for an exception.
getMessageDefinition(String...) - Method in enum class org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerAuditCode: Retrieve a message definition object for logging.
getMessageDefinition(String...) - Method in enum class org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerErrorCode: Retrieve a message definition object for an exception.
getMyTagsByName(String, String, int, int) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface: Return the list of the calling user's private tags exactly matching the supplied name.
getPreviousClassificationProperties() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerOutTopicEvent: Return the property map for the previous version of a classification's properties (used for reclassify events).
getPreviousElementHeader() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerOutTopicEvent: Return the previous version of the element's header (if the event is related to an element update).
getPreviousElementProperties() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerOutTopicEvent: Return the previous version of the element's properties (if the event is related to an element update).
getTag(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface: Return the tag for the supplied unique identifier (guid).
getTagsByName(String, String, int, int) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface: Return the list of tags exactly matching the supplied name.

H

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerOutTopicEvent: Create a hash code for this element type.

N

NEW_ELEMENT_CREATED - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType: A new element has been created.
NULL_CONNECTOR_RETURNED - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerErrorCode: OMAS-ASSET-CONSUMER-500-006 - The requested connector for connection named {0} has not been created.
NULL_LISTENER - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerErrorCode: OMAS-ASSET-CONSUMER-400-017 - A null topic listener has been passed by user {0} on method {1}

O

OMRS_NOT_INITIALIZED - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerErrorCode: OMAS-ASSET-CONSUMER-404-002 - The open metadata repository services are not initialized for the {0} operation
org.odpi.openmetadata.accessservices.assetconsumer.api - package org.odpi.openmetadata.accessservices.assetconsumer.api: The API package defines the Java interfaces supported by the Asset Consumer OMAS.
org.odpi.openmetadata.accessservices.assetconsumer.events - package org.odpi.openmetadata.accessservices.assetconsumer.events: This package defines the event payloads sent on the Asset Consumer OMAS's out topic.
org.odpi.openmetadata.accessservices.assetconsumer.ffdc - package org.odpi.openmetadata.accessservices.assetconsumer.ffdc: This package provides the first failure data capture support for the Asset Consumer OMAS module.
OUT_TOPIC_EVENT - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerAuditCode: OMAS-ASSET-CONSUMER-0012 - The Asset Consumer Open Metadata Access Service (OMAS) has sent event of type: {0}
OUT_TOPIC_FAILURE - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerAuditCode: OMAS-ASSET-CONSUMER-0018 - The Asset Consumer Open Metadata Access Service (OMAS) is unable to send an event on its out topic {0}; exception {1} returned error message: {2}

P

PROCESS_EVENT_EXCEPTION - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerAuditCode: OMAS-ASSET-CONSUMER-0014 - Event {0} could not be published due to {1} exception with message: {2}
processEvent(AssetConsumerOutTopicEvent) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerEventListener: Process an event that was published by the Asset Consumer OMAS.
PUBLISHING_SHUTDOWN - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerAuditCode: OMAS-ASSET-CONSUMER-0010 - The Asset Consumer Open Metadata Access Service (OMAS) is no longer publishing events to topic {0}
PUBLISHING_SHUTDOWN_ERROR - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerAuditCode: OMAS-ASSET-CONSUMER-0011 - The Asset Consumer Open Metadata Access Service (OMAS) caught an unexpected {0} exception whilst shutting down the out topic {1}.

R

REFRESH_ELEMENT_EVENT - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType: An element has been distributed around the cohort - could be for the first time.
registerListener(String, AssetConsumerEventListener) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerEventInterface: Register a listener object that will be passed each of the events published by the Asset Consumer OMAS.
removeComment(String, String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerFeedbackInterface: Removes a comment added to the asset by this user.
removeLikeFromAsset(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerFeedbackInterface: Removes a "LikeProperties" added to the asset by this user.
removeRatingFromAsset(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerFeedbackInterface: Removes of a review that was added to the asset by this user.
removeTagFromAsset(String, String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface: Removes a tag from the asset that was added by this user.
removeTagFromElement(String, String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface: Removes a tag from an element attached to an asset - such as schema element, glossary term, ...

S

SERVICE_INITIALIZED - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerAuditCode: OMAS-ASSET-CONSUMER-0003 - The Asset Consumer Open Metadata Access Service (OMAS) has initialized a new instance for server {0}
SERVICE_INITIALIZING - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerAuditCode: OMAS-ASSET-CONSUMER-0001 - The Asset Consumer Open Metadata Access Service (OMAS) is initializing a new server instance
SERVICE_INSTANCE_FAILURE - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerAuditCode: OMAS-ASSET-CONSUMER-0005 - The Asset Consumer Open Metadata Access Service (OMAS) is unable to initialize a new instance in server {0}; the {1} exception occurred with error message: {2}
SERVICE_PUBLISHING - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerAuditCode: OMAS-ASSET-CONSUMER-0002 - The Asset Consumer Open Metadata Access Service (OMAS) is ready to publish asset notifications to topic {0}
SERVICE_SHUTDOWN - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerAuditCode: OMAS-ASSET-CONSUMER-0004 - The Asset Consumer Open Metadata Access Service (OMAS) is shutting down its instance for server {0}
setClassificationName(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerOutTopicEvent: Set up the name of the classification if the event relates to classifications.
setElementHeader(ElementHeader) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerOutTopicEvent: Set up details of the subject of the event.
setElementProperties(Map<String, Object>) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerOutTopicEvent: Set up the map of properties for the element provided with the event.
setEventTime(Date) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerOutTopicEvent: Set up the time that the element was updated.
setEventType(AssetConsumerEventType) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerOutTopicEvent: Set up the event type.
setEventVersionId(long) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerOutTopicEvent: Set up the event version id.
setPreviousClassificationProperties(Map<String, Object>) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerOutTopicEvent: Set up the property map for the previous version of a classification's properties (used for reclassify events).
setPreviousElementHeader(ElementHeader) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerOutTopicEvent: Set up the previous version of the element's header (if the event is related to an element update).
setPreviousElementProperties(Map<String, Object>) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerOutTopicEvent: Set up the previous version of the element's properties (if the event is related to an element update).

T

toString() - Method in enum class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType: JSON-style toString
toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerOutTopicEvent: Standard toString method.
toString() - Method in enum class org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerAuditCode: JSON-style toString
toString() - Method in enum class org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerErrorCode: JSON-style toString

U

UNABLE_TO_SEND_EVENT - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerErrorCode: OMAS-ASSET-CONSUMER-500-004 - An unexpected exception occurred when sending an event through connector {0} to the Asset Consumer OMAS out topic.
UNKNOWN_EVENT - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType: An event that is not recognized by the local server.
updateComment(String, String, String, CommentType, String, boolean) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerFeedbackInterface: Update an existing comment.
updateTagDescription(String, String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface: Updates the description of an existing tag (either private or public).

V

valueOf(String) - Static method in enum class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerAuditCode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerErrorCode: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerAuditCode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerErrorCode: Returns an array containing the constants of this enum class, in the order they are declared.

W

WRONG_TYPE_OF_CONNECTOR - Enum constant in enum class org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerErrorCode: OMAS-ASSET-CONSUMER-500-007 - The connector generated from the connection named {0} return by the {1} service running in OMAG Server {2} at {3} is not of the required type.

A C D E F G H N O P R S T U V W
All Classes and Interfaces|All Packages