Index (Governance Action Framework (GAF) 1.4 API)

A E G H O S T V

A

addLogMessage(String) - Method in interface org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLog: Creates an Audit log record for the caller.
addLogMessage(String) - Method in class org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLogBase: Creates an Audit log record for the caller.
AuditLog - Interface in org.odpi.openmetadata.frameworks.governanceaction.logs: The AuditLog provides a standard interface for writing audit log record during real-time management and use of Assets.
AuditLogBase - Class in org.odpi.openmetadata.frameworks.governanceaction.logs: AuditLogBase is a simple audit log capability.
AuditLogBase(String, String) - Constructor for class org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLogBase: Default constructor

E

equals(Object) - Method in class org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceZone: Return comparison result based on the content of the properties.

G

GAFCheckedException - Exception in org.odpi.openmetadata.frameworks.governanceaction.ffdc: GAFCheckedException is the base class for checked exceptions for GAF components.
GAFCheckedException(int, String, String, String, String, String) - Constructor for exception org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFCheckedException: This is the typical constructor used for creating a GAFCheckedException.
GAFCheckedException(int, String, String, String, String, String, Throwable) - Constructor for exception org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFCheckedException: This is the constructor used for creating a GAFCheckedException that results from a previous error.
GAFErrorCode - Enum in org.odpi.openmetadata.frameworks.governanceaction.ffdc: The GAF error code is used to define first failure data capture (FFDC) for errors that occur when working with GAF Components.
GAFRuntimeException - Exception in org.odpi.openmetadata.frameworks.governanceaction.ffdc: The GAFRuntimeException is used for all runtime exceptions from GAF components.
GAFRuntimeException(int, String, String, String, String, String) - Constructor for exception org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFRuntimeException: This is the typical constructor used for creating a GAFRuntimeException.
GAFRuntimeException(int, String, String, String, String, String, Throwable) - Constructor for exception org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFRuntimeException: This is the constructor used for creating a GAFRuntimeException that results from a previous error.
getCallerId() - Method in interface org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLog: Return setting for the callerId.
getCallerId() - Method in class org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLogBase: Return setting for the callerId.
getCallerName() - Method in interface org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLog: Return setting for the callerName.
getCallerName() - Method in class org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLogBase: Return setting for the callerName.
getCallerType() - Method in interface org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLog: Return setting of the callerType.
getCallerType() - Method in class org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLogBase: Return setting of the callerType.
getContextId() - Method in interface org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLog: Returns the current context id associated with the Audit log.
getContextId() - Method in class org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLogBase: Returns the current context id associated with the Audit log.
getCriteria() - Method in class org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceZone: Return details of the criteria that Assets have when they are placed in these zones.
getDescription() - Method in class org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceZone: Return the description for the governance zone
getDisplayName() - Method in class org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceZone: Return the short name for the governance zone.
getErrorMessage() - Method in exception org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFCheckedException: A formatted short description of the cause of the condition that resulted in this GAFCheckedException.
getErrorMessage() - Method in exception org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFRuntimeException: A formatted short description of the cause of the condition that resulted in this GAFRuntimeException.
getErrorMessageId() - Method in enum org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFErrorCode: Returns the unique identifier for the error message.
getFormattedErrorMessage(String...) - Method in enum org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFErrorCode: Returns the error message with the placeholders filled out with the supplied parameters.
getHTTPErrorCode() - Method in enum org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFErrorCode
getProperty(String) - Method in interface org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLog: Retrieve a property stored in the Audit log.
getProperty(String) - Method in class org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLogBase: Retrieve a property stored in the Audit log.
getPropertyNames() - Method in interface org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLog: Request a list of property names stored in the Audit log.
getPropertyNames() - Method in class org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLogBase: Request a list of property names stored in the Audit log.
getReportedCaughtException() - Method in exception org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFCheckedException: An exception that was caught and wrapped by this exception.
getReportedCaughtException() - Method in exception org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFRuntimeException: An exception that was caught and wrapped by this exception.
getReportedHTTPCode() - Method in exception org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFCheckedException: Return the HTTP response code to use with this exception.
getReportedHTTPCode() - Method in exception org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFRuntimeException: Return the HTTP response code to use with this exception.
getReportedSystemAction() - Method in exception org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFCheckedException: A description of the action that the system took as a result of the error condition.
getReportedSystemAction() - Method in exception org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFRuntimeException: A description of the action that the system took as a result of the error condition.
getReportedUserAction() - Method in exception org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFCheckedException: A description of the action necessary to correct the error.
getReportedUserAction() - Method in exception org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFRuntimeException: A description of the action necessary to correct the error.
getReportingActionDescription() - Method in exception org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFCheckedException: The type of request that the class was performing when the condition occurred that resulted in this GAFCheckedException.
getReportingActionDescription() - Method in exception org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFRuntimeException: The type of request that the class was performing when the condition occurred that resulted in this GAFRuntimeException.
getReportingClassName() - Method in exception org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFCheckedException: The class that created the GAFCheckedException.
getReportingClassName() - Method in exception org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFRuntimeException: The class that created the GAFRuntimeException.
getResourceId() - Method in interface org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLog: Return setting for the resourceId.
getResourceId() - Method in class org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLogBase: Return setting for the resourceId.
getResourceName() - Method in interface org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLog: Return setting for the resourceName.
getResourceName() - Method in class org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLogBase: Return setting for the resourceName.
getResourceType() - Method in interface org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLog: Return setting of the resourceType.
getResourceType() - Method in class org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLogBase: Return setting of the resourceType.
getSystemAction() - Method in enum org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFErrorCode: Returns a description of the action taken by the system when the condition that caused this exception was detected.
getUnformattedErrorMessage() - Method in enum org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFErrorCode: Returns the error message with placeholders for specific details.
getUserAction() - Method in enum org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFErrorCode: Returns instructions of how to resolve the issue reported in this exception.
GovernanceZone - Class in org.odpi.openmetadata.frameworks.governanceaction.properties: GovernanceZone describes a governance zone which is a grouping of assets that are used for a specific purpose.
GovernanceZone() - Constructor for class org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceZone: Default constructor
GovernanceZone(GovernanceZone) - Constructor for class org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceZone: Copy/clone constructor

