Packages

trait DocsPath extends AnyRef

Linear Supertypes
AnyRef, Any
Known Subclasses
DeltaErrors, DeltaErrorsBase
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DocsPath
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def assertValidCallingFunction(): Unit
  6. def baseDocsPath(conf: SparkConf): String

    The URL for the base path of Delta's docs.

    The URL for the base path of Delta's docs. When changing this path, ensure that the new path works with the error messages below.

    Attributes
    protected
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def errorsWithDocsLinks: Seq[String]

    List of error function names for all errors that have URLs.

    List of error function names for all errors that have URLs. When adding your error to this list remember to also add it to the list of errors in DeltaErrorsSuite

    Note

    add your error to DeltaErrorsSuiteBase after adding it to this list so that the url can be tested

  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. def generateDocsLink(conf: SparkConf, relativePath: String, skipValidation: Boolean = false): String

    Get the link to the docs for the given relativePath.

    Get the link to the docs for the given relativePath. Validates that the error generating the link is added to docsLinks.

    relativePath

    the relative path after the base url to access.

    skipValidation

    whether to validate that the function generating the link is in the allowlist.

    returns

    The entire URL of the documentation link

  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped