Skip navigation links
A B C D E F G H I J M O P R S T U V Y 

A

AbstractJobProxy - Class in org.apache.samza.rest.proxy.job
Implements a subset of the JobProxy interface with the default, cluster-agnostic, implementations.
AbstractJobProxy(JobsResourceConfig) - Constructor for class org.apache.samza.rest.proxy.job.AbstractJobProxy
Required constructor.
addServlet(Servlet, String) - Method in class org.apache.samza.rest.SamzaRestService
Adds the specified Servlet to the server at the specified path.

B

BIN_SUBPATH - Static variable in class org.apache.samza.rest.proxy.installation.SimpleInstallationFinder
 

C

CFG_SUBPATH - Static variable in class org.apache.samza.rest.proxy.installation.SimpleInstallationFinder
 
config - Variable in class org.apache.samza.rest.proxy.job.AbstractJobProxy
 
CONFIG_JOB_CONFIG_FACTORY - Static variable in class org.apache.samza.rest.resources.JobsResourceConfig
Specifies the canonical name of the ConfigFactory to read the job configs.
CONFIG_JOB_INSTALLATIONS_PATH - Static variable in class org.apache.samza.rest.resources.JobsResourceConfig
The path where all the Samza jobs are installed (unzipped).
CONFIG_JOB_PROXY_FACTORY - Static variable in class org.apache.samza.rest.resources.JobsResourceConfig
Specifies the canonical name of the JobProxyFactory class to produce JobProxy instances.
CONFIG_MONITOR_FACTORY_CLASS - Static variable in class org.apache.samza.monitor.MonitorConfig
 
CONFIG_REST_RESOURCE_CLASSES - Static variable in class org.apache.samza.rest.SamzaRestConfig
Specifies a comma-delimited list of class names of resources to register with the server.
CONFIG_REST_RESOURCE_FACTORIES - Static variable in class org.apache.samza.rest.SamzaRestConfig
Specifies a comma-delimited list of class names that implement ResourceFactory.
CONFIG_SAMZA_REST_SERVICE_PORT - Static variable in class org.apache.samza.rest.SamzaRestConfig
The port number to use for the HTTP server or 0 to dynamically choose a port.
CONFIG_SCHEDULING_INTERVAL - Static variable in class org.apache.samza.monitor.MonitorConfig
 

D

DefaultResourceFactory - Class in org.apache.samza.rest.resources
Instantiates all the resources that are shipped with the REST service.
DefaultResourceFactory() - Constructor for class org.apache.samza.rest.resources.DefaultResourceFactory
 

E

equals(Object) - Method in class org.apache.samza.rest.proxy.job.JobInstance
 

F

fromFactory(JobsResourceConfig) - Static method in class org.apache.samza.rest.proxy.job.AbstractJobProxy
Creates a new JobProxy instance from the factory class specified in the config.

G

getAllInstalledJobs() - Method in interface org.apache.samza.rest.proxy.installation.InstallationFinder
 
getAllInstalledJobs() - Method in class org.apache.samza.rest.proxy.installation.SimpleInstallationFinder
 
getAllJobInstances() - Method in class org.apache.samza.rest.proxy.job.AbstractJobProxy
 
getAllJobInstances() - Method in class org.apache.samza.rest.proxy.job.SimpleYarnJobProxy
 
getAllJobStatuses() - Method in class org.apache.samza.rest.proxy.job.AbstractJobProxy
 
getAllJobStatuses() - Method in interface org.apache.samza.rest.proxy.job.JobProxy
 
getConfigFilePath() - Method in class org.apache.samza.rest.proxy.installation.InstallationRecord
 
getInstallationFinder() - Method in class org.apache.samza.rest.proxy.job.ScriptJobProxy
 
getInstallationFinder() - Method in class org.apache.samza.rest.proxy.job.SimpleYarnJobProxy
 
getInstallationsPath() - Method in class org.apache.samza.rest.resources.JobsResourceConfig
 
getInstalledJobs() - Method in class org.apache.samza.rest.resources.JobsResource
Gets the Job for all the jobs installed on this host.
getJob(String, String) - Method in class org.apache.samza.rest.resources.JobsResource
Gets the Job for the job instance specified by jobName and jobId if it is installed on this host.
getJobConfigFactory() - Method in class org.apache.samza.rest.proxy.job.AbstractJobProxy
 
getJobId() - Method in class org.apache.samza.rest.model.Job
 
getJobId() - Method in class org.apache.samza.rest.proxy.job.JobInstance
 
getJobName() - Method in class org.apache.samza.rest.model.Job
 
getJobName() - Method in class org.apache.samza.rest.proxy.job.JobInstance
 
