- addCommentReply(String, String, CommentType, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.AssetConsumerFeedbackInterface
-
Adds a comment to another comment.
- addCommentToAsset(String, String, CommentType, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.AssetConsumerFeedbackInterface
-
Adds a comment to the asset.
- addLikeToAsset(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.AssetConsumerFeedbackInterface
-
Adds a "Like" to the asset.
- addLogMessageToAsset(String, String, String, String, String, String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.AssetConsumerLoggingInterface
-
Creates an Audit log record about the asset.
- addReviewToAsset(String, String, StarRating, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.AssetConsumerFeedbackInterface
-
Adds a star rating and optional review text to the asset.
- addTagToAsset(String, String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.AssetConsumerTaggingInterface
-
Adds a tag (either private of public) to an asset.
- AmbiguousConnectionNameException - Exception in org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions
-
The AmbiguousConnectionNameException is thrown by OMAS when a connection name used (typically the
displayName) to request a connector instance is not unique and so the OMAS is not able to determine
which connection to use.
- AmbiguousConnectionNameException(int, String, String, String, String, String, String) - Constructor for exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AmbiguousConnectionNameException
-
This is the typical constructor used for creating an exception.
- AmbiguousConnectionNameException(int, String, String, String, String, String, Throwable, String) - Constructor for exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AmbiguousConnectionNameException
-
This is the constructor used for creating an exception that resulted from a previous error.
- Asset - Class in org.odpi.openmetadata.accessservices.assetconsumer.properties
-
Asset describes the basic properties of an Asset that include its name, type, description and owner.
- Asset() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.properties.Asset
-
Default constructor
- Asset(Asset) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.properties.Asset
-
Copy/clone constructor
- AssetConsumerAssetInterface - Interface in org.odpi.openmetadata.accessservices.assetconsumer
-
AssetConsumerAssetInterface supports queries to retrieve information about an asset.
- AssetConsumerCheckedExceptionBase - Exception in org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions
-
AssetConsumerCheckedExceptionBase provides a checked exception for reporting errors found when using
the Asset Consumer OMAS services.
- AssetConsumerCheckedExceptionBase(int, String, String, String, String, String) - Constructor for exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AssetConsumerCheckedExceptionBase
-
This is the typical constructor used for creating an exception.
- AssetConsumerCheckedExceptionBase(int, String, String, String, String, String, Throwable) - Constructor for exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AssetConsumerCheckedExceptionBase
-
This is the constructor used for creating an exception
that resulted from a previous error.
- AssetConsumerConnectorFactoryInterface - Interface in org.odpi.openmetadata.accessservices.assetconsumer
-
AssetConsumerConnectorFactoryInterface is used by applications and tools as a factory for Open
Connector Framework (OCF) connectors.
- AssetConsumerElementHeader - Class in org.odpi.openmetadata.accessservices.assetconsumer.properties
-
AssetConsumerElementHeader provides a common base for all instance information from the access service.
- AssetConsumerElementHeader() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetConsumerElementHeader
-
Default Constructor sets the properties to nulls
- AssetConsumerElementHeader(AssetConsumerElementHeader) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetConsumerElementHeader
-
Copy/clone constructor set values from the template
- 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.
- AssetConsumerEventHeader - Class in org.odpi.openmetadata.accessservices.assetconsumer.events
-
AssetConsumerEventHeader provides a common base for all events from the access service.
- 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
-
AssetConsumerFeedbackInterface supports the ability to add and remove feedback for an asset.
- AssetConsumerGlossaryInterface - Interface in org.odpi.openmetadata.accessservices.assetconsumer
-
AssetConsumerGlossaryInterface supports the lookup of the meaning of a glossary term.
- AssetConsumerLoggingInterface - Interface in org.odpi.openmetadata.accessservices.assetconsumer
-
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
- AssetConsumerOMASAPIResponse - Class in org.odpi.openmetadata.accessservices.assetconsumer.rest
-
AssetConsumerOMASAPIResponse provides a common header for Asset Consumer OMAS managed rest to its REST API.
- AssetConsumerOMASAPIResponse() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetConsumerOMASAPIResponse
-
Default constructor
- AssetConsumerOMASAPIResponse(AssetConsumerOMASAPIResponse) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetConsumerOMASAPIResponse
-
Copy/clone constructor
- AssetConsumerRuntimeException - Exception in org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions
-
AssetConsumerRuntimeException is used for all runtime exceptions generated by the Asset Consumer OMAS.
- AssetConsumerRuntimeException(int, String, String, String, String, String, Map<String, Object>) - Constructor for exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AssetConsumerRuntimeException
-
This is the typical constructor used for creating an exception.
- AssetConsumerRuntimeException(int, String, String, String, String, String, Throwable, Map<String, Object>) - Constructor for exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AssetConsumerRuntimeException
-
This is the constructor used for creating an exception when an unexpected error has been
caught.
- AssetConsumerTaggingInterface - Interface in org.odpi.openmetadata.accessservices.assetconsumer
-
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
- equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventHeader
-
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 exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AmbiguousConnectionNameException
-
Return comparison result based on the content of the properties.
- equals(Object) - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AssetConsumerCheckedExceptionBase
-
Return comparison result based on the content of the properties.
- equals(Object) - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AssetConsumerRuntimeException
-
Return comparison result based on the content of the properties.
- equals(Object) - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.InvalidParameterException
-
Return comparison result based on the content of the properties.
- equals(Object) - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.NoConnectedAssetException
-
Return comparison result based on the content of the properties.
- equals(Object) - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.UserNotAuthorizedException
-
Return comparison result based on the content of the properties.
- equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.Asset
-
Return comparison result based on the content of the properties.
- equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.GlossaryTerm
-
Return comparison result based on the content of the properties.
- equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableClassification
-
Compare the values of the supplied object with those stored in the current object.
- equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableHeader
-
Return comparison result based on the content of the properties.
- equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.Tag
-
Return comparison result based on the content of the properties.
- equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetConsumerOMASAPIResponse
-
Return comparison result based on the content of the properties.
- equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.CommentRequestBody
-
Equals method that returns true if containing properties are the same.
- equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.ConnectionResponse
-
Return comparison result based on the content of the properties.
- equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.GUIDResponse
-
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.
- equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.MeaningListResponse
-
Return comparison result based on the content of the properties.
- equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.MeaningResponse
-
Return comparison result based on the content of the properties.
- equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.NoteLogResponse
-
Return comparison result based on the content of the properties.
- equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.ReviewRequestBody
-
Equals method that returns true if containing properties are the same.
- equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagListResponse
-
Return comparison result based on the content of the properties.
- equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagRequestBody
-
Equals method that returns true if containing properties are the same.
- equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagResponse
-
Return comparison result based on the content of the properties.
- getAbbreviation() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.GlossaryTerm
-
Return the abbreviation for this term (or null).
- getAdditionalProperties() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableHeader
-
Return any additional properties associated with the asset.
- 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.AssetConsumerAssetInterface
-
Returns the unique identifier for the asset connected to the requested connection.
- getAssetForConnectionName(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.AssetConsumerAssetInterface
-
Returns the asset corresponding to the supplied connection name.
- getAssetProperties(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.AssetConsumerAssetInterface
-
Returns a comprehensive collection of properties about the requested asset.
- getClassificationName() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableClassification
-
Return the name of the classification
- getClassificationProperties() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableClassification
-
Return a collection of the additional stored properties for the classification.
- getClassifications() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableHeader
-
Return the list of active classifications for this asset.
- getCommentText() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.CommentRequestBody
-
Return the comment content.
- getCommentType() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.CommentRequestBody
-
Return the type of comment.
- getConnection() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.ConnectionResponse
-
Return the Connection object.
- getConnectionGUID() - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.NoConnectedAssetException
-
Return the GUID in error
- getConnectionName() - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AmbiguousConnectionNameException
-
Return the connection name in error.
- 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.AssetConsumerConnectorFactoryInterface
-
Returns the connector corresponding to the supplied connection.
- getConnectorByGUID(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.AssetConsumerConnectorFactoryInterface
-
Returns the connector corresponding to the supplied connection GUID.
- getConnectorByName(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.AssetConsumerConnectorFactoryInterface
-
Returns the connector corresponding to the supplied connection name.
- 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.
- getDescription() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.Asset
-
Return the description for this asset.
- getDescription() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.GlossaryTerm
-
Return the detailed description of the term's meaning.
- getDescription() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.Tag
-
Return the description of the tag's meaning.
- getDisplayName() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.Asset
-
Return the display name for this asset (normally a shortened form of the qualified name).
- getDisplayName() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.GlossaryTerm
-
Return the display name for this term (normally a shortened form of the qualified name).
- getErrorMessage() - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AssetConsumerCheckedExceptionBase
-
A formatted short description of the cause of the condition that resulted in this exception.
- getErrorMessage() - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AssetConsumerRuntimeException
-
A formatted short description of the cause of the condition that resulted in this exception.
- 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.AssetConsumerEventHeader
-
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.AssetConsumerEventHeader
-
Return the event version id for this event structure.
- getExamples() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.GlossaryTerm
-
Return example sentences that include this term.
- getExceptionClassName() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetConsumerOMASAPIResponse
-
Return the name of the Java class name to use to recreate the exception.
- getExceptionErrorMessage() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetConsumerOMASAPIResponse
-
Return the error message associated with the exception.
- getExceptionProperties() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetConsumerOMASAPIResponse
-
Return the additional properties stored by the exceptions.
- getExceptionSystemAction() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetConsumerOMASAPIResponse
-
Return the description of the action taken by the system as a result of the exception.
- getExceptionUserAction() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetConsumerOMASAPIResponse
-
Return the action that a user should take to resolve the problem.
- 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.
- getGlossaryTerm() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.MeaningResponse
-
Return the glossary term object.
- getGUID() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableHeader
-
Return the unique identifier for this asset.
- getGUID() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.Tag
-
Return the unique identifier for this tag.
- getGUID() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.GUIDResponse
-
Return the guid result.
- getHTTPErrorCode() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerErrorCode
-
- getLastChange() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.Asset
-
Return the description of the last change to the asset.
- getMeaning(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.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.AssetConsumerGlossaryInterface
-
Return the full definition (meaning) of the terms matching the supplied name.
- getMeanings() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.MeaningListResponse
-
Return the list of glossary terms in the response.
- getMessage() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody
-
Return the actual log message.
- getName() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.Tag
-
Return the name of the tag.
- getNoteLog() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.NoteLogResponse
-
Return the note log header.
- getNotes() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.NoteLogResponse
-
Return the notes in the note log.
- getOriginalAsset() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.UpdatedAssetEvent
-
Return the original values of the Asset before the update.
- getOriginId() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableHeader
-
Return the unique identifier of this metadata element's origin (also known as the home metadata collection id).
- getOriginLicense() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableHeader
-
Return the license for the metadata element set up by the origin.
- getOriginName() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableHeader
-
Set up the name of the metadata element's origin.
- getOriginType() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableHeader
-
Return the type of the metadata element's origin.
- getOwner() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.Asset
-
Return the owner for this asset.
- getParameterName() - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.InvalidParameterException
-
Return the invalid parameter's name, if known.
- getQualifiedName() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableHeader
-
Return the unique name for this asset.
- getRelatedHTTPCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetConsumerOMASAPIResponse
-
Return the HTTP Code to use if forwarding response to HTTP client.
- getRelatedProperties() - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AssetConsumerRuntimeException
-
Return any additional properties that were added to the exception to aid diagnosis.
- getReportedCaughtException() - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AssetConsumerCheckedExceptionBase
-
An exception that was caught and wrapped by this exception.
- getReportedCaughtException() - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AssetConsumerRuntimeException
-
An exception that was caught and wrapped by this exception.
- getReportedHTTPCode() - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AssetConsumerCheckedExceptionBase
-
Return the HTTP response code to use with this exception.
- getReportedHTTPCode() - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AssetConsumerRuntimeException
-
Return the HTTP response code to use with this exception.
- getReportedSystemAction() - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AssetConsumerCheckedExceptionBase
-
A description of the action that the system took as a result of the error condition.
- getReportedSystemAction() - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AssetConsumerRuntimeException
-
A description of the action that the system took as a result of the error condition.
- getReportedUserAction() - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AssetConsumerCheckedExceptionBase
-
A description of the action necessary to correct the error.
- getReportedUserAction() - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AssetConsumerRuntimeException
-
A description of the action necessary to correct the error.
- getReportingActionDescription() - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AssetConsumerCheckedExceptionBase
-
The type of request that the class was performing when the condition occurred that resulted in this
exception.
- getReportingActionDescription() - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AssetConsumerRuntimeException
-
The type of request that the class was performing when the condition occurred that resulted in this
exception.
- getReportingClassName() - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AssetConsumerCheckedExceptionBase
-
The class that created this exception.
- getReportingClassName() - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AssetConsumerRuntimeException
-
The class that created this exception.
- getReview() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.ReviewRequestBody
-
Return the attached review (if any)
- getStarRating() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.ReviewRequestBody
-
Return the star rating.
- getStartingFromElement() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.MeaningListResponse
-
Return the starting element number from the server side list that this response contains.
- getStartingFromElement() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.NoteLogResponse
-
Return the starting element number from the server side list that this response contains.
- getStartingFromElement() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagListResponse
-
Return the starting element number from the server side list that this response contains.
- getSummary() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.GlossaryTerm
-
Return a short summary of the meaning of the term - used for summary lists of terms.
- 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.AssetConsumerTaggingInterface
-
Return the tag for the supplied unique identifier (guid).
- getTag() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagResponse
-
Return the Tag object.
- getTagDescription() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagRequestBody
-
Return the description that accompanies the tag.
- getTagName() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagRequestBody
-
Return the name of the tag.
- getTags() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagListResponse
-
Return the list of glossary terms in the response.
- getTagsByName(String, String, int, int) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.AssetConsumerTaggingInterface
-
Return the list of tags matching the supplied name.
- getTypeDescription() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableHeader
-
Return the description for this Asset's type.
- getTypeName() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableHeader
-
Return the name for this Asset's type.
- 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.
- getUsage() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.GlossaryTerm
-
Return instructions for how and when this term should be used.
- getUserAction() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerErrorCode
-
Returns instructions of how to resolve the issue reported in this exception.
- getUserId() - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.UserNotAuthorizedException
-
Return the userId passed on the request.
- getZoneMembership() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.Asset
-
Return the names of the zones that this asset is a member of.
- GlossaryTerm - Class in org.odpi.openmetadata.accessservices.assetconsumer.properties
-
GlossaryTerm contains detailed descriptions about the meaning of a word or phrase.
- GlossaryTerm() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.properties.GlossaryTerm
-
Default Constructor
- GlossaryTerm(GlossaryTerm) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.properties.GlossaryTerm
-
Copy/clone Constructor - the resulting object.
- GUIDResponse - Class in org.odpi.openmetadata.accessservices.assetconsumer.rest
-
GUIDResponse is the response structure used on the OMAS REST API calls that return a
unique identifier (guid) object as a response.
- GUIDResponse() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.rest.GUIDResponse
-
Default constructor
- GUIDResponse(GUIDResponse) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.rest.GUIDResponse
-
Copy/clone constructor
- hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventHeader
-
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 exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AmbiguousConnectionNameException
-
Return hash code for this object
- hashCode() - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AssetConsumerCheckedExceptionBase
-
Return hash code for this object
- hashCode() - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.AssetConsumerRuntimeException
-
Return hash code for this object
- hashCode() - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.InvalidParameterException
-
Return hash code for this object
- hashCode() - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.NoConnectedAssetException
-
Return hash code for this object
- hashCode() - Method in exception org.odpi.openmetadata.accessservices.assetconsumer.ffdc.exceptions.UserNotAuthorizedException
-
Return hash code for this object
- hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.Asset
-
Return hash code for this object
- hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.GlossaryTerm
-
Return hash code for this object
- hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableClassification
-
Create a hash code for this element type.
- hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableHeader
-
Return hash code for this object
- hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.Tag
-
Return hash code for this object
- hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetConsumerOMASAPIResponse
-
Return hash code for this object
- hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.CommentRequestBody
-
Return hash code for this object
- hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.ConnectionResponse
-
Return hash code for this object
- hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.GUIDResponse
-
Return hash code for this object
- hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody
-
Return hash code for this object
- hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.MeaningListResponse
-
Return hash code for this object
- hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.MeaningResponse
-
Return hash code for this object
- hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.NoteLogResponse
-
Return hash code for this object
- hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.ReviewRequestBody
-
Return hash code for this object
- hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagListResponse
-
Return hash code for this object
- hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagRequestBody
-
Return hash code for this object
- hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagResponse
-
Return hash code for this object
- setAbbreviation(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.GlossaryTerm
-
Set up the abbreviation for this term (or null).
- setAdditionalProperties(Map<String, Object>) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableHeader
-
Set up any additional properties associated with the asset.
- setAsset(Asset) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetEvent
-
Set up the asset description.
- setClassificationName(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableClassification
-
Set up the name of the classification
- setClassificationProperties(Map<String, Object>) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableClassification
-
Set up a collection of the additional stored properties for the classification.
- setClassifications(List<ReferenceableClassification>) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableHeader
-
Set up the list of active classifications for this asset.
- setCommentText(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.CommentRequestBody
-
Set up the comment content.
- setCommentType(CommentType) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.CommentRequestBody
-
Set up the type of comment.
- setConnection(Connection) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.ConnectionResponse
-
Set up the Connection object.
- 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.
- setDescription(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.Asset
-
Set up the description for this asset.
- setDescription(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.GlossaryTerm
-
Set up the detailed description of the term's meaning.
- setDescription(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.Tag
-
Set up the description of the tag's meaning.
- setDisplayName(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.Asset
-
Set up the display name for this asset (normally a shortened form of the qualified name).
- setDisplayName(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.GlossaryTerm
-
Set up the display name for this term (normally a shortened form of the qualified name).
- setEventType(AssetConsumerEventType) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventHeader
-
Set up the type of event.
- setEventVersionId(long) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventHeader
-
Set up the event version id for this event structure.
- setExamples(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.GlossaryTerm
-
Set up example sentences that include this term.
- setExceptionClassName(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetConsumerOMASAPIResponse
-
Set up the name of the Java class name to use to recreate the exception.
- setExceptionErrorMessage(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetConsumerOMASAPIResponse
-
Set up the error message associated with the exception.
- setExceptionProperties(Map<String, Object>) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetConsumerOMASAPIResponse
-
Set up the additional properties stored by the exceptions.
- setExceptionSystemAction(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetConsumerOMASAPIResponse
-
Set up the description of the action taken by the system as a result of the exception.
- setExceptionUserAction(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetConsumerOMASAPIResponse
-
Set up the action that a user should take to resolve the problem.
- setGlossaryTerm(GlossaryTerm) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.MeaningResponse
-
Set up the glossary term object.
- setGUID(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableHeader
-
Set up the unique identifier for this asset.
- setGUID(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.Tag
-
Set up the unique identifier for this tag.
- setGUID(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.GUIDResponse
-
Set up the guid result.
- setLastChange(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.Asset
-
Set up the description of the last change to the asset.
- setMeanings(List<GlossaryTerm>) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.MeaningListResponse
-
Set up the list of glossary terms for the response.
- setMessage(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody
-
Set up the actual log message.
- setName(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.Tag
-
Set up the name of the tag.
- setNoteLog(NoteLog) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.NoteLogResponse
-
Set up the note log header
- setNotes(List<Note>) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.NoteLogResponse
-
Set up the list of notes from the note log.
- setOriginalAsset(Asset) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.UpdatedAssetEvent
-
Set up details of the original asset - if available.
- setOriginId(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableHeader
-
Set up the unique identifier of this metadata element's origin (also known as the home metadata collection id).
- setOriginLicense(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableHeader
-
Set up the license for the metadata element set up by the origin.
- setOriginName(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableHeader
-
Return the name of the metadata element's origin.
- setOriginType(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableHeader
-
Set up the type of the metadata element's origin.
- setOwner(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.Asset
-
Set up the owner for this asset.
- setQualifiedName(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableHeader
-
Set up the unique name for this asset.
- setRelatedHTTPCode(int) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetConsumerOMASAPIResponse
-
Set up the HTTP Code to use if forwarding response to HTTP client.
- setReview(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.ReviewRequestBody
-
Set up the attached review (if any)
- setStarRating(StarRating) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.ReviewRequestBody
-
Set up the star rating.
- setStartingFromElement(int) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.MeaningListResponse
-
Set up the starting element number from the server side list that this response contains.
- setStartingFromElement(int) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.NoteLogResponse
-
Set up the starting element number from the server side list that this response contains.
- setStartingFromElement(int) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagListResponse
-
Set up the starting element number from the server side list that this response contains.
- setSummary(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.GlossaryTerm
-
Set up a short summary of the meaning of the term - used for summary lists of terms.
- setTag(Tag) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagResponse
-
Set up the Tag object.
- setTagDescription(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagRequestBody
-
Set up the description that accompanies the tag.
- setTagName(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagRequestBody
-
Set up the name of the tag.
- setTags(List<Tag>) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagListResponse
-
Set up the list of glossary terms for the response.
- setTypeDescription(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableHeader
-
Set up the description for this Asset's type.
- setTypeName(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableHeader
-
Set up the name for this Asset's type.
- setUpdateTime(Date) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.UpdatedAssetEvent
-
Set up the time that the asset was updated.
- setUsage(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.GlossaryTerm
-
Set up instructions for how and when this term should be used.
- setZoneMembership(List<String>) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.Asset
-
Set up the names of the zones that this asset is a member of.