io.cdap.cdap.api.app

Interface ApplicationConfigurer

All Superinterfaces:

DatasetConfigurer, FeatureFlagsProvider, PluginConfigurer

public interface ApplicationConfigurer
extends PluginConfigurer, DatasetConfigurer, FeatureFlagsProvider

Configures a CDAP Application.

Method Summary

Modifier and Type	Method and Description
void	addMapReduce(MapReduce mapReduce) Adds a MapReduce job to the Application.
void	addService(Service service) Adds a custom Service to the Application.
void	addSpark(Spark spark) Adds a Spark job to the Application.
void	addWorker(Worker worker) Adds a Worker to the Application.
void	addWorkflow(Workflow workflow) Adds a Workflow to the Application.
ScheduleBuilder	buildSchedule(String scheduleName, ProgramType programType, String programName) Get a ScheduleBuilder for the specified program.
default void	emitMetadata(Metadata metadata, MetadataScope scope) Emit the given Metadata for the application in the given scope.
default ApplicationSpecification	getDeployedApplicationSpec() Return the application Specification if it was deployed before.
default String	getDeployedNamespace() Return the namespace the app is deployed.
default RuntimeConfigurer	getRuntimeConfigurer() Return the runtime configurer that contains the runtime arguments and provides access for other runtime functionalities.
TriggerFactory	getTriggerFactory() Get a TriggerFactory to get triggers.
void	schedule(ScheduleCreationSpec scheduleCreationSpec) Schedules a program, using the given scheduleCreationSpec.
void	setDescription(String description) Sets the description of the Application.
void	setName(String name) Sets the name of the Application.

Methods inherited from interface io.cdap.cdap.api.plugin.PluginConfigurer

evaluateMacros, evaluateMacros, usePlugin, usePlugin, usePluginClass, usePluginClass

Methods inherited from interface io.cdap.cdap.api.DatasetConfigurer

addDatasetModule, addDatasetType, createDataset, createDataset, createDataset, createDataset

Methods inherited from interface io.cdap.cdap.api.feature.FeatureFlagsProvider

isFeatureEnabled

Method Detail

setName

void setName(String name)

Sets the name of the Application.

Parameters:

name - name

setDescription

void setDescription(String description)

Sets the description of the Application.

Parameters:

description - description

addMapReduce

void addMapReduce(MapReduce mapReduce)

Adds a MapReduce job to the Application. Use it when you need to re-use existing MapReduce jobs that rely on Hadoop MapReduce APIs.

Parameters:

mapReduce - The MapReduce job to include in the Application

addSpark

void addSpark(Spark spark)

Adds a Spark job to the Application.

Parameters:

spark - The Spark job to include in the Application

addWorkflow

void addWorkflow(Workflow workflow)

Adds a Workflow to the Application.

Parameters:

workflow - The Workflow to include in the Application

addService

void addService(Service service)

Adds a custom Service to the Application.

Parameters:

service - The service to include in the Application

addWorker

void addWorker(Worker worker)

Adds a Worker to the Application.

Parameters:

worker - The worker to include in the Application

buildSchedule

ScheduleBuilder buildSchedule(String scheduleName,
                              ProgramType programType,
                              String programName)

Get a ScheduleBuilder for the specified program.

Parameters:

scheduleName - the name of the schedule

programType - the type of the program; currently, only ProgramType.WORKFLOW can be scheduled

programName - the name of the program

Returns:

The ScheduleBuilder used to build the schedule

schedule

void schedule(ScheduleCreationSpec scheduleCreationSpec)

Schedules a program, using the given scheduleCreationSpec.

Parameters:

scheduleCreationSpec - defines the schedule.

emitMetadata

default void emitMetadata(Metadata metadata,
                          MetadataScope scope)

Emit the given Metadata for the application in the given scope. Note the tags and properties emitted in SYSTEM scope will get overridden by the platform system metadata if the tags or property keys are same.

Parameters:

metadata - the metadata to emit

getTriggerFactory

TriggerFactory getTriggerFactory()

Get a TriggerFactory to get triggers.

Returns:

The TriggerFactory used to get triggers

getRuntimeConfigurer

@Nullable
default RuntimeConfigurer getRuntimeConfigurer()

Return the runtime configurer that contains the runtime arguments and provides access for other runtime functionalities. This is used for the app to provide additional information for the newly generated app spec before each program run. This method will return null when the app initially gets deployed.

Returns:

the runtime configurer, or null if this is the initial deploy time.

getDeployedNamespace

default String getDeployedNamespace()

Return the namespace the app is deployed.

Returns:

the namespace the app is deployed

getDeployedApplicationSpec

@Nullable
default ApplicationSpecification getDeployedApplicationSpec()

Return the application Specification if it was deployed before. This is useful for upgrade usecases ( for example - transferring checkpoints for realtime / replication pipelines)

Returns:

the application Specification of the app if previously deployed otherwise null