ExternalResource

This represents an external source which contains information into how an external resource shall be read by Spark-NLP's Resource Helper.

ReadAs.TEXT will configure the file to be read locally as text
ReadAs.BINARY will configure the file to be read locally as binary
ReadAs.SPARK will configure the file to be read by Spark. "format" will need to be defined in options.

Example

ExternalResource(
  "src/test/resources/regex-matcher/rules.txt",
  ReadAs.TEXT,
  Map("delimiter" -> ",")
)

ExternalResource(
  "src/test/resources/regex-matcher/rules.txt",
  ReadAs.SPARK,
  Map("format" -> "text", "delimiter" -> ",")
)

path: Path to the resource
readAs: How to interpret the resource. Possible values are ReadAs.SPARK, ReadAs.TEXT, ReadAs.BINARY
options: Options for Spark. Option format needs to be set if readAs is set to ReadAs.SPARK

Linear Supertypes

Product, Equals, WritableAnnotatorComponent, Serializable, Serializable, AnyRef, Any

Instance Constructors

new ExternalResource(path: String, readAs: Format, options: Map[String, String])

path
Path to the resource
readAs
How to interpret the resource. Possible values are ReadAs.SPARK, ReadAs.TEXT, ReadAs.BINARY
options
Options for Spark. Option format needs to be set if readAs is set to ReadAs.SPARK

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val options: Map[String, String]

Options for Spark.
Options for Spark. Option format needs to be set if readAs is set to ReadAs.SPARK
val path: String

Path to the resource
val readAs: Format

How to interpret the resource.
How to interpret the resource. Possible values are ReadAs.SPARK, ReadAs.TEXT, ReadAs.BINARY
def serialize: SerializedExternalResource

Definition Classes
ExternalResource → WritableAnnotatorComponent
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object ExternalResource | package io

case class ExternalResource(path: String, readAs: Format, options: Map[String, String]) extends WritableAnnotatorComponent with Product with Serializable

Example

Instance Constructors

new ExternalResource(path: String, readAs: Format, options: Map[String, String])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val options: Map[String, String]

val path: String

val readAs: Format

def serialize: SerializedExternalResource

final def synchronized[T0](arg0: ⇒ T0): T0

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Product

Inherited from Equals

Inherited from WritableAnnotatorComponent

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped