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

Enum Class DuckDBAuditCode

java.lang.Object
java.lang.Enum<DuckDBAuditCode>
org.odpi.openmetadata.adapters.connectors.duckdb.ffdc.DuckDBAuditCode
All Implemented Interfaces:
Serializable, Comparable<DuckDBAuditCode>, Constable, AuditLogMessageSet
public enum DuckDBAuditCode extends Enum<DuckDBAuditCode> implements AuditLogMessageSet
The DuckDBAuditCode 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
    AMBIGUOUS_ELEMENT_FOUND
    DUCKDB-CONNECTOR-0014 - The {0} connector found {1} elements with qualified name {2} when only one was expected; the element is skipped for this refresh
    ATTACH_STATEMENT_FAILED
    DUCKDB-CONNECTOR-0010 - The {0} connector was unable to run ATTACH_STATEMENTS entry "{1}" for DuckDB Database {2}; the error message was: {3}
    ATTACHED_SOURCE_FOUND
    DUCKDB-CONNECTOR-0006 - The {0} connector discovered that DuckDB Database {1} has an attached source called {2} of type {3}
    ATTACHED_TABLE_CATALOGED
    DUCKDB-CONNECTOR-0013 - The {0} connector has catalogued attached table {1} from data source {2} as a TabularDataSet ({3} columns)
    CATALOGED_DATABASE
    DUCKDB-CONNECTOR-0002 - The {0} integration connector has catalogued DuckDB Database {1} ({2})
    DUCKDB_TABLE_NOT_YET_CATALOGUED
    DUCKDB-CONNECTOR-0012 - The {0} connector could not find a DuckDB-side RelationalTable for view {1} (tried qualified names {2} and {3}); classification and lineage linking for this view will be attempted again on a subsequent refresh
    EXTERNAL_FILE_SOURCE_FOUND
    DUCKDB-CONNECTOR-0007 - The {0} connector discovered that DuckDB Database {1} has a view called {2} that scans an external {3} resource at {4}
    FEDERATION_LINK_FAILED
    DUCKDB-CONNECTOR-0009 - The {0} connector was unable to catalog the federation relationship for {1} discovered in DuckDB Database {2}; the error message was: {3}
    FEDERATION_QUERY_FAILED
    DUCKDB-CONNECTOR-0008 - The {0} connector was unable to query DuckDB's {1} federation metadata for database {2}; the error message was: {3}
    FILE_SCHEMA_CATALOGED
    DUCKDB-CONNECTOR-0011 - The {0} connector has catalogued the schema for external file source {1} ({2} columns)
    FRIENDSHIP_GUID
    DUCKDB-CONNECTOR-0004 - The {0} DuckDB Connector has been supplied with a friendship connector with GUID {1}
    NEW_CATALOG_TARGET
    DUCKDB-CONNECTOR-0005 - The {0} Connector has added a catalog target relationship {1} from friendship connector {2} to DuckDB Database Asset {3} for Database {4}
    SKIPPING_DATABASE
    DUCKDB-CONNECTOR-0003 - The {0} integration connector is skipping DuckDB Database {1} ({2}) because it is already catalogued
    UNEXPECTED_EXCEPTION
    DUCKDB-CONNECTOR-0001 - The DuckDB connector {0} received an unexpected {1} exception during method {2}; the error message was: {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 DuckDBAuditCode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static DuckDBAuditCode[]
    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 DuckDBAuditCode UNEXPECTED_EXCEPTION
      DUCKDB-CONNECTOR-0001 - The DuckDB connector {0} received an unexpected {1} exception during method {2}; the error message was: {3}

    • CATALOGED_DATABASE

      public static final DuckDBAuditCode CATALOGED_DATABASE
      DUCKDB-CONNECTOR-0002 - The {0} integration connector has catalogued DuckDB Database {1} ({2})

    • SKIPPING_DATABASE

      public static final DuckDBAuditCode SKIPPING_DATABASE
      DUCKDB-CONNECTOR-0003 - The {0} integration connector is skipping DuckDB Database {1} ({2}) because it is already catalogued

    • FRIENDSHIP_GUID

      public static final DuckDBAuditCode FRIENDSHIP_GUID
      DUCKDB-CONNECTOR-0004 - The {0} DuckDB Connector has been supplied with a friendship connector with GUID {1}

    • NEW_CATALOG_TARGET

      public static final DuckDBAuditCode NEW_CATALOG_TARGET
      DUCKDB-CONNECTOR-0005 - The {0} Connector has added a catalog target relationship {1} from friendship connector {2} to DuckDB Database Asset {3} for Database {4}

    • ATTACHED_SOURCE_FOUND

      public static final DuckDBAuditCode ATTACHED_SOURCE_FOUND
      DUCKDB-CONNECTOR-0006 - The {0} connector discovered that DuckDB Database {1} has an attached source called {2} of type {3}

    • EXTERNAL_FILE_SOURCE_FOUND

      public static final DuckDBAuditCode EXTERNAL_FILE_SOURCE_FOUND
      DUCKDB-CONNECTOR-0007 - The {0} connector discovered that DuckDB Database {1} has a view called {2} that scans an external {3} resource at {4}

    • FEDERATION_QUERY_FAILED

      public static final DuckDBAuditCode FEDERATION_QUERY_FAILED
      DUCKDB-CONNECTOR-0008 - The {0} connector was unable to query DuckDB's {1} federation metadata for database {2}; the error message was: {3}

    • ATTACH_STATEMENT_FAILED

      public static final DuckDBAuditCode ATTACH_STATEMENT_FAILED
      DUCKDB-CONNECTOR-0010 - The {0} connector was unable to run ATTACH_STATEMENTS entry "{1}" for DuckDB Database {2}; the error message was: {3}

    • FILE_SCHEMA_CATALOGED

      public static final DuckDBAuditCode FILE_SCHEMA_CATALOGED
      DUCKDB-CONNECTOR-0011 - The {0} connector has catalogued the schema for external file source {1} ({2} columns)

    • DUCKDB_TABLE_NOT_YET_CATALOGUED

      public static final DuckDBAuditCode DUCKDB_TABLE_NOT_YET_CATALOGUED
      DUCKDB-CONNECTOR-0012 - The {0} connector could not find a DuckDB-side RelationalTable for view {1} (tried qualified names {2} and {3}); classification and lineage linking for this view will be attempted again on a subsequent refresh

    • ATTACHED_TABLE_CATALOGED

      public static final DuckDBAuditCode ATTACHED_TABLE_CATALOGED
      DUCKDB-CONNECTOR-0013 - The {0} connector has catalogued attached table {1} from data source {2} as a TabularDataSet ({3} columns)

    • AMBIGUOUS_ELEMENT_FOUND

      public static final DuckDBAuditCode AMBIGUOUS_ELEMENT_FOUND
      DUCKDB-CONNECTOR-0014 - The {0} connector found {1} elements with qualified name {2} when only one was expected; the element is skipped for this refresh

  • Method Details

    • values

      public static DuckDBAuditCode[] 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 DuckDBAuditCode 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<DuckDBAuditCode>
      Returns:
      string of property names and values for this enum