H

hashCode() - Method in class org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceZone: Return hash code for this object

O

org.odpi.openmetadata.frameworks.governanceaction.ffdc - package org.odpi.openmetadata.frameworks.governanceaction.ffdc
org.odpi.openmetadata.frameworks.governanceaction.logs - package org.odpi.openmetadata.frameworks.governanceaction.logs
org.odpi.openmetadata.frameworks.governanceaction.properties - package org.odpi.openmetadata.frameworks.governanceaction.properties

S

setCallerId(String) - Method in interface org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLog: Set up the identifier of the caller.
setCallerId(String) - Method in class org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLogBase: Set up the identifier of the caller.
setCallerName(String) - Method in interface org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLog: Set up a meaningful name for the caller.
setCallerName(String) - Method in class org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLogBase: Set up a meaningful name for the caller.
setCallerType(String) - Method in interface org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLog: Set up the type of caller.
setCallerType(String) - Method in class org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLogBase: Set up the type of caller.
setContextId(String) - Method in interface org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLog: Set a context id for the activity that the Audit log relates to.
setContextId(String) - Method in class org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLogBase: Set a context id for the activity that the Audit log relates to.
setCriteria(String) - Method in class org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceZone: Set up the details of the criteria that Assets have when they are placed in these zones.
setDescription(String) - Method in class org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceZone: Set up the description of the governance zone
setDisplayName(String) - Method in class org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceZone: Set up the short name for the governance zone.
setProperty(String, String) - Method in interface org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLog: Add or update a property in the Audit log.
setProperty(String, String) - Method in class org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLogBase: Add or update a property in the Audit log.
setResourceId(String) - Method in interface org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLog: Set up the identifier of the related resource, such as the connector to access data.
setResourceId(String) - Method in class org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLogBase: Set up the identifier of the related resource, such as the connector to access data.
setResourceName(String) - Method in interface org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLog: Set up a meaningful name for the related resource.
setResourceName(String) - Method in class org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLogBase: Set up a meaningful name for the related resource.
setResourceType(String) - Method in interface org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLog: Set up the type of the related resource.
setResourceType(String) - Method in class org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLogBase: Set up the type of the related resource.

T

toString() - Method in class org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceZone: JSON-style toString

V

valueOf(String) - Static method in enum org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFErrorCode: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFErrorCode: Returns an array containing the constants of this enum type, in the order they are declared.

A E G H O S T V