getJobProxy(JobsResourceConfig) - Method in interface org.apache.samza.rest.proxy.job.JobProxyFactory
Creates a new JobProxy and initializes it with the specified config.
getJobProxy(JobsResourceConfig) - Method in class org.apache.samza.rest.proxy.job.SimpleYarnJobProxyFactory
 
getJobProxyFactory() - Method in class org.apache.samza.rest.resources.JobsResourceConfig
 
getJobSamzaStatus(JobInstance) - Method in class org.apache.samza.rest.proxy.job.AbstractJobProxy
Convenience method to get the Samza job status from the name and id.
getJobStatus(JobInstance) - Method in class org.apache.samza.rest.proxy.job.AbstractJobProxy
 
getJobStatus(JobInstance) - Method in interface org.apache.samza.rest.proxy.job.JobProxy
 
getJobStatus(JobInstance) - Method in interface org.apache.samza.rest.proxy.job.JobStatusProvider
 
getJobStatus(JobInstance) - Method in class org.apache.samza.rest.proxy.job.YarnCliJobStatusProvider
 
getJobStatuses(Collection<Job>) - Method in interface org.apache.samza.rest.proxy.job.JobStatusProvider
Populates the status* fields of each Job in the provided Collection.
getJobStatuses(Collection<Job>) - Method in class org.apache.samza.rest.proxy.job.YarnCliJobStatusProvider
 
getJobStatusProvider() - Method in class org.apache.samza.rest.proxy.job.AbstractJobProxy
 
getJobStatusProvider() - Method in class org.apache.samza.rest.proxy.job.SimpleYarnJobProxy
 
getMonitorConfigs(Config) - Static method in class org.apache.samza.monitor.MonitorConfig
Groups configuration defined in the config object for each of the monitors into a MonitorConfig object
getMonitorFactoryClass() - Method in class org.apache.samza.monitor.MonitorConfig
 
getMonitorInstance(MonitorConfig, MetricsRegistry) - Method in interface org.apache.samza.monitor.MonitorFactory
 
getPort() - Method in class org.apache.samza.rest.SamzaRestConfig
 
getQualifiedJobName(JobInstance) - Static method in class org.apache.samza.rest.proxy.job.YarnCliJobStatusProvider
Constructs the job name used in YARN.
getResourceClassNames() - Method in class org.apache.samza.rest.SamzaRestConfig
 
getResourceFactoryClassNames() - Method in class org.apache.samza.rest.SamzaRestConfig
 
getResourceInstances(Config) - Method in class org.apache.samza.rest.resources.DefaultResourceFactory
 
getResourceInstances(Config) - Method in interface org.apache.samza.rest.resources.ResourceFactory
Constructs and returns resource instances to register with the server.
getRootPath() - Method in class org.apache.samza.rest.proxy.installation.InstallationRecord
 
getSchedulingIntervalInMs() - Method in class org.apache.samza.monitor.MonitorConfig
 
getScriptFilePath() - Method in class org.apache.samza.rest.proxy.installation.InstallationRecord
 
getScriptPath(JobInstance, String) - Method in class org.apache.samza.rest.proxy.job.ScriptJobProxy
Constructs the path to the specified script within the job installation.
getScriptPath(JobInstance, String) - Method in interface org.apache.samza.rest.script.ScriptPathProvider
 
getScriptTimeoutS() - Method in class org.apache.samza.rest.script.ScriptRunner
 
getStatus() - Method in class org.apache.samza.rest.model.Job
 
getStatusDetail() - Method in class org.apache.samza.rest.model.Job
 

H

hasBeenStarted() - Method in enum org.apache.samza.rest.model.JobStatus
 
hashCode() - Method in class org.apache.samza.rest.proxy.job.JobInstance
 

I

InstallationFinder - Interface in org.apache.samza.rest.proxy.installation
Finds all the installed jobs.
InstallationRecord - Class in org.apache.samza.rest.proxy.installation
Represents an installation of one Samza job instance on a file system.
InstallationRecord(String, String, String, String, String) - Constructor for class org.apache.samza.rest.proxy.installation.InstallationRecord
 
installationsPath - Variable in class org.apache.samza.rest.proxy.installation.SimpleInstallationFinder
 
instantiateMonitor(MonitorConfig, MetricsRegistry) - Static method in class org.apache.samza.monitor.MonitorLoader
 
isInstalled(JobInstance) - Method in interface org.apache.samza.rest.proxy.installation.InstallationFinder
 
isInstalled(JobInstance) - Method in class org.apache.samza.rest.proxy.installation.SimpleInstallationFinder
 

J

Job - Class in org.apache.samza.rest.model
The client view of a job.
Job(String, String) - Constructor for class org.apache.samza.rest.model.Job
 
Job(String, String, JobStatus, String) - Constructor for class org.apache.samza.rest.model.Job
 
Job() - Constructor for class org.apache.samza.rest.model.Job
 
jobConfigFactory - Variable in class org.apache.samza.rest.proxy.installation.SimpleInstallationFinder
 
jobExists(JobInstance) - Method in class org.apache.samza.rest.proxy.job.AbstractJobProxy
 
jobExists(JobInstance) - Method in interface org.apache.samza.rest.proxy.job.JobProxy
 
JobInstance - Class in org.apache.samza.rest.proxy.job
Allows us to encapsulate the jobName,jobId tuple as one entity.
JobInstance(String, String) - Constructor for class org.apache.samza.rest.proxy.job.JobInstance
Required constructor.
JobProxy - Interface in org.apache.samza.rest.proxy.job
Job proxy is the primary abstraction used by the REST API to interact with jobs.
JobProxyFactory - Interface in org.apache.samza.rest.proxy.job
Simple factory interface to produce instances of JobProxy, depending on the implementation.
JobsResource - Class in org.apache.samza.rest.resources
The REST resource for jobs.
JobsResource(JobsResourceConfig) - Constructor for class org.apache.samza.rest.resources.JobsResource
Initializes a JobResource with JobProxy from the JobProxyFactory class specified in the configuration.
JobsResourceConfig - Class in org.apache.samza.rest.resources
Configurations for the JobsResource endpoint.
JobsResourceConfig(Config) - Constructor for class org.apache.samza.rest.resources.JobsResourceConfig
 
