com.netflix.genie.core.services

Interface JobSearchService

All Known Implementing Classes:

JpaJobSearchServiceImpl

@Validated
public interface JobSearchService

Interface for searching jobs.

Since:

3.0.0

Method Summary

Modifier and Type	Method and Description
org.springframework.data.domain.Page<JobSearchResult>	findJobs(java.lang.String id, java.lang.String name, java.lang.String user, java.util.Set<JobStatus> statuses, java.util.Set<java.lang.String> tags, java.lang.String clusterName, java.lang.String clusterId, java.lang.String commandName, java.lang.String commandId, java.util.Date minStarted, java.util.Date maxStarted, java.util.Date minFinished, java.util.Date maxFinished, org.springframework.data.domain.Pageable page) Search for jobs which match the given filter criteria.
long	getActiveJobCountForUser(java.lang.String user) Get the count of 'active' jobs for a given user across all instances.
java.util.Set<Job>	getAllActiveJobsOnHost(java.lang.String hostName) Given a hostname return a set of all the jobs currently active on that host.
java.util.List<java.lang.String>	getAllHostsWithActiveJobs() Get a list of host names which are currently have active jobs in the Genie cluster.
Job	getJob(java.lang.String id) Get job information for given job id.
java.util.List<Application>	getJobApplications(java.lang.String id) Get the applications the job was run with or exception if not found.
Cluster	getJobCluster(java.lang.String id) Get the cluster the job was run on or exception if not found.
Command	getJobCommand(java.lang.String id) Get the command the job was run with or exception if not found.
JobExecution	getJobExecution(java.lang.String id) Get job execution for given job id.
java.lang.String	getJobHost(java.lang.String jobId) Get the hostname a job is running on.
JobRequest	getJobRequest(java.lang.String id) Get job request for given job id.
JobStatus	getJobStatus(java.lang.String id) Get the status of the job with the given id.

Method Detail

findJobs

org.springframework.data.domain.Page<JobSearchResult> findJobs(java.lang.String id,
                                                               java.lang.String name,
                                                               java.lang.String user,
                                                               java.util.Set<JobStatus> statuses,
                                                               java.util.Set<java.lang.String> tags,
                                                               java.lang.String clusterName,
                                                               java.lang.String clusterId,
                                                               java.lang.String commandName,
                                                               java.lang.String commandId,
                                                               java.util.Date minStarted,
                                                               java.util.Date maxStarted,
                                                               java.util.Date minFinished,
                                                               java.util.Date maxFinished,
                                                               @NotNull
                                                               org.springframework.data.domain.Pageable page)

Search for jobs which match the given filter criteria.

Parameters:

id - id for job

name - name of job (can be a SQL-style pattern such as HIVE%)

user - user who submitted job

statuses - statuses of job

tags - tags for the job

clusterName - name of cluster for job

clusterId - id of cluster for job

commandName - name of the command run in the job

commandId - id of the command run in the job

minStarted - The time which the job had to start after in order to be return (inclusive)

maxStarted - The time which the job had to start before in order to be returned (exclusive)

minFinished - The time which the job had to finish after in order to be return (inclusive)

maxFinished - The time which the job had to finish before in order to be returned (exclusive)

page - Page information of job to get

Returns:

Metadata information on jobs which match the criteria

getAllActiveJobsOnHost

java.util.Set<Job> getAllActiveJobsOnHost(@NotBlank
                                          java.lang.String hostName)

Given a hostname return a set of all the jobs currently active on that host.

Parameters:

hostName - The host name to search for. Not null or empty.

Returns:

All the jobs active on the host as a set of Job objects

getAllHostsWithActiveJobs

java.util.List<java.lang.String> getAllHostsWithActiveJobs()

Get a list of host names which are currently have active jobs in the Genie cluster.

Returns:

The list of hosts with jobs currently in an active state

getJob

Job getJob(@NotBlank(message="No id entered. Unable to get job.")
           java.lang.String id)
    throws GenieException

Get job information for given job id.

Parameters:

id - id of job to look up

Returns:

the job

Throws:

GenieException - if there is an error

getJobStatus

JobStatus getJobStatus(@NotBlank
                       java.lang.String id)
                throws GenieException

Get the status of the job with the given id.

Parameters:

id - The id of the job to get status for

Returns:

The job status

Throws:

GenieException - When any error, including not found, is encountered

getJobRequest

JobRequest getJobRequest(@NotBlank
                         java.lang.String id)
                  throws GenieException

Get job request for given job id.

Parameters:

id - id of job request to look up

Returns:

the job

Throws:

GenieException - if there is an error

getJobExecution

JobExecution getJobExecution(@NotBlank
                             java.lang.String id)
                      throws GenieException

Get job execution for given job id.

Parameters:

id - id of job execution to look up

Returns:

the job

Throws:

GenieException - if there is an error

getJobCluster

Cluster getJobCluster(@NotBlank
                      java.lang.String id)
               throws GenieException

Get the cluster the job was run on or exception if not found.

Parameters:

id - The id of the job to get the cluster for

Returns:

The cluster

Throws:

GenieException - If either the job or the cluster is not found

getJobCommand

Command getJobCommand(@NotBlank
                      java.lang.String id)
               throws GenieException

Get the command the job was run with or exception if not found.

Parameters:

id - The id of the job to get the command for

Returns:

The command

Throws:

GenieException - If either the job or the command is not found

getJobApplications

java.util.List<Application> getJobApplications(@NotBlank
                                               java.lang.String id)
                                        throws GenieException

Get the applications the job was run with or exception if not found.

Parameters:

id - The id of the job to get the applications for

Returns:

The applications

Throws:

GenieException - If either the job or the applications were not found

getJobHost

java.lang.String getJobHost(@NotBlank
                            java.lang.String jobId)
                     throws GenieException

Get the hostname a job is running on.

Parameters:

jobId - The id of the job to get the hostname for

Returns:

The hostname

Throws:

GenieException - If the job isn't found or any other error

getActiveJobCountForUser

long getActiveJobCountForUser(@NotBlank
                              java.lang.String user)
                       throws GenieException

Get the count of 'active' jobs for a given user across all instances.

Parameters:

user - The user name

Returns:

the number of active jobs for a given user

Throws:

GenieException - If any error occurs