BaseEnv

Abstract Value Members

abstract def branch: String

The name of the Git branch (or some other identifier of the feature being developed)
The name of the Git branch (or some other identifier of the feature being developed)
N.B by default, this will not be used when the environment is prod
abstract def environment: String

The name of the logical environment (e.g.
The name of the logical environment (e.g. dev, prod)
abstract def project: String

The name of the project/application
abstract def uri: String

The uri for the base path

Concrete 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 basePath: String

Base path into which the application can write its data Unless overridden, paths will be of the form {uri}/data/{environment}/{project}/{branch} where environment is the logical environment (e.g.
Base path into which the application can write its data Unless overridden, paths will be of the form {uri}/data/{environment}/{project}/{branch} where environment is the logical environment (e.g. dev, test), project is the name of the application and branch is the Git branch
N.B when environment is 'prod', the branch is omitted from the path as we assume it will always be master
e.g. hdfs:///data/dev/my_project/feature_abc, hdfs:///data/prod/my_project
def cleanup(sparkSession: SparkSession): Unit

Cleans up the environment
Cleans up the environment
sparkSession
the SparkSession

Definition Classes
BaseEnv → Env
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def create(sparkSession: SparkSession): Unit

Creates the environment
Creates the environment
sparkSession
the SparkSession

Definition Classes
BaseEnv → Env
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
def isTraceEnabled(): Boolean

Attributes
protected
Definition Classes
Logging
def logAndReturn[A](a: A, msg: String, level: Level): A

Definition Classes
Logging
def logAndReturn[A](a: A, message: (A) ⇒ String, level: Level): A

Definition Classes
Logging
def logDebug(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logDebug(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
def logError(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logError(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
def logInfo(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logInfo(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
def logName: String

Attributes
protected
Definition Classes
Logging
def logTrace(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logTrace(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
def logWarning(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logWarning(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def normaliseName(name: String): String

Replace any special characters in the given string with underscores
Replace any special characters in the given string with underscores
name
the name potentially containing special characters
returns
the name with special characters replaced with underscores

Definition Classes
Env
def normalisedBranch: String
def normalisedEnvironment: String
def normalisedProject: String
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def tmpDir: String

Directory in which to write temporary files
Directory in which to write temporary files
returns
the temporary directory

Definition Classes
BaseEnv → Env
def toString(): String

Definition Classes
AnyRef → Any
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 Doc: package app

trait BaseEnv extends Env

Abstract Value Members

abstract def branch: String

abstract def environment: String

abstract def project: String

abstract def uri: String

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def basePath: String

def cleanup(sparkSession: SparkSession): Unit

def clone(): AnyRef

def create(sparkSession: SparkSession): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def isTraceEnabled(): Boolean

def logAndReturn[A](a: A, msg: String, level: Level): A

def logAndReturn[A](a: A, message: (A) ⇒ String, level: Level): A

def logDebug(msg: ⇒ String, throwable: Throwable): Unit

def logDebug(msg: ⇒ String): Unit

def logError(msg: ⇒ String, throwable: Throwable): Unit

def logError(msg: ⇒ String): Unit

def logInfo(msg: ⇒ String, throwable: Throwable): Unit

def logInfo(msg: ⇒ String): Unit

def logName: String

def logTrace(msg: ⇒ String, throwable: Throwable): Unit

def logTrace(msg: ⇒ String): Unit

def logWarning(msg: ⇒ String, throwable: Throwable): Unit

def logWarning(msg: ⇒ String): Unit

final def ne(arg0: AnyRef): Boolean

def normaliseName(name: String): String

def normalisedBranch: String

def normalisedEnvironment: String

def normalisedProject: String

final def notify(): Unit

final def notifyAll(): Unit

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

def tmpDir: String

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Env

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped