io.cdap.cdap.api.service

Class ServiceSpecification

java.lang.Object

io.cdap.cdap.api.AbstractProgramSpecification

io.cdap.cdap.api.service.ServiceSpecification

All Implemented Interfaces:

ProgramSpecification

public final class ServiceSpecification
extends AbstractProgramSpecification

Specification for a Service.

Constructor Summary

Constructors

Constructor and Description
ServiceSpecification(String className, String name, String description, Map<String,HttpServiceHandlerSpecification> handlers, Resources resources, int instances, Map<String,Plugin> plugins)
ServiceSpecification(String className, String name, String description, Map<String,HttpServiceHandlerSpecification> handlers, Resources resources, int instances, Map<String,Plugin> plugins, Map<String,String> properties)

Method Summary

Modifier and Type	Method and Description
Map<String,HttpServiceHandlerSpecification>	getHandlers() Returns an immutable map from handler name to handler specification.
int	getInstances() Returns the number of instances for the service handler.
Map<String,String>	getProperties()
String	getProperty(String key)
Resources	getResources() Returns the resources requirements for the service handler.

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

ServiceSpecification

public ServiceSpecification(String className,
                            String name,
                            String description,
                            Map<String,HttpServiceHandlerSpecification> handlers,
                            Resources resources,
                            int instances,
                            Map<String,Plugin> plugins)

ServiceSpecification

public ServiceSpecification(String className,
                            String name,
                            String description,
                            Map<String,HttpServiceHandlerSpecification> handlers,
                            Resources resources,
                            int instances,
                            Map<String,Plugin> plugins,
                            Map<String,String> properties)

Method Detail

getHandlers

public Map<String,HttpServiceHandlerSpecification> getHandlers()

Returns an immutable map from handler name to handler specification.

getInstances

public int getInstances()

Returns the number of instances for the service handler.

getResources

public Resources getResources()

Returns the resources requirements for the service handler.

getProperties

public Map<String,String> getProperties()

Returns:

the properties

getProperty

public String getProperty(String key)

Parameters:

key - for getting specific property value

Returns:

the property value