io.cdap.cdap.api.worker

Class WorkerSpecification

java.lang.Object

io.cdap.cdap.api.AbstractProgramSpecification

io.cdap.cdap.api.worker.WorkerSpecification

All Implemented Interfaces:

PropertyProvider, ProgramSpecification

public final class WorkerSpecification
extends AbstractProgramSpecification
implements PropertyProvider

Specification for Workers.

Constructor Summary

Constructors

Constructor and Description
WorkerSpecification(String className, String name, String description, Map<String,String> properties, Set<String> datasets, Resources resources, int instances, Map<String,Plugin> plugins)

Method Summary

Modifier and Type	Method and Description
Set<String>	getDatasets()
int	getInstances()
Map<String,String>	getProperties() Returns an immutable Map of all properties.
String	getProperty(String key) Return the property value of a given key.
Resources	getResources()

Methods inherited from class io.cdap.cdap.api.AbstractProgramSpecification

getClassName, getDescription, getName, getPlugins

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkerSpecification

public WorkerSpecification(String className,
                           String name,
                           String description,
                           Map<String,String> properties,
                           Set<String> datasets,
                           Resources resources,
                           int instances,
                           Map<String,Plugin> plugins)

Method Detail

getProperties

public Map<String,String> getProperties()

Description copied from interface: PropertyProvider

Returns an immutable Map of all properties.

Specified by:

getProperties in interface PropertyProvider

getProperty

public String getProperty(String key)

Description copied from interface: PropertyProvider

Return the property value of a given key.

Specified by:

getProperty in interface PropertyProvider

Parameters:

key - for getting specific property value.

Returns:

The value associated with the key or null if not such key exists.

getResources

public Resources getResources()

Returns:

resources requirements which will be used to run the Worker

getDatasets

public Set<String> getDatasets()

Returns:

an immutable set of Dataset name that are used by the Worker

getInstances

public int getInstances()

Returns:

number of instances for the worker