Package org.odpi.openmetadata.adapters.connectors.unitycatalog.ffdc

Enum Class UCAuditCode

java.lang.Object
java.lang.Enum<UCAuditCode>
org.odpi.openmetadata.adapters.connectors.unitycatalog.ffdc.UCAuditCode
All Implemented Interfaces:
Serializable, Comparable<UCAuditCode>, Constable, AuditLogMessageSet
public enum UCAuditCode extends Enum<UCAuditCode> implements AuditLogMessageSet
The UCAuditCode is used to define the message content for the OMRS Audit Log. The 5 fields in the enum are:
  • Log Message Identifier - to uniquely identify the message
  • Severity - is this an event, decision, action, error or exception
  • Log Message Text - includes placeholder to allow additional values to be captured
  • Additional Information - further parameters and data relating to the audit message (optional)
  • SystemAction - describes the result of the situation
  • UserAction - describes how a user should correct the situation

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CATALOG_UPDATE
    UNITY-CATALOG-CONNECTOR-0011 - The {0} Connector has detected a change in the open metadata that controls the definition of catalog {1} but is unable to update the catalog in Unity Catalog (UC) at {2}
    CATALOGED_DATABASE
    UNITY-CATALOG-CONNECTOR-0003 - The {0} integration connector has catalogued data set {1} ({2})
    CLIENT_SIDE_REST_API_ERROR
    UNITY-CATALOG-CONNECTOR-0005 - A client-side exception was received from API call {0} to server {1} at {2}.
    FRIENDSHIP_GUID
    UNITY-CATALOG-CONNECTOR-0007 - The {0} OSS Unity Catalog Connector has been supplied with a friendship connector with GUID {1}
    FUNCTION_UPDATE
    UNITY-CATALOG-CONNECTOR-0015 - The {0} Connector has detected a change in the open metadata element {1} that controls the definition of function {2} but is unable to update the function in Unity Catalog (UC) at {3}
    IDENTITY_MISMATCH
    UNITY-CATALOG-CONNECTOR-0010 - The {0} Connector has detected a change in the identity of element {1}.
    IGNORING_ENDPOINT
    UNITY-CATALOG-CONNECTOR-0008 - The {0} OSS Unity Inside Catalog Synchronizer Connector only works with catalog targets
    INVALID_TECHNOLOGY_TYPE
    UNITY-CATALOG-CONNECTOR-0021 - The {0} governance action service has been passed a technology type of {1} which is not supported
    MISSING_METHOD
    UNITY-CATALOG-CONNECTOR-0017 - The {0} Connector has called method {1} that is not implemented and so is not able to synchronize element {2} with the Unity Catalog (UC) at {3}
    MISSING_PLACEHOLDER_VALUES
    UNITY-CATALOG-CONNECTOR-0022 - The {0} governance action service has not been passed all the placeholder variables needed to create an element for technology type {1}; the missing placeholder variables are: {2}
    NEW_CATALOG_TARGET
    UNITY-CATALOG-CONNECTOR-0009 - The {0} Connector has added a catalog target relationship {1} from friendship connector {2} to Unity Catalog Server Asset {3} for Unity Catalog (UC) {4}
    NEW_ELEMENT_CREATED
    UNITY-CATALOG-CONNECTOR-0019 - The {0} governance action service has created a new {1} element called {2} ({3})
    NO_CATALOGS
    UNITY-CATALOG-CONNECTOR-0002 - The {0} connector is unable to retrieve details of any catalogs for Unity Catalog Server {1} ({2})
    NO_TECHNOLOGY_TYPE
    UNITY-CATALOG-CONNECTOR-0020 - The {0} governance action service has no technology type to work with
    SCHEMA_UPDATE
    UNITY-CATALOG-CONNECTOR-0012 - The {0} Connector has detected a change in the open metadata that controls the definition of schema {1} but is unable to update the schema in Unity Catalog (UC) at {2}
    SKIPPING_DATABASE
    UNITY-CATALOG-CONNECTOR-0004 - he {0} integration connector is skipping data set {1} ({2}) because it is already catalogued
    TABLE_UPDATE
    UNITY-CATALOG-CONNECTOR-0013 - The {0} Connector has detected a change in the open metadata that controls the definition of table {1} but is unable to update the table in Unity Catalog (UC) at {2}
    UC_ELEMENT_DELETE
    UNITY-CATALOG-CONNECTOR-0016 - The {0} Connector has detected that the open metadata element that controls the definition of element {1} in Unity Catalog (UC) at {2} has been deleted
    UNABLE_TO_REGISTER_LISTENER
    UNITY-CATALOG-CONNECTOR-0018 - The {0} integration connector encountered an {1} exception when registering a listener to the open metadata ecosystem.
    UNEXPECTED_EXCEPTION
    UNITY-CATALOG-CONNECTOR-0001 - The Unity Catalog connector {0} received an unexpected {1} exception during method {2}; the error message was: {3}
    VOLUME_UPDATE
    UNITY-CATALOG-CONNECTOR-0014 - The {0} Connector has detected a change in the open metadata element {1} that controls the definition of volume {2} but is unable to update the volume in Unity Catalog (UC) at {3}
    WRONG_REST_CONNECTOR
    UNITY-CATALOG-CONNECTOR-0006 - The {0} OSS Unity Catalog Connector has been supplied with a resource connector of class {1} rather than class {2} for asset {3}

  • Method Summary

    Modifier and Type
    Method
    Description
    AuditLogMessageDefinition
    getMessageDefinition()
    Retrieve a message definition object for logging.
    AuditLogMessageDefinition
    getMessageDefinition(String... params)
    Retrieve a message definition object for logging.
    String
    toString()
    JSON-style toString
    static UCAuditCode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static UCAuditCode[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • UNEXPECTED_EXCEPTION

      public static final UCAuditCode UNEXPECTED_EXCEPTION
      UNITY-CATALOG-CONNECTOR-0001 - The Unity Catalog connector {0} received an unexpected {1} exception during method {2}; the error message was: {3}

    • NO_CATALOGS

      public static final UCAuditCode NO_CATALOGS
      UNITY-CATALOG-CONNECTOR-0002 - The {0} connector is unable to retrieve details of any catalogs for Unity Catalog Server {1} ({2})

    • CATALOGED_DATABASE

      public static final UCAuditCode CATALOGED_DATABASE
      UNITY-CATALOG-CONNECTOR-0003 - The {0} integration connector has catalogued data set {1} ({2})

    • SKIPPING_DATABASE

      public static final UCAuditCode SKIPPING_DATABASE
      UNITY-CATALOG-CONNECTOR-0004 - he {0} integration connector is skipping data set {1} ({2}) because it is already catalogued

    • CLIENT_SIDE_REST_API_ERROR

      public static final UCAuditCode CLIENT_SIDE_REST_API_ERROR
      UNITY-CATALOG-CONNECTOR-0005 - A client-side exception was received from API call {0} to server {1} at {2}. The error message was {3}

    • WRONG_REST_CONNECTOR

      public static final UCAuditCode WRONG_REST_CONNECTOR
      UNITY-CATALOG-CONNECTOR-0006 - The {0} OSS Unity Catalog Connector has been supplied with a resource connector of class {1} rather than class {2} for asset {3}

    • FRIENDSHIP_GUID

      public static final UCAuditCode FRIENDSHIP_GUID
      UNITY-CATALOG-CONNECTOR-0007 - The {0} OSS Unity Catalog Connector has been supplied with a friendship connector with GUID {1}

    • IGNORING_ENDPOINT

      public static final UCAuditCode IGNORING_ENDPOINT
      UNITY-CATALOG-CONNECTOR-0008 - The {0} OSS Unity Inside Catalog Synchronizer Connector only works with catalog targets

    • NEW_CATALOG_TARGET

      public static final UCAuditCode NEW_CATALOG_TARGET
      UNITY-CATALOG-CONNECTOR-0009 - The {0} Connector has added a catalog target relationship {1} from friendship connector {2} to Unity Catalog Server Asset {3} for Unity Catalog (UC) {4}

    • IDENTITY_MISMATCH

      public static final UCAuditCode IDENTITY_MISMATCH
      UNITY-CATALOG-CONNECTOR-0010 - The {0} Connector has detected a change in the identity of element {1}. The original id was from {2} and now it is {3} in Unity Catalog (UC) {4}

    • CATALOG_UPDATE

      public static final UCAuditCode CATALOG_UPDATE
      UNITY-CATALOG-CONNECTOR-0011 - The {0} Connector has detected a change in the open metadata that controls the definition of catalog {1} but is unable to update the catalog in Unity Catalog (UC) at {2}

    • SCHEMA_UPDATE

      public static final UCAuditCode SCHEMA_UPDATE
      UNITY-CATALOG-CONNECTOR-0012 - The {0} Connector has detected a change in the open metadata that controls the definition of schema {1} but is unable to update the schema in Unity Catalog (UC) at {2}

    • TABLE_UPDATE

      public static final UCAuditCode TABLE_UPDATE
      UNITY-CATALOG-CONNECTOR-0013 - The {0} Connector has detected a change in the open metadata that controls the definition of table {1} but is unable to update the table in Unity Catalog (UC) at {2}

    • VOLUME_UPDATE

      public static final UCAuditCode VOLUME_UPDATE
      UNITY-CATALOG-CONNECTOR-0014 - The {0} Connector has detected a change in the open metadata element {1} that controls the definition of volume {2} but is unable to update the volume in Unity Catalog (UC) at {3}

    • FUNCTION_UPDATE

      public static final UCAuditCode FUNCTION_UPDATE
      UNITY-CATALOG-CONNECTOR-0015 - The {0} Connector has detected a change in the open metadata element {1} that controls the definition of function {2} but is unable to update the function in Unity Catalog (UC) at {3}

    • UC_ELEMENT_DELETE

      public static final UCAuditCode UC_ELEMENT_DELETE
      UNITY-CATALOG-CONNECTOR-0016 - The {0} Connector has detected that the open metadata element that controls the definition of element {1} in Unity Catalog (UC) at {2} has been deleted

    • MISSING_METHOD

      public static final UCAuditCode MISSING_METHOD
      UNITY-CATALOG-CONNECTOR-0017 - The {0} Connector has called method {1} that is not implemented and so is not able to synchronize element {2} with the Unity Catalog (UC) at {3}

    • UNABLE_TO_REGISTER_LISTENER

      public static final UCAuditCode UNABLE_TO_REGISTER_LISTENER
      UNITY-CATALOG-CONNECTOR-0018 - The {0} integration connector encountered an {1} exception when registering a listener to the open metadata ecosystem. The exception message included was {2}

    • NEW_ELEMENT_CREATED

      public static final UCAuditCode NEW_ELEMENT_CREATED
      UNITY-CATALOG-CONNECTOR-0019 - The {0} governance action service has created a new {1} element called {2} ({3})

    • NO_TECHNOLOGY_TYPE

      public static final UCAuditCode NO_TECHNOLOGY_TYPE
      UNITY-CATALOG-CONNECTOR-0020 - The {0} governance action service has no technology type to work with

    • INVALID_TECHNOLOGY_TYPE

      public static final UCAuditCode INVALID_TECHNOLOGY_TYPE
      UNITY-CATALOG-CONNECTOR-0021 - The {0} governance action service has been passed a technology type of {1} which is not supported

    • MISSING_PLACEHOLDER_VALUES

      public static final UCAuditCode MISSING_PLACEHOLDER_VALUES
      UNITY-CATALOG-CONNECTOR-0022 - The {0} governance action service has not been passed all the placeholder variables needed to create an element for technology type {1}; the missing placeholder variables are: {2}

  • Method Details

    • values

      public static UCAuditCode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static UCAuditCode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getMessageDefinition

      public AuditLogMessageDefinition getMessageDefinition()
      Retrieve a message definition object for logging. This method is used when there are no message inserts.
      Specified by:
      getMessageDefinition in interface AuditLogMessageSet
      Returns:
      message definition object.

    • getMessageDefinition

      public AuditLogMessageDefinition getMessageDefinition(String... params)
      Retrieve a message definition object for logging. This method is used when there are values to be inserted into the message.
      Specified by:
      getMessageDefinition in interface AuditLogMessageSet
      Parameters:
      params - array of parameters (all strings). They are inserted into the message according to the numbering in the message text.
      Returns:
      message definition object.

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class Enum<UCAuditCode>
      Returns:
      string of property names and values for this enum