org.apache.samza.sql.client.interfaces

Class EnvironmentVariableSpecs

java.lang.Object

org.apache.samza.sql.client.interfaces.EnvironmentVariableSpecs

public class EnvironmentVariableSpecs
extends java.lang.Object

Specification of a EnvironmentVariableHandler. It specifies valid enviable variable names, possible values, the default value, etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnvironmentVariableSpecs.Spec Describes the specification of an environment variable.

Constructor Summary

Constructors

Constructor and Description
EnvironmentVariableSpecs(java.util.Map<java.lang.String,EnvironmentVariableSpecs.Spec> specMap)

Method Summary

Modifier and Type	Method and Description
java.util.List<Pair<java.lang.String,EnvironmentVariableSpecs.Spec>>	getAllSpecs() Gets all supported environment variables and their Specs.
EnvironmentVariableSpecs.Spec	getSpec(java.lang.String name) Get the Spec object of an environment variable

Methods inherited from class java.lang.Object

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

Constructor Detail

EnvironmentVariableSpecs

public EnvironmentVariableSpecs(java.util.Map<java.lang.String,EnvironmentVariableSpecs.Spec> specMap)

Parameters:

specMap - A map of environment variable name vs its specification

Method Detail

getSpec

public EnvironmentVariableSpecs.Spec getSpec(java.lang.String name)

Get the Spec object of an environment variable

Parameters:

name - name of the environment variable

Returns:

A Spec object describing the specification of the environment variable

getAllSpecs

public java.util.List<Pair<java.lang.String,EnvironmentVariableSpecs.Spec>> getAllSpecs()

Gets all supported environment variables and their Specs.

Returns:

A list of Pair containing the name and Spec of all environment variable.