com.netflix.genie.web.data.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.time.Instant minStarted, java.time.Instant maxStarted, java.time.Instant minFinished, java.time.Instant maxFinished, java.lang.String grouping, java.lang.String groupingInstance, @NotNull org.springframework.data.domain.Pageable page) Search for jobs which match the given filter criteria.
java.util.Set<java.lang.String>	getActiveDisconnectedAgentJobs() Get the IDs of all agent jobs that are active but currently not connected to any node.
long	getActiveJobCountForUser(@NotBlank java.lang.String user) Get the count of 'active' jobs for a given user across all instances.
long	getActiveJobCountOnHost(java.lang.String hostname) Get the number of active Genie jobs on a given host.
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.
java.util.Set<java.lang.String>	getAllHostsWithActiveJobs() Get a set of host names which are currently have active jobs in the Genie cluster.
long	getAllocatedMemoryOnHost(java.lang.String hostname) Get the amount of memory currently allocated on the given host by Genie jobs that are currently active.
Job	getJob(@NotBlank(message="No id entered. Unable to get job.") java.lang.String id) Get job information for given job id.
java.util.List<Application>	getJobApplications(@NotBlank java.lang.String id) Get the applications the job was run with or exception if not found.
Cluster	getJobCluster(@NotBlank java.lang.String id) Get the cluster the job was run on or exception if not found.
Command	getJobCommand(@NotBlank java.lang.String id) Get the command the job was run with or exception if not found.
JobExecution	getJobExecution(@NotBlank java.lang.String id) Get job execution for given job id.
java.lang.String	getJobHost(@NotBlank java.lang.String jobId) Get the hostname a job is running on.
JobMetadata	getJobMetadata(@NotBlank java.lang.String id) Get the metadata about a job.
JobRequest	getJobRequest(@NotBlank java.lang.String id) Get job request for given job id.
JobStatus	getJobStatus(@NotBlank java.lang.String id) Deprecated. Use JobPersistenceService.getJobStatus(String) instead
long	getUsedMemoryOnHost(java.lang.String hostname) Get the amount of memory currently used on the given host by Genie jobs in any of the following states.
java.util.Map<java.lang.String,UserResourcesSummary>	getUserResourcesSummaries() Get a map of summaries of resources usage for each user with at least one running job.

Method Detail

findJobs

org.springframework.data.domain.Page<JobSearchResult> findJobs(@Nullable
                                                               java.lang.String id,
                                                               @Nullable
                                                               java.lang.String name,
                                                               @Nullable
                                                               java.lang.String user,
                                                               @Nullable
                                                               java.util.Set<JobStatus> statuses,
                                                               @Nullable
                                                               java.util.Set<java.lang.String> tags,
                                                               @Nullable
                                                               java.lang.String clusterName,
                                                               @Nullable
                                                               java.lang.String clusterId,
                                                               @Nullable
                                                               java.lang.String commandName,
                                                               @Nullable
                                                               java.lang.String commandId,
                                                               @Nullable
                                                               java.time.Instant minStarted,
                                                               @Nullable
                                                               java.time.Instant maxStarted,
                                                               @Nullable
                                                               java.time.Instant minFinished,
                                                               @Nullable
                                                               java.time.Instant maxFinished,
                                                               @Nullable
                                                               java.lang.String grouping,
                                                               @Nullable
                                                               java.lang.String groupingInstance,
                                                               @NotNull
                                                               @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)

grouping - The job grouping to search for

groupingInstance - The job grouping instance to search for

page - Page information of job to get

Returns:

Metadata information on jobs which match the criteria

getAllActiveJobsOnHost

java.util.Set<Job> getAllActiveJobsOnHost(@NotBlank
                                          @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.Set<java.lang.String> getAllHostsWithActiveJobs()

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

Returns:

The set of hosts with jobs currently in an active state

getJob

Job getJob(@NotBlank(message="No id entered. Unable to get job.")
           @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

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

Deprecated. Use JobPersistenceService.getJobStatus(String) instead

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
                         @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
                             @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
                      @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
                      @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
                                               @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
                            @NotBlank java.lang.String jobId)
                     throws GenieNotFoundException

Get the hostname a job is running on.

Parameters:

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

Returns:

The hostname

Throws:

GenieNotFoundException - If the job host cannot be found

getActiveJobCountForUser

long getActiveJobCountForUser(@NotBlank
                              @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

getJobMetadata

JobMetadata getJobMetadata(@NotBlank
                           @NotBlank java.lang.String id)
                    throws GenieException

Get the metadata about a job.

Parameters:

id - The id of the job to get metadata for

Returns:

The metadata for a job

Throws:

GenieException - If any error occurs

getUserResourcesSummaries

java.util.Map<java.lang.String,UserResourcesSummary> getUserResourcesSummaries()

Get a map of summaries of resources usage for each user with at least one running job.

Returns:

a map of user resources summaries, keyed on user name

getActiveDisconnectedAgentJobs

java.util.Set<java.lang.String> getActiveDisconnectedAgentJobs()

Get the IDs of all agent jobs that are active but currently not connected to any node.

Returns:

a set of job ids

getAllocatedMemoryOnHost

long getAllocatedMemoryOnHost(java.lang.String hostname)

Get the amount of memory currently allocated on the given host by Genie jobs that are currently active.

Parameters:

hostname - The hostname to get the memory for

Returns:

The amount of memory reserved in MB by all active jobs on the given host

See Also:

JobStatus.getActiveStatuses()

getUsedMemoryOnHost

long getUsedMemoryOnHost(java.lang.String hostname)

Get the amount of memory currently used on the given host by Genie jobs in any of the following states.

JobStatus.CLAIMED JobStatus.INIT JobStatus.RUNNING

Parameters:

hostname - The hostname to get the memory for

Returns:

The amount of memory being used in MB by all jobs

getActiveJobCountOnHost

long getActiveJobCountOnHost(java.lang.String hostname)

Get the number of active Genie jobs on a given host.

Parameters:

hostname - The host to get the count for

Returns:

The count of jobs in an active state on the given host

See Also:

JobStatus.getActiveStatuses()