JobStatus - Enum in org.apache.samza.rest.model
The abstract status of the job, irrespective of the status in any underlying cluster management system (e.g.
JobStatusProvider - Interface in org.apache.samza.rest.proxy.job
Interface for getting job status independent of the underlying cluster implementation.

M

main(String[]) - Static method in class org.apache.samza.rest.SamzaRestService
Command line interface to run the server.
Monitor - Interface in org.apache.samza.monitor
A Monitor is a class implementing some functionality that should be done every N milliseconds on a YARN RM or NM.
monitor() - Method in interface org.apache.samza.monitor.Monitor
Do the work of the monitor.
MonitorConfig - Class in org.apache.samza.monitor
Configurations for the Monitor implementations.
MonitorConfig(Config) - Constructor for class org.apache.samza.monitor.MonitorConfig
 
MonitorFactory - Interface in org.apache.samza.monitor
Factory to build Monitor using provided config.
MonitorLoader - Class in org.apache.samza.monitor
 
MonitorLoader() - Constructor for class org.apache.samza.monitor.MonitorLoader
 

O

org.apache.samza.monitor - package org.apache.samza.monitor
 
org.apache.samza.rest - package org.apache.samza.rest
 
org.apache.samza.rest.model - package org.apache.samza.rest.model
 
org.apache.samza.rest.proxy.installation - package org.apache.samza.rest.proxy.installation
 
org.apache.samza.rest.proxy.job - package org.apache.samza.rest.proxy.job
 
org.apache.samza.rest.resources - package org.apache.samza.rest.resources
 
org.apache.samza.rest.script - package org.apache.samza.rest.script
 

P

processScriptOutput(InputStream) - Method in interface org.apache.samza.rest.script.ScriptOutputHandler
Processes the script output represented by the InputStream.

R

ResourceFactory - Interface in org.apache.samza.rest.resources
Instantiates a resource using the provided config.
runScript(String, String...) - Method in class org.apache.samza.rest.script.ScriptRunner
Runs a script with IO inherited from the current Java process.
runScript(String, ScriptOutputHandler, String...) - Method in class org.apache.samza.rest.script.ScriptRunner
 

S

SamzaMonitorService - Class in org.apache.samza.monitor
The class responsible for handling long-running/scheduled monitors in Samza REST.
SamzaMonitorService(SamzaRestConfig, MetricsRegistry, SchedulingProvider) - Constructor for class org.apache.samza.monitor.SamzaMonitorService
 
SamzaRestApplication - Class in org.apache.samza.rest
Samza REST implementation of the JAX-RS Application model.
SamzaRestApplication(SamzaRestConfig) - Constructor for class org.apache.samza.rest.SamzaRestApplication
 
SamzaRestConfig - Class in org.apache.samza.rest
The set of configurations required by the core components of the SamzaRestService.
SamzaRestConfig(Config) - Constructor for class org.apache.samza.rest.SamzaRestConfig
 
SamzaRestService - Class in org.apache.samza.rest
The main Java class for the Samza REST API.
SamzaRestService(SamzaRestConfig) - Constructor for class org.apache.samza.rest.SamzaRestService
 
schedule(Runnable, int) - Method in class org.apache.samza.monitor.ScheduledExecutorSchedulingProvider
 
schedule(Runnable, int) - Method in interface org.apache.samza.monitor.SchedulingProvider
 
ScheduledExecutorSchedulingProvider - Class in org.apache.samza.monitor
 
ScheduledExecutorSchedulingProvider(ScheduledExecutorService) - Constructor for class org.apache.samza.monitor.ScheduledExecutorSchedulingProvider
 
SchedulingProvider - Interface in org.apache.samza.monitor
Provides scheduling functionality to the SamzaMonitorService.
ScriptJobProxy - Class in org.apache.samza.rest.proxy.job
Extends AbstractJobProxy with some script support functionality.
ScriptJobProxy(JobsResourceConfig) - Constructor for class org.apache.samza.rest.proxy.job.ScriptJobProxy
Required constructor.
ScriptOutputHandler - Interface in org.apache.samza.rest.script
A script output handler processes the stream of output from the stdout and stderr channels of a script.
ScriptPathProvider - Interface in org.apache.samza.rest.script
Defines the protocol for getting script paths.
scriptRunner - Variable in class org.apache.samza.rest.proxy.job.ScriptJobProxy
 
ScriptRunner - Class in org.apache.samza.rest.script
Runs a script process and returns the exit code.
ScriptRunner() - Constructor for class org.apache.samza.rest.script.ScriptRunner
 
setJobId(String) - Method in class org.apache.samza.rest.model.Job
 
setJobName(String) - Method in class org.apache.samza.rest.model.Job
 
setStatus(JobStatus) - Method in class org.apache.samza.rest.model.Job
 
setStatusDetail(String) - Method in class org.apache.samza.rest.model.Job
 
SimpleInstallationFinder - Class in org.apache.samza.rest.proxy.installation
A simple default implementation of InstallationFinder.
SimpleInstallationFinder(String, ConfigFactory) - Constructor for class org.apache.samza.rest.proxy.installation.SimpleInstallationFinder
Required constructor.
SimpleYarnJobProxy - Class in org.apache.samza.rest.proxy.job
Extends the ScriptJobProxy with methods specific to simple Samza deployments.
SimpleYarnJobProxy(JobsResourceConfig) - Constructor for class org.apache.samza.rest.proxy.job.SimpleYarnJobProxy
 
SimpleYarnJobProxyFactory - Class in org.apache.samza.rest.proxy.job
Factory to produce SimpleJobProxy instances.
SimpleYarnJobProxyFactory() - Constructor for class org.apache.samza.rest.proxy.job.SimpleYarnJobProxyFactory
 
start() - Method in class org.apache.samza.monitor.SamzaMonitorService
 
start(JobInstance) - Method in interface org.apache.samza.rest.proxy.job.JobProxy
Starts the job instance specified by jobName and jobId.
start(JobInstance) - Method in class org.apache.samza.rest.proxy.job.SimpleYarnJobProxy
 
start() - Method in class org.apache.samza.rest.SamzaRestService
Starts the server asynchronously.
stop() - Method in class org.apache.samza.monitor.SamzaMonitorService
 
stop() - Method in class org.apache.samza.monitor.ScheduledExecutorSchedulingProvider
 
stop() - Method in interface org.apache.samza.monitor.SchedulingProvider
 
stop(JobInstance) - Method in interface org.apache.samza.rest.proxy.job.JobProxy
Stops the job instance specified by jobName and jobId.
stop(JobInstance) - Method in class org.apache.samza.rest.proxy.job.SimpleYarnJobProxy
 
stop() - Method in class org.apache.samza.rest.SamzaRestService
Stops the server.

T

toString() - Method in enum org.apache.samza.rest.model.JobStatus
 
toString() - Method in class org.apache.samza.rest.proxy.installation.InstallationRecord
 
toString() - Method in class org.apache.samza.rest.proxy.job.JobInstance
 

U

updateJobStatus(String, String, String) - Method in class org.apache.samza.rest.resources.JobsResource
 

V

valueOf(String) - Static method in enum org.apache.samza.rest.model.JobStatus
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.samza.rest.model.JobStatus
Returns an array containing the constants of this enum type, in the order they are declared.

Y

YarnCliJobStatusProvider - Class in org.apache.samza.rest.proxy.job
An implementation of the JobStatusProvider that retrieves the job status from the YARN command line interface.
YarnCliJobStatusProvider(ScriptPathProvider) - Constructor for class org.apache.samza.rest.proxy.job.YarnCliJobStatusProvider
Default constructor.
A B C D E F G H I J M O P R S T U V Y 
Skip navigation links