Package oracle.pgx.config

Enum Class UdfFunctionConfig.Field

java.lang.Object
java.lang.Enum<UdfFunctionConfig.Field>
oracle.pgx.config.UdfFunctionConfig.Field
All Implemented Interfaces:
Serializable, Comparable<UdfFunctionConfig.Field>, Constable, ConfigField
Enclosing class:
UdfFunctionConfig
public static enum UdfFunctionConfig.Field extends Enum<UdfFunctionConfig.Field> implements ConfigField
Fields of PGX User Defined Function Config

  • Enum Constant Details

    • NAMESPACE

      public static final UdfFunctionConfig.Field NAMESPACE
      namespace of the function in PGX

    • FUNCTION_NAME

      public static final UdfFunctionConfig.Field FUNCTION_NAME
      name of the function used as identifier in PGX

    • LANGUAGE

      public static final UdfFunctionConfig.Field LANGUAGE
      language the function is implemented in

    • SOURCE_LOCATION

      public static final UdfFunctionConfig.Field SOURCE_LOCATION
      source code of the function provided as a unified resource identifier, either pointing to a a local file (relative to the location of this config or absolute), a web resource (prefix http://' or https://), or a classpath (prefix classpath:/ or jar:)

    • SOURCE_CODE

      public static final UdfFunctionConfig.Field SOURCE_CODE
      source code of the function provided inline

    • IMPLEMENTATION_REFERENCE

      public static final UdfFunctionConfig.Field IMPLEMENTATION_REFERENCE
      reference to the UDF implementation on the classpath

    • SOURCE_FUNCTION_NAME

      public static final UdfFunctionConfig.Field SOURCE_FUNCTION_NAME
      name of the function in the source language

    • RETURN_TYPE

      public static final UdfFunctionConfig.Field RETURN_TYPE
      return type of the function

    • ARGUMENTS

      public static final UdfFunctionConfig.Field ARGUMENTS
      list of arguments

  • Method Details

    • values

      public static UdfFunctionConfig.Field[] 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 UdfFunctionConfig.Field 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

    • getKeyAliases

      public List<String> getKeyAliases()
      Description copied from interface: ConfigField
      Gets the key aliases of this field which are also recognized during parsing.
      Specified by:
      getKeyAliases in interface ConfigField
      Returns:
      the key aliases

    • getSingletonListKeyAliases

      public List<String> getSingletonListKeyAliases()
      Description copied from interface: ConfigField
      Gets the key aliases of this field which contain single values for lists and are also recognized during parsing.
      Specified by:
      getSingletonListKeyAliases in interface ConfigField
      Returns:
      the singleton list key aliases

    • getType

      public Class<?> getType()
      Description copied from interface: ConfigField
      Gets the type of this field.
      Specified by:
      getType in interface ConfigField
      Returns:
      the type

    • isRequired

      public boolean isRequired()
      Description copied from interface: ConfigField
      Checks if this field is required.
      Specified by:
      isRequired in interface ConfigField
      Returns:
      true, if required

    • isArray

      public boolean isArray()
      Description copied from interface: ConfigField
      Checks if this field is an array.
      Specified by:
      isArray in interface ConfigField
      Returns:
      true, if array

    • isPath

      public boolean isPath()
      Description copied from interface: ConfigField
      Checks if this field is a path.
      Specified by:
      isPath in interface ConfigField
      Returns:
      true, if path

    • getDefaultVal

      public Object getDefaultVal()
      Description copied from interface: ConfigField
      Gets the default value of this field.
      Specified by:
      getDefaultVal in interface ConfigField
      Returns:
      the default value

    • toKey

      public String toKey()
      Description copied from interface: ConfigField
      Get the key of this field, which is how this field is represented in serialized form.
      Specified by:
      toKey in interface ConfigField
      Returns:
      the key.

    • toString

      public String toString()
      Overrides:
      toString in class Enum<UdfFunctionConfig.Field>

    • isSensitive

      public boolean isSensitive()
      Description copied from interface: ConfigField
      Checks if this field holds a sensitive data.
      Specified by:
      isSensitive in interface ConfigField
      Returns:
      true, if use for sensitive data

    • isHidden

      public boolean isHidden()
      Description copied from interface: ConfigField
      Checks if this field should be hidden. Hidden fields are used to hid desired field from the user and only allow it for internal usage.
      Specified by:
      isHidden in interface ConfigField
      Returns:
      true if field should be hidden, false otherwise