Index (Asset Consumer OMAS API 1.5 API)

A C D E F G H L N O P R S T U V

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 "Like" 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.
AssetConsumerAssetInterface - Interface in org.odpi.openmetadata.accessservices.assetconsumer.api: AssetConsumerAssetInterface supports queries to retrieve information about an asset.
AssetConsumerConnectorFactoryInterface - Interface in org.odpi.openmetadata.accessservices.assetconsumer.api: AssetConsumerConnectorFactoryInterface is used by applications and tools as a factory for Open Connector Framework (OCF) connectors.
AssetConsumerErrorCode - Enum 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 Services.
AssetConsumerEvent - Class in org.odpi.openmetadata.accessservices.assetconsumer.events: AssetConsumerEvent provides a common base for all events from the access service.
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 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.
AssetConsumerOMASAPIRequestBody - Class in org.odpi.openmetadata.accessservices.assetconsumer.rest: AssetConsumerOMASAPIRequestBody provides a common header for Asset Consumer OMAS request bodies for its REST API.
AssetConsumerOMASAPIRequestBody() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetConsumerOMASAPIRequestBody: Default constructor
AssetConsumerOMASAPIRequestBody(AssetConsumerOMASAPIRequestBody) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetConsumerOMASAPIRequestBody: Copy/clone constructor
AssetConsumerOutTopicClientConnector - Class in org.odpi.openmetadata.accessservices.assetconsumer.connectors: AssetConsumerOutTopicClientConnector is the java implementation of the the client side connector that receives events from the Asset Consumer OMAS's out topic
AssetConsumerOutTopicClientConnector() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.connectors.AssetConsumerOutTopicClientConnector
AssetConsumerTaggingInterface - Interface in org.odpi.openmetadata.accessservices.assetconsumer.api: AssetConsumerTaggingInterface support the management and use of informal tags, whether public or private.
AssetEvent - Class in org.odpi.openmetadata.accessservices.assetconsumer.events: AssetEvent describes the structure of the events emitted by the Asset Consumer OMAS that are about assets.
AssetEvent() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetEvent: Default constructor
AssetEvent(AssetEvent) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetEvent: Copy/clone constructor

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 a tag from the repository.

E

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEvent: Return comparison result based on the content of the properties.
equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetEvent: Return comparison result based on the content of the properties.
equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.UpdatedAssetEvent: Return comparison result based on the content of the properties.
equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody: Equals method that returns true if containing properties are the same.

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

getAsset() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetEvent: Return the asset description.
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.
getConnectionName() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody: Return the name of the connection used to create the connector making the log request.
getConnectorByConnection(String, Connection) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerConnectorFactoryInterface: Returns the connector corresponding to the supplied connection.
getConnectorByGUID(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerConnectorFactoryInterface: Returns the connector corresponding to the supplied connection GUID.
getConnectorByName(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerConnectorFactoryInterface: Returns the connector corresponding to the supplied connection name.
getConnectorForAsset(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerConnectorFactoryInterface: Returns the connector corresponding to the supplied asset GUID.
getConnectorInstanceId() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody: Return the instance id of the connector making the log record.
getConnectorType() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody: Return the type of connector making the log record.
getContextId() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody: Return the function name, or processId of the activity that the caller is performing.
getCreationTime() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.NewAssetEvent: Return the time that the asset was created.
getErrorMessageId() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerErrorCode: Returns the unique identifier for the error message.
getEventType() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEvent: Return the type of event.
getEventTypeCode() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType: Return the int identifier used for indexing based on the enum.
getEventTypeDescription() - Method in enum 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 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.AssetConsumerEvent: Return the event version id for this event structure.
getFormattedErrorMessage(String...) - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerErrorCode: Returns the error message with the placeholders filled out with the supplied parameters.
getHTTPErrorCode() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerErrorCode
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.
getMessage() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody: Return the actual log message.
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.
getOriginalAsset() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.UpdatedAssetEvent: Return the original values of the Asset before the update.
getSystemAction() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerErrorCode: Returns a description of the action taken by the system when the condition that caused this exception was detected.
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.
getUnformattedErrorMessage() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerErrorCode: Returns the error message with placeholders for specific details.
getUpdateTime() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.UpdatedAssetEvent: Return the time that the asset was updated.
getUserAction() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerErrorCode: Returns instructions of how to resolve the issue reported in this exception.

H

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEvent: Return hash code for this object
hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetEvent: Return hash code for this object
hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.UpdatedAssetEvent: Return hash code for this object
hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody: Return hash code for this object

L

LogRecordRequestBody - Class in org.odpi.openmetadata.accessservices.assetconsumer.rest: CommentRequestBody provides a structure for passing a comment as a request body over a REST API.
LogRecordRequestBody() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody: Default constructor
LogRecordRequestBody(LogRecordRequestBody) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody: Copy/clone constructor

N

NewAssetEvent - Class in org.odpi.openmetadata.accessservices.assetconsumer.events: NewAssetEvent describes the payload sent when a new Asset is added to the cohort metadata repository.
NewAssetEvent() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.events.NewAssetEvent: Default constructor
NewAssetEvent(NewAssetEvent) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.events.NewAssetEvent: Copy/clone constructor

O

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.connectors - package org.odpi.openmetadata.accessservices.assetconsumer.connectors
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.
org.odpi.openmetadata.accessservices.assetconsumer.rest - package org.odpi.openmetadata.accessservices.assetconsumer.rest

P

processEvent(AssetConsumerEvent) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerEventListener: Process an event that was published by the Asset Consumer OMAS.

R

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.
registerListener(String, AssetConsumerEventListener) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.connectors.AssetConsumerOutTopicClientConnector: 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 "Like" 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.

S

setAsset(Asset) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetEvent: Set up the asset description.
setConnectionName(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody: Set up the name of the connection used to create the connector making the log request.
setConnectorInstanceId(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody: Set up the instance id of the connector making the log record.
setConnectorType(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody: Set up the type of connector making the log record.
setContextId(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody: Set up the function name, or processId of the activity that the caller is performing.
setCreationTime(Date) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.NewAssetEvent: Set up the time that the asset was created.
setEventType(AssetConsumerEventType) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEvent: Set up the type of event.
setEventVersionId(long) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEvent: Set up the event version id for this event structure.
setMessage(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody: Set up the actual log message.
setOriginalAsset(Asset) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.UpdatedAssetEvent: Set up details of the original asset - if available.
setUpdateTime(Date) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.UpdatedAssetEvent: Set up the time that the asset was updated.

T

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEvent: JSON-style toString
toString() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType: JSON-style toString
toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetEvent: JSON-style toString
toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.NewAssetEvent: JSON-style toString
toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.UpdatedAssetEvent: JSON-style toString
toString() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerErrorCode: JSON-style toString
toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetConsumerOMASAPIRequestBody: JSON-like toString
toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody: JSON-style toString.

U

updateComment(String, String, String, CommentType, String, boolean) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerFeedbackInterface: Update an existing comment.
UpdatedAssetEvent - Class in org.odpi.openmetadata.accessservices.assetconsumer.events
UpdatedAssetEvent() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.events.UpdatedAssetEvent: Default constructor
UpdatedAssetEvent(UpdatedAssetEvent) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.events.UpdatedAssetEvent: Copy/clone constructor
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 org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerErrorCode: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerErrorCode: Returns an array containing the constants of this enum type, in the order they are declared.

A C D E F G H L N O P R S T U V