com.netflix.genie.web.data.services

Interface PersistenceService

All Known Implementing Classes:

JpaPersistenceServiceImpl

@Validated
public interface PersistenceService

Service API for all Genie persistence related operations.

Since:

4.0.0

Method Summary

Modifier and Type	Method and Description
void	addApplicationsForCommand(@NotBlank java.lang.String id, @NotEmpty java.util.List<java.lang.String> applicationIds) Add applications for the command.
void	addClusterCriterionForCommand(java.lang.String id, @Valid Criterion criterion) Add a new Criterion to the existing list of cluster criteria for the command identified by id.
void	addClusterCriterionForCommand(java.lang.String id, @Valid Criterion criterion, @Min(value=0L) int priority) Add a new Criterion to the existing list of cluster criteria for the command identified by id.
<R extends CommonResource> void	addConfigsToResource(@NotBlank java.lang.String id, java.util.Set<java.lang.String> configs, java.lang.Class<R> resourceClass) Add configuration files to the existing set for a resource.
<R extends CommonResource> void	addDependenciesToResource(@NotBlank java.lang.String id, java.util.Set<java.lang.String> dependencies, java.lang.Class<R> resourceClass) Add dependency files to the existing set for a resource.
<R extends CommonResource> void	addTagsToResource(@NotBlank java.lang.String id, java.util.Set<java.lang.String> tags, java.lang.Class<R> resourceClass) Add tags to the existing set for a resource.
void	claimJob(@NotBlank java.lang.String id, @Valid AgentClientMetadata agentClientMetadata) Set a job identified by id to be owned by the agent identified by agentClientMetadata.
void	deleteAllApplications() Delete all applications from the system.
void	deleteAllClusters() Delete all clusters from database.
void	deleteAllCommands() Delete all commands from the system.
void	deleteApplication(@NotBlank java.lang.String id) Delete an Application from the system.
void	deleteCluster(@NotBlank java.lang.String id) Delete a Cluster by id.
void	deleteCommand(@NotBlank java.lang.String id) Delete a Command from system.
long	deleteJobsCreatedBefore(@NotNull java.time.Instant creationThreshold, @NotNull java.util.Set<JobStatus> excludeStatuses, @Min(value=1L) int batchSize) This method will delete a chunk of jobs whose creation time is earlier than the given date.
long	deleteUnusedApplications(@NotNull java.time.Instant createdThreshold, @Min(value=1L) int batchSize) Delete any unused applications that were created before the given time.
long	deleteUnusedClusters(java.util.Set<ClusterStatus> deleteStatuses, @NotNull java.time.Instant clusterCreatedThreshold, @Min(value=1L) int batchSize) Delete all clusters that are in one of the given states, aren't attached to any jobs and were created before the given time.
long	deleteUnusedCommands(java.util.Set<CommandStatus> deleteStatuses, @NotNull java.time.Instant commandCreatedThreshold, @Min(value=1L) int batchSize) Bulk delete commands from the database where their status is in deleteStatuses they were created before commandCreatedThreshold and they aren't attached to any jobs still in the database.
long	deleteUnusedFiles(@NotNull java.time.Instant createdThreshold, @Min(value=1L) int batchSize) Delete all files from the database that aren't referenced which were created before the supplied created threshold.
long	deleteUnusedTags(@NotNull java.time.Instant createdThreshold, @Min(value=1L) int batchSize) Delete all tags from the database that aren't referenced which were created before the supplied created threshold.
org.springframework.data.domain.Page<Application>	findApplications(java.lang.String name, java.lang.String user, java.util.Set<ApplicationStatus> statuses, java.util.Set<java.lang.String> tags, java.lang.String type, org.springframework.data.domain.Pageable page) Find applications which match the given filter criteria.
org.springframework.data.domain.Page<Cluster>	findClusters(java.lang.String name, java.util.Set<ClusterStatus> statuses, java.util.Set<java.lang.String> tags, java.time.Instant minUpdateTime, java.time.Instant maxUpdateTime, org.springframework.data.domain.Pageable page) Find and Clusters that match the given parameters.
java.util.Set<Cluster>	findClustersMatchingAnyCriterion(@NotEmpty java.util.Set<Criterion> criteria, boolean addDefaultStatus) Find all the Cluster's that match any of the given Criterion.
java.util.Set<Cluster>	findClustersMatchingCriterion(@Valid Criterion criterion, boolean addDefaultStatus) Find all the Cluster's that match the given Criterion.
org.springframework.data.domain.Page<Command>	findCommands(java.lang.String name, java.lang.String user, java.util.Set<CommandStatus> statuses, java.util.Set<java.lang.String> tags, org.springframework.data.domain.Pageable page) Find commands matching the given filter criteria.
java.util.Set<Command>	findCommandsMatchingCriterion(@Valid Criterion criterion, boolean addDefaultStatus) Find all the Command's that match the given Criterion.
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) Find jobs which match the given filter criteria.
long	getActiveJobCountForUser(@NotBlank java.lang.String user) Get the count of 'active' jobs for a given user across all instances.
java.util.Set<java.lang.String>	getActiveJobs() Get the set of active jobs.
Application	getApplication(@NotBlank java.lang.String id) Get the application metadata for given id.
java.util.List<Application>	getApplicationsForCommand(java.lang.String id) Get the applications for a given command.
Cluster	getCluster(@NotBlank java.lang.String id) Get the Cluster identified by the given id.
java.util.List<Criterion>	getClusterCriteriaForCommand(java.lang.String id) For the given command id return the Cluster Criterion in priority order that is currently associated with this command if any.
java.util.Set<Cluster>	getClustersForCommand(@NotBlank java.lang.String id, java.util.Set<ClusterStatus> statuses) Get all the clusters the command with given id is associated with.
Command	getCommand(@NotBlank java.lang.String id) Get the metadata for the Command identified by the id.
java.util.Set<Command>	getCommandsForApplication(@NotBlank java.lang.String id, java.util.Set<CommandStatus> statuses) Get all the commands the application with given id is associated with.
<R extends CommonResource> java.util.Set<java.lang.String>	getConfigsForResource(@NotBlank java.lang.String id, java.lang.Class<R> resourceClass) Get the set of configuration files associated with the resource with the given id.
<R extends CommonResource> java.util.Set<java.lang.String>	getDependenciesForResource(@NotBlank java.lang.String id, java.lang.Class<R> resourceClass) Get the set of dependency files associated with the resource with the given id.
FinishedJob	getFinishedJob(@NotBlank java.lang.String id) Get a DTO representing a finished job.
JobInfoAggregate	getHostJobInformation(@NotBlank java.lang.String hostname) Get all the aggregate metadata information about jobs running on a given hostname.
Job	getJob(@NotBlank 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 used or is currently using.
java.util.Optional<java.lang.String>	getJobArchiveLocation(@NotBlank java.lang.String id) Get the location a job directory was archived to if at all.
ArchiveStatus	getJobArchiveStatus(@NotBlank java.lang.String id) Get the archive status for a job with the given id.
Cluster	getJobCluster(@NotBlank java.lang.String id) Get the cluster the job used or is using.
Command	getJobCommand(@NotBlank java.lang.String id) Get the command the job used or is using.
JobExecution	getJobExecution(@NotBlank java.lang.String id) Get job execution for given job id.
JobMetadata	getJobMetadata(@NotBlank java.lang.String id) Get the metadata about a job.
JobRequest	getJobRequest(@NotBlank java.lang.String id) Get the original request for a job.
java.util.Optional<JobSpecification>	getJobSpecification(@NotBlank java.lang.String id) Get the saved job specification for the given job.
JobStatus	getJobStatus(@NotBlank java.lang.String id) Get the status for a job with the given id.
java.util.Set<java.lang.String>	getJobsWithStatusAndArchiveStatusUpdatedBefore(@NotEmpty java.util.Set<JobStatus> statuses, @NotEmpty java.util.Set<ArchiveStatus> archiveStatuses, @NotNull java.time.Instant updated) Get the set of jobs (agent only) whose state is in statuses and archive status is in archiveStatuses and last updated before updated.
com.fasterxml.jackson.databind.JsonNode	getLauncherExt(@NotBlank java.lang.String id) Get the job requested launcher extension.
com.fasterxml.jackson.databind.JsonNode	getRequestedLauncherExt(@NotBlank java.lang.String id) Get the command the job used or is using.
<R extends CommonResource> java.util.Set<java.lang.String>	getTagsForResource(@NotBlank java.lang.String id, java.lang.Class<R> resourceClass) Get the set of tags associated with the resource with the given id.
java.util.Set<java.lang.String>	getUnclaimedJobs() Get the set of jobs in that have not reached CLAIMED state.
long	getUsedMemoryOnHost(@NotBlank 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(java.util.Set<JobStatus> statuses, boolean api) Get a map of summaries of resources usage for each user with at least one active job.
JobRequest	getV3JobRequest(@NotBlank java.lang.String id) Deprecated.
boolean	isApiJob(@NotBlank java.lang.String id) Get whether the job with the given ID was submitted via the REST API or other mechanism.
void	removeAllClusterCriteriaForCommand(java.lang.String id) Remove all the Criterion currently associated with the command identified by id.
<R extends CommonResource> void	removeAllConfigsForResource(@NotBlank java.lang.String id, java.lang.Class<R> resourceClass) Remove all configuration files from the resource.
<R extends CommonResource> void	removeAllDependenciesForResource(@NotBlank java.lang.String id, java.lang.Class<R> resourceClass) Remove all dependency files from the resource.
<R extends CommonResource> void	removeAllTagsForResource(@NotBlank java.lang.String id, java.lang.Class<R> resourceClass) Remove all tags from the resource.
void	removeApplicationForCommand(@NotBlank java.lang.String id, @NotBlank java.lang.String appId) Remove the application from the command.
void	removeApplicationsForCommand(@NotBlank java.lang.String id) Remove all the applications from the command.
void	removeClusterCriterionForCommand(java.lang.String id, @Min(value=0L) int priority) Remove the Criterion with the given priority from the current list of cluster criteria associated with the command identified by id.
<R extends CommonResource> void	removeConfigForResource(@NotBlank java.lang.String id, @NotBlank java.lang.String config, java.lang.Class<R> resourceClass) Remove a configuration file from the given resource.
<R extends CommonResource> void	removeDependencyForResource(@NotBlank java.lang.String id, @NotBlank java.lang.String dependency, java.lang.Class<R> resourceClass) Remove a dependency file from the given resource.
<R extends CommonResource> void	removeTagForResource(@NotBlank java.lang.String id, @NotBlank java.lang.String tag, java.lang.Class<R> resourceClass) Remove a tag from the given resource.
java.lang.String	saveApplication(@Valid ApplicationRequest applicationRequest) Save a new application.
java.lang.String	saveCluster(@Valid ClusterRequest clusterRequest) Save a Cluster.
java.lang.String	saveCommand(@Valid CommandRequest commandRequest) Save a Command in the system based on the given CommandRequest.
java.lang.String	saveJobSubmission(@Valid JobSubmission jobSubmission) Save the given job submission information in the underlying data store.
void	saveResolvedJob(@NotBlank java.lang.String id, @Valid ResolvedJob resolvedJob) Save the given resolved details for a job.
void	setApplicationsForCommand(@NotBlank java.lang.String id, @NotNull java.util.List<java.lang.String> applicationIds) Set the applications for the command.
void	setClusterCriteriaForCommand(java.lang.String id, java.util.List<Criterion> clusterCriteria) For the command identified by id reset the entire list of cluster criteria to match the contents of clusterCriteria.
void	updateApplication(@NotBlank java.lang.String id, @Valid Application updateApp) Update an Application.
void	updateCluster(@NotBlank java.lang.String id, @Valid Cluster updateCluster) Update a Cluster with the given information.
void	updateCommand(@NotBlank java.lang.String id, @Valid Command updateCommand) Update a Command.
<R extends CommonResource> void	updateConfigsForResource(@NotBlank java.lang.String id, java.util.Set<java.lang.String> configs, java.lang.Class<R> resourceClass) Update the set of configuration files associated with the resource with the given id.
<R extends CommonResource> void	updateDependenciesForResource(@NotBlank java.lang.String id, java.util.Set<java.lang.String> dependencies, java.lang.Class<R> resourceClass) Update the set of dependency files associated with the resource with the given id.
void	updateJobArchiveStatus(@NotBlank(message="No job id entered. Unable to update.") java.lang.String id, @NotNull(message="Status cannot be null.") ArchiveStatus archiveStatus) Update the status and status message of the job.
void	updateJobStatus(@NotBlank java.lang.String id, @NotNull JobStatus currentStatus, @NotNull JobStatus newStatus, java.lang.String newStatusMessage) Update the status of the job identified with id to be newStatus provided that the current status of the job matches newStatus.
void	updateLauncherExt(@NotBlank(message="No job id entered. Unable to update.") java.lang.String id, @NotNull(message="Status cannot be null.") com.fasterxml.jackson.databind.JsonNode launcherExtension) Update the launcher extension field for this job.
void	updateRequestedLauncherExt(@NotBlank(message="No job id entered. Unable to update.") java.lang.String id, @NotNull(message="Status cannot be null.") com.fasterxml.jackson.databind.JsonNode launcherExtension) Update the requested launcher extension field for this job.
int	updateStatusForUnusedCommands(CommandStatus desiredStatus, java.time.Instant commandCreatedThreshold, java.util.Set<CommandStatus> currentStatuses, int batchSize) Update the status of a command to the desiredStatus if its status is in currentStatuses, it was created before commandCreatedThreshold and it hasn't been used in any job.
<R extends CommonResource> void	updateTagsForResource(@NotBlank java.lang.String id, java.util.Set<java.lang.String> tags, java.lang.Class<R> resourceClass) Update the set of tags associated with the resource with the given id.

Method Detail

saveApplication

java.lang.String saveApplication(@Valid
                                 @Valid ApplicationRequest applicationRequest)
                          throws IdAlreadyExistsException

Save a new application.

Parameters:

applicationRequest - The ApplicationRequest containing the metadata of the application to create

Returns:

The unique id of the application that was created

Throws:

IdAlreadyExistsException - If the ID is already used by another application

getApplication

Application getApplication(@NotBlank
                           @NotBlank java.lang.String id)
                    throws NotFoundException

Get the application metadata for given id.

Parameters:

id - unique id for application configuration to get. Not null/empty.

Returns:

The Application

Throws:

NotFoundException - if no application with id exists

findApplications

org.springframework.data.domain.Page<Application> findApplications(@Nullable
                                                                   java.lang.String name,
                                                                   @Nullable
                                                                   java.lang.String user,
                                                                   @Nullable
                                                                   java.util.Set<ApplicationStatus> statuses,
                                                                   @Nullable
                                                                   java.util.Set<java.lang.String> tags,
                                                                   @Nullable
                                                                   java.lang.String type,
                                                                   org.springframework.data.domain.Pageable page)

Find applications which match the given filter criteria.

Parameters:

name - Name of the application. Can be null or empty.

user - The user who created the application. Can be null/empty

statuses - The statuses of the applications to find. Can be null.

tags - Tags allocated to this application

type - The type of the application to find

page - The page requested for the search results

Returns:

The page of found applications

updateApplication

void updateApplication(@NotBlank
                       @NotBlank java.lang.String id,
                       @Valid
                       @Valid Application updateApp)
                throws NotFoundException,
                       PreconditionFailedException

Update an Application.

Parameters:

id - The id of the application to update

updateApp - Information to update for the application configuration with

Throws:

NotFoundException - If no Application with id exists

PreconditionFailedException - If id and updateApp id don't match

deleteAllApplications

void deleteAllApplications()
                    throws PreconditionFailedException

Delete all applications from the system.

Throws:

PreconditionFailedException - When any Application is still associated with a command

deleteApplication

void deleteApplication(@NotBlank
                       @NotBlank java.lang.String id)
                throws PreconditionFailedException

Delete an Application from the system.

Parameters:

id - unique id of the application to delete

Throws:

PreconditionFailedException - When the Application is still used by any command

getCommandsForApplication

java.util.Set<Command> getCommandsForApplication(@NotBlank
                                                 @NotBlank java.lang.String id,
                                                 @Nullable
                                                 java.util.Set<CommandStatus> statuses)
                                          throws NotFoundException

Get all the commands the application with given id is associated with.

Parameters:

id - The id of the application to get the commands for.

statuses - The desired status(es) to filter the associated commands for

Returns:

The commands the application is used by

Throws:

NotFoundException - If no Application with id exists

deleteUnusedApplications

long deleteUnusedApplications(@NotNull
                              @NotNull java.time.Instant createdThreshold,
                              @Min(value=1L)
                              @Min(value=1L) int batchSize)

Delete any unused applications that were created before the given time. Unused means they aren't linked to any other resources in the Genie system like jobs or commands and therefore referential integrity is maintained.

Parameters:

createdThreshold - The instant in time that any application had to be created before (exclusive) to be considered for deletion. Presents ability to filter out newly created applications if desired.

batchSize - The maximum number of applications to delete in a single transaction

Returns:

The number of successfully deleted applications

saveCluster

java.lang.String saveCluster(@Valid
                             @Valid ClusterRequest clusterRequest)
                      throws IdAlreadyExistsException

Save a Cluster.

Parameters:

clusterRequest - The cluster information to save

Returns:

The id of the saved cluster

Throws:

IdAlreadyExistsException - If a Cluster with the given id already exists

getCluster

Cluster getCluster(@NotBlank
                   @NotBlank java.lang.String id)
            throws NotFoundException

Get the Cluster identified by the given id.

Parameters:

id - unique id of the Cluster to get

Returns:

The Cluster

Throws:

NotFoundException - If no Cluster with id exists

findClusters

org.springframework.data.domain.Page<Cluster> findClusters(@Nullable
                                                           java.lang.String name,
                                                           @Nullable
                                                           java.util.Set<ClusterStatus> statuses,
                                                           @Nullable
                                                           java.util.Set<java.lang.String> tags,
                                                           @Nullable
                                                           java.time.Instant minUpdateTime,
                                                           @Nullable
                                                           java.time.Instant maxUpdateTime,
                                                           org.springframework.data.domain.Pageable page)

Find and Clusters that match the given parameters. Null or empty parameters are ignored.

Parameters:

name - cluster name

statuses - ClusterStatus that clusters must be in to be matched

tags - tags attached to this cluster

minUpdateTime - min time when cluster was updated

maxUpdateTime - max time when cluster was updated

page - The page to get

Returns:

All the clusters matching the criteria

updateCluster

void updateCluster(@NotBlank
                   @NotBlank java.lang.String id,
                   @Valid
                   @Valid Cluster updateCluster)
            throws NotFoundException,
                   PreconditionFailedException

Update a Cluster with the given information.

Parameters:

id - The id of the cluster to update

updateCluster - The information to update the cluster with

Throws:

NotFoundException - If no Cluster with id exists

PreconditionFailedException - If the id doesn't match the updateCluster id

deleteAllClusters

void deleteAllClusters()
                throws PreconditionFailedException

Delete all clusters from database.

Throws:

PreconditionFailedException - If the cluster is still associated with any job

deleteCluster

void deleteCluster(@NotBlank
                   @NotBlank java.lang.String id)
            throws PreconditionFailedException

Delete a Cluster by id.

Parameters:

id - unique id of the cluster to delete

Throws:

PreconditionFailedException - If the cluster is still associated with any job

deleteUnusedClusters

long deleteUnusedClusters(java.util.Set<ClusterStatus> deleteStatuses,
                          @NotNull
                          @NotNull java.time.Instant clusterCreatedThreshold,
                          @Min(value=1L)
                          @Min(value=1L) int batchSize)

Delete all clusters that are in one of the given states, aren't attached to any jobs and were created before the given time.

Parameters:

deleteStatuses - The set of ClusterStatus a cluster must be in to be considered for deletion.

clusterCreatedThreshold - The instant in time before which a cluster must have been created to be considered for deletion. Exclusive.

batchSize - The maximum number of clusters to delete in a single transaction

Returns:

The number of clusters deleted

findClustersMatchingCriterion

java.util.Set<Cluster> findClustersMatchingCriterion(@Valid
                                                     @Valid Criterion criterion,
                                                     boolean addDefaultStatus)

Find all the Cluster's that match the given Criterion.

Parameters:

criterion - The Criterion supplied that each cluster needs to completely match to be returned

addDefaultStatus - true if the a default status should be added to the supplied Criterion if the supplied criterion doesn't already have a status

Returns:

All the Cluster's which matched the Criterion

findClustersMatchingAnyCriterion

java.util.Set<Cluster> findClustersMatchingAnyCriterion(@NotEmpty
                                                        @NotEmpty java.util.Set<Criterion> criteria,
                                                        boolean addDefaultStatus)

Find all the Cluster's that match any of the given Criterion.

Parameters:

criteria - The set of Criterion supplied that a cluster needs to completely match at least one of to be returned

addDefaultStatus - true if the a default status should be added to the supplied Criterion if the supplied criterion doesn't already have a status

Returns:

All the Cluster's which matched the Criterion

saveCommand

java.lang.String saveCommand(@Valid
                             @Valid CommandRequest commandRequest)
                      throws IdAlreadyExistsException

Save a Command in the system based on the given CommandRequest.

Parameters:

commandRequest - encapsulates the command configuration information to create

Returns:

The id of the command that was saved

Throws:

IdAlreadyExistsException - If there was a conflict on the unique id for the command

getCommand

Command getCommand(@NotBlank
                   @NotBlank java.lang.String id)
            throws NotFoundException

Get the metadata for the Command identified by the id.

Parameters:

id - unique id for command to get. Not null/empty.

Returns:

The command

Throws:

NotFoundException - If no Command exists with the given id

findCommands

org.springframework.data.domain.Page<Command> findCommands(@Nullable
                                                           java.lang.String name,
                                                           @Nullable
                                                           java.lang.String user,
                                                           @Nullable
                                                           java.util.Set<CommandStatus> statuses,
                                                           @Nullable
                                                           java.util.Set<java.lang.String> tags,
                                                           org.springframework.data.domain.Pageable page)

Find commands matching the given filter criteria.

Parameters:

name - Name of command config

user - The name of the user who created the configuration

statuses - The status of the commands to get. Can be null.

tags - tags allocated to this command

page - The page of results to get

Returns:

All the commands matching the specified criteria

updateCommand

void updateCommand(@NotBlank
                   @NotBlank java.lang.String id,
                   @Valid
                   @Valid Command updateCommand)
            throws NotFoundException,
                   PreconditionFailedException

Update a Command.

Parameters:

id - The id of the command configuration to update. Not null or empty.

updateCommand - contains the information to update the command with

Throws:

NotFoundException - If no Command exists with the given id

PreconditionFailedException - When the id doesn't match the id of updateCommand

deleteAllCommands

void deleteAllCommands()
                throws PreconditionFailedException

Delete all commands from the system.

Throws:

PreconditionFailedException - If any constraint is violated trying to delete a command

deleteCommand

void deleteCommand(@NotBlank
                   @NotBlank java.lang.String id)
            throws NotFoundException

Delete a Command from system.

Parameters:

id - unique if of the command to delete

Throws:

NotFoundException - If no Command exists with the given id

addApplicationsForCommand

void addApplicationsForCommand(@NotBlank
                               @NotBlank java.lang.String id,
                               @NotEmpty
                               @NotEmpty java.util.List<java.lang.String> applicationIds)
                        throws NotFoundException,
                               PreconditionFailedException

Add applications for the command.

Parameters:

id - The id of the command to add the application file to. Not null/empty/blank.

applicationIds - The ids of the applications to add. Not null.

Throws:

NotFoundException - If no Command exists with the given id or one of the applications doesn't exist

PreconditionFailedException - If an application with one of the ids is already associated with the command

setApplicationsForCommand

void setApplicationsForCommand(@NotBlank
                               @NotBlank java.lang.String id,
                               @NotNull
                               @NotNull java.util.List<java.lang.String> applicationIds)
                        throws NotFoundException,
                               PreconditionFailedException

Set the applications for the command.

Parameters:

id - The id of the command to add the application file to. Not null/empty/blank.

applicationIds - The ids of the applications to set. Not null.

Throws:

NotFoundException - If no Command exists with the given id or one of the applications doesn't exist

PreconditionFailedException - If there are duplicate application ids in the list

getApplicationsForCommand

java.util.List<Application> getApplicationsForCommand(java.lang.String id)
                                               throws NotFoundException

Get the applications for a given command.

Parameters:

id - The id of the command to get the application for. Not null/empty/blank.

Returns:

The applications or exception if none exist.

Throws:

NotFoundException - If no Command exists with the given id

removeApplicationsForCommand

void removeApplicationsForCommand(@NotBlank
                                  @NotBlank java.lang.String id)
                           throws NotFoundException,
                                  PreconditionFailedException

Remove all the applications from the command.

Parameters:

id - The id of the command to remove the application from. Not null/empty/blank.

Throws:

NotFoundException - If no Command exists with the given id

PreconditionFailedException - If applications are unable to be removed

removeApplicationForCommand

void removeApplicationForCommand(@NotBlank
                                 @NotBlank java.lang.String id,
                                 @NotBlank
                                 @NotBlank java.lang.String appId)
                          throws NotFoundException

Remove the application from the command.

Parameters:

id - The id of the command to remove the application from. Not null/empty/blank.

appId - The id of the application to remove. Not null/empty/blank

Throws:

NotFoundException - If no Command exists with the given id

getClustersForCommand

java.util.Set<Cluster> getClustersForCommand(@NotBlank
                                             @NotBlank java.lang.String id,
                                             @Nullable
                                             java.util.Set<ClusterStatus> statuses)
                                      throws NotFoundException

Get all the clusters the command with given id is associated with.

Parameters:

id - The id of the command to get the clusters for.

statuses - The status of the clusters returned

Returns:

The clusters the command is available on.

Throws:

NotFoundException - If no Command exists with the given id

getClusterCriteriaForCommand

java.util.List<Criterion> getClusterCriteriaForCommand(java.lang.String id)
                                                throws NotFoundException

For the given command id return the Cluster Criterion in priority order that is currently associated with this command if any.

Parameters:

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

Returns:

The cluster criteria in priority order

Throws:

NotFoundException - If no command with id exists

addClusterCriterionForCommand

void addClusterCriterionForCommand(java.lang.String id,
                                   @Valid
                                   @Valid Criterion criterion)
                            throws NotFoundException

Add a new Criterion to the existing list of cluster criteria for the command identified by id. This new criterion will be the lowest priority criterion.

Parameters:

id - The id of the command to add to

criterion - The new Criterion to add

Throws:

NotFoundException - If no command with id exists

addClusterCriterionForCommand

void addClusterCriterionForCommand(java.lang.String id,
                                   @Valid
                                   @Valid Criterion criterion,
                                   @Min(value=0L)
                                   @Min(value=0L) int priority)
                            throws NotFoundException

Add a new Criterion to the existing list of cluster criteria for the command identified by id. The priority is the place in the list this new criterion should be placed. A value of 0 indicates it should be placed at the front of the list with the highest possible priority. 1 would be second in the list etc. If priority is > the current size of the cluster criteria list this new criterion will be placed at the end as the lowest priority item.

Parameters:

id - The id of the command to add to

criterion - The new Criterion to add

priority - The place in the existing cluster criteria list this new criterion should be placed. Min 0.

Throws:

NotFoundException - If no command with id exists

setClusterCriteriaForCommand

void setClusterCriteriaForCommand(java.lang.String id,
                                  java.util.List<Criterion> clusterCriteria)
                           throws NotFoundException

For the command identified by id reset the entire list of cluster criteria to match the contents of clusterCriteria.

Parameters:

id - The id of the command to set the cluster criteria for

clusterCriteria - The priority list of Criterion to set

Throws:

NotFoundException - If no command with id exists

removeClusterCriterionForCommand

void removeClusterCriterionForCommand(java.lang.String id,
                                      @Min(value=0L)
                                      @Min(value=0L) int priority)
                               throws NotFoundException

Remove the Criterion with the given priority from the current list of cluster criteria associated with the command identified by id. A value of 0 for priority will result in the first element in the list being removed, 1 the second element and so on.

Parameters:

id - The id of the command to remove the criterion from

priority - The priority of the criterion to remove

Throws:

NotFoundException - If no command with id exists

removeAllClusterCriteriaForCommand

void removeAllClusterCriteriaForCommand(java.lang.String id)
                                 throws NotFoundException

Remove all the Criterion currently associated with the command identified by id.

Parameters:

id - The id of the command to remove the criteria from

Throws:

NotFoundException - If no command with id exists

findCommandsMatchingCriterion

java.util.Set<Command> findCommandsMatchingCriterion(@Valid
                                                     @Valid Criterion criterion,
                                                     boolean addDefaultStatus)

Find all the Command's that match the given Criterion.

Parameters:

criterion - The Criterion supplied that each command needs to completely match to be returned

addDefaultStatus - true if a default status should be added to the supplied criterion if a status isn't already present

Returns:

All the Command's which matched the Criterion

updateStatusForUnusedCommands

int updateStatusForUnusedCommands(CommandStatus desiredStatus,
                                  java.time.Instant commandCreatedThreshold,
                                  java.util.Set<CommandStatus> currentStatuses,
                                  int batchSize)

Update the status of a command to the desiredStatus if its status is in currentStatuses, it was created before commandCreatedThreshold and it hasn't been used in any job.

Parameters:

desiredStatus - The new status the matching commands should have

commandCreatedThreshold - The instant in time which a command must have been created before to be considered for update. Exclusive

currentStatuses - The set of current statuses a command must have to be considered for update

batchSize - The maximum number of commands to update in a single transaction

Returns:

The number of commands whose statuses were updated to desiredStatus

deleteUnusedCommands

long deleteUnusedCommands(java.util.Set<CommandStatus> deleteStatuses,
                          @NotNull
                          @NotNull java.time.Instant commandCreatedThreshold,
                          @Min(value=1L)
                          @Min(value=1L) int batchSize)

Bulk delete commands from the database where their status is in deleteStatuses they were created before commandCreatedThreshold and they aren't attached to any jobs still in the database.

Parameters:

deleteStatuses - The set of statuses a command must be in in order to be considered for deletion

commandCreatedThreshold - The instant in time a command must have been created before to be considered for deletion. Exclusive.

batchSize - The maximum number of commands to delete in a single transaction

Returns:

The number of commands that were deleted

getV3JobRequest

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

Deprecated.

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

getJob

Job getJob(@NotBlank
           @NotBlank 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

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

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

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)

Find jobs which match the given filter criteria.

Parameters:

id - id for job

name - name of job

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

deleteJobsCreatedBefore

long deleteJobsCreatedBefore(@NotNull
                             @NotNull java.time.Instant creationThreshold,
                             @NotNull
                             @NotNull java.util.Set<JobStatus> excludeStatuses,
                             @Min(value=1L)
                             @Min(value=1L) int batchSize)

This method will delete a chunk of jobs whose creation time is earlier than the given date.

Parameters:

creationThreshold - The instant in time before which all jobs should be deleted

excludeStatuses - The set of statuses that should be excluded from deletion if a job is in one of these statuses

batchSize - The maximum number of jobs that should be deleted per query

Returns:

the number of deleted jobs

saveJobSubmission

@Nonnull
java.lang.String saveJobSubmission(@Valid
                                            @Valid JobSubmission jobSubmission)
                                     throws IdAlreadyExistsException

Save the given job submission information in the underlying data store.

The job record will be created with initial state of JobStatus.RESERVED meaning that the unique id returned by this API has been reserved within Genie and no other job can use it. If JobSubmission contains some attachments these attachments will be persisted to a configured storage system (i.e. local disk, S3, etc) and added to the set of dependencies for the job. The underlying attachment storage system must be accessible by the agent process configured by the system. For example if the server is set up to write attachments to local disk but the agent is not running locally but instead on the remote system it will not be able to access those attachments (as dependencies) and fail. See AttachmentService for more information.

Parameters:

jobSubmission - All the information the system has gathered regarding the job submission from the user either via the API or via the agent CLI

Returns:

The unique id of the job within the Genie ecosystem

Throws:

IdAlreadyExistsException - If the id the user requested already exists in the system for another job

getJobRequest

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

Get the original request for a job.

Parameters:

id - The unique id of the job to get

Returns:

The job request if one was found

Throws:

NotFoundException - If no job with id exists

saveResolvedJob

void saveResolvedJob(@NotBlank
                     @NotBlank java.lang.String id,
                     @Valid
                     @Valid ResolvedJob resolvedJob)
              throws NotFoundException

Save the given resolved details for a job. Sets the job status to JobStatus.RESOLVED.

Parameters:

id - The id of the job

resolvedJob - The resolved information for the job

Throws:

NotFoundException - When the job identified by id can't be found and the specification can't be saved or one of the resolved cluster, command or applications not longer exist in the system.

getJobSpecification

java.util.Optional<JobSpecification> getJobSpecification(@NotBlank
                                                         @NotBlank java.lang.String id)
                                                  throws NotFoundException

Get the saved job specification for the given job. If the job hasn't had a job specification resolved an empty Optional will be returned.

Parameters:

id - The id of the job

Returns:

The JobSpecification if one is present else an empty Optional

Throws:

NotFoundException - If no job with id exists

claimJob

void claimJob(@NotBlank
              @NotBlank java.lang.String id,
              @Valid
              @Valid AgentClientMetadata agentClientMetadata)
       throws NotFoundException,
              GenieJobAlreadyClaimedException,
              GenieInvalidStatusException

Set a job identified by id to be owned by the agent identified by agentClientMetadata. The job status in the system will be set to JobStatus.CLAIMED

Parameters:

id - The id of the job to claim. Must exist in the system.

agentClientMetadata - The metadata about the client claiming the job

Throws:

NotFoundException - if no job with the given id exists

GenieJobAlreadyClaimedException - if the job with the given id already has been claimed

GenieInvalidStatusException - if the current job status is not JobStatus.RESOLVED

updateJobStatus

void updateJobStatus(@NotBlank
                     @NotBlank java.lang.String id,
                     @NotNull
                     @NotNull JobStatus currentStatus,
                     @NotNull
                     @NotNull JobStatus newStatus,
                     @Nullable
                     java.lang.String newStatusMessage)
              throws NotFoundException,
                     GenieInvalidStatusException

Update the status of the job identified with id to be newStatus provided that the current status of the job matches newStatus. Optionally a status message can be provided to provide more details to users. If the newStatus is JobStatus.RUNNING the start time will be set. If the newStatus is a member of JobStatus.getFinishedStatuses() and the job had a started time set the finished time of the job will be set.

Parameters:

id - The id of the job to update status for. Must exist in the system.

currentStatus - The status the caller to this API thinks the job currently has

newStatus - The new status the caller would like to update the status to

newStatusMessage - An optional status message to associate with this change

Throws:

NotFoundException - if no job with the given id exists

GenieInvalidStatusException - if the current status of the job identified by id in the system doesn't match the supplied currentStatus. Also if the currentStatus equals the newStatus.

updateJobArchiveStatus

void updateJobArchiveStatus(@NotBlank(message="No job id entered. Unable to update.")
                            @NotBlank(message="No job id entered. Unable to update.") java.lang.String id,
                            @NotNull(message="Status cannot be null.")
                            @NotNull(message="Status cannot be null.") ArchiveStatus archiveStatus)
                     throws NotFoundException

Update the status and status message of the job.

Parameters:

id - The id of the job to update the status for.

archiveStatus - The updated archive status for the job.

Throws:

NotFoundException - If no job with the given id exists

getJobStatus

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

Get the status for a job with the given id.

Parameters:

id - The id of the job to get status for

Returns:

The job status

Throws:

NotFoundException - If no job with the given id exists

getJobArchiveStatus

ArchiveStatus getJobArchiveStatus(@NotBlank
                                  @NotBlank java.lang.String id)
                           throws NotFoundException

Get the archive status for a job with the given id.

Parameters:

id - The id of the job to get status for

Returns:

The job archive status

Throws:

NotFoundException - If no job with the given id exists

getJobArchiveLocation

java.util.Optional<java.lang.String> getJobArchiveLocation(@NotBlank
                                                           @NotBlank java.lang.String id)
                                                    throws NotFoundException

Get the location a job directory was archived to if at all.

Parameters:

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

Returns:

The archive location or Optional.empty()

Throws:

NotFoundException - When there is no job with id id

getFinishedJob

FinishedJob getFinishedJob(@NotBlank
                           @NotBlank java.lang.String id)
                    throws NotFoundException,
                           GenieInvalidStatusException

Get a DTO representing a finished job.

Parameters:

id - The id of the job to retrieve

Returns:

the finished job

Throws:

NotFoundException - if no job with the given id exists

GenieInvalidStatusException - if the current status of the job is not final

isApiJob

boolean isApiJob(@NotBlank
                 @NotBlank java.lang.String id)
          throws NotFoundException

Get whether the job with the given ID was submitted via the REST API or other mechanism.

Parameters:

id - The id of the job. Not blank.

Returns:

true if the job was submitted via the API. false otherwise

Throws:

NotFoundException - If no job with id exists

getJobCluster

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

Get the cluster the job used or is using.

Parameters:

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

Returns:

The Cluster

Throws:

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

getJobCommand

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

Get the command the job used or is using.

Parameters:

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

Returns:

The Command

Throws:

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

getJobApplications

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

Get the applications the job used or is currently using.

Parameters:

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

Returns:

The Applications

Throws:

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

getActiveJobCountForUser

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

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

getUserResourcesSummaries

java.util.Map<java.lang.String,UserResourcesSummary> getUserResourcesSummaries(java.util.Set<JobStatus> statuses,
                                                                               boolean api)

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

Parameters:

statuses - The set of JobStatus a job must be in to be considered in this request

api - Whether the job was submitted via the api (true) or the agent cli (false)

Returns:

a map of user resources summaries, keyed on user name

getUsedMemoryOnHost

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

getActiveJobs

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

Get the set of active jobs.

Returns:

The set of job ids which currently have a status which is considered active

getUnclaimedJobs

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

Get the set of jobs in that have not reached CLAIMED state.

Returns:

The set of job ids for jobs which are active but haven't been claimed

getHostJobInformation

JobInfoAggregate getHostJobInformation(@NotBlank
                                       @NotBlank java.lang.String hostname)

Get all the aggregate metadata information about jobs running on a given hostname.

Parameters:

hostname - The hostname the agent is running the job on

Returns:

A JobInfoAggregate containing the metadata information

getJobsWithStatusAndArchiveStatusUpdatedBefore

java.util.Set<java.lang.String> getJobsWithStatusAndArchiveStatusUpdatedBefore(@NotEmpty
                                                                               @NotEmpty java.util.Set<JobStatus> statuses,
                                                                               @NotEmpty
                                                                               @NotEmpty java.util.Set<ArchiveStatus> archiveStatuses,
                                                                               @NotNull
                                                                               @NotNull java.time.Instant updated)

Get the set of jobs (agent only) whose state is in statuses and archive status is in archiveStatuses and last updated before updated.

Parameters:

statuses - the set of job statuses

archiveStatuses - the set of job archive statuses

updated - the threshold of last update

Returns:

a set of job ids

updateRequestedLauncherExt

void updateRequestedLauncherExt(@NotBlank(message="No job id entered. Unable to update.")
                                @NotBlank(message="No job id entered. Unable to update.") java.lang.String id,
                                @NotNull(message="Status cannot be null.")
                                @NotNull(message="Status cannot be null.") com.fasterxml.jackson.databind.JsonNode launcherExtension)
                         throws NotFoundException

Update the requested launcher extension field for this job.

Parameters:

id - The id of the job to update the laucher extension for.

launcherExtension - The updated requested launcher extension JSON blob.

Throws:

NotFoundException - If no job with the given id exists

getRequestedLauncherExt

com.fasterxml.jackson.databind.JsonNode getRequestedLauncherExt(@NotBlank
                                                                @NotBlank java.lang.String id)
                                                         throws NotFoundException

Get the command the job used or is using.

Parameters:

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

Returns:

The JsonNode passed to the launcher at launch, or a NullNode if none was saved

Throws:

NotFoundException - If no job with the given id exists

updateLauncherExt

void updateLauncherExt(@NotBlank(message="No job id entered. Unable to update.")
                       @NotBlank(message="No job id entered. Unable to update.") java.lang.String id,
                       @NotNull(message="Status cannot be null.")
                       @NotNull(message="Status cannot be null.") com.fasterxml.jackson.databind.JsonNode launcherExtension)
                throws NotFoundException

Update the launcher extension field for this job.

Parameters:

id - The id of the job to update the launcher extension for.

launcherExtension - The updated launcher extension JSON blob.

Throws:

NotFoundException - If no job with the given id exists

getLauncherExt

com.fasterxml.jackson.databind.JsonNode getLauncherExt(@NotBlank
                                                       @NotBlank java.lang.String id)
                                                throws NotFoundException

Get the job requested launcher extension.

Parameters:

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

Returns:

The JsonNode emitted by the launcher at launch

Throws:

NotFoundException - If no job with the given id exists

addConfigsToResource

<R extends CommonResource> void addConfigsToResource(@NotBlank
                                                     @NotBlank java.lang.String id,
                                                     java.util.Set<java.lang.String> configs,
                                                     java.lang.Class<R> resourceClass)
                                              throws NotFoundException

Add configuration files to the existing set for a resource.

Type Parameters:

R - The resource type that the configs should be associated with

Parameters:

id - The id of the resource to add the configuration file to. Not null/empty/blank.

configs - The configuration files to add. Max file length is 1024 characters.

resourceClass - The class of the resource

Throws:

NotFoundException - If no resource of type R with id exists

getConfigsForResource

<R extends CommonResource> java.util.Set<java.lang.String> getConfigsForResource(@NotBlank
                                                                                 @NotBlank java.lang.String id,
                                                                                 java.lang.Class<R> resourceClass)
                                                                          throws NotFoundException

Get the set of configuration files associated with the resource with the given id.

Type Parameters:

R - The resource type that the configs are associated with

Parameters:

id - The id of the resource to get the configuration files for. Not null/empty/blank.

resourceClass - The class of the resource

Returns:

The set of configuration files as paths

Throws:

NotFoundException - If no resource of type R with id exists

updateConfigsForResource

<R extends CommonResource> void updateConfigsForResource(@NotBlank
                                                         @NotBlank java.lang.String id,
                                                         java.util.Set<java.lang.String> configs,
                                                         java.lang.Class<R> resourceClass)
                                                  throws NotFoundException

Update the set of configuration files associated with the resource with the given id.

Type Parameters:

R - The resource type that the configs should be associated with

Parameters:

id - The id of the resource to update the configuration files for. Not null/empty/blank.

configs - The configuration files to replace existing configurations with. Not null/empty.

resourceClass - The class of the resource

Throws:

NotFoundException - If no resource of type R with id exists

removeAllConfigsForResource

<R extends CommonResource> void removeAllConfigsForResource(@NotBlank
                                                            @NotBlank java.lang.String id,
                                                            java.lang.Class<R> resourceClass)
                                                     throws NotFoundException

Remove all configuration files from the resource.

Type Parameters:

R - The resource type that the configs should be associated with

Parameters:

id - The id of the resource to remove the configuration file from. Not null/empty/blank.

resourceClass - The class of the resource

Throws:

NotFoundException - If no resource of type R with id exists

removeConfigForResource

<R extends CommonResource> void removeConfigForResource(@NotBlank
                                                        @NotBlank java.lang.String id,
                                                        @NotBlank
                                                        @NotBlank java.lang.String config,
                                                        java.lang.Class<R> resourceClass)
                                                 throws NotFoundException

Remove a configuration file from the given resource.

Type Parameters:

R - The resource type that the configs should be associated with

Parameters:

id - The id of the resource to remove the configuration file from. Not null/empty/blank.

config - The configuration file to remove. Not null/empty/blank.

resourceClass - The class of the resource

Throws:

NotFoundException - If no resource of type R with id exists

addDependenciesToResource

<R extends CommonResource> void addDependenciesToResource(@NotBlank
                                                          @NotBlank java.lang.String id,
                                                          java.util.Set<java.lang.String> dependencies,
                                                          java.lang.Class<R> resourceClass)
                                                   throws NotFoundException

Add dependency files to the existing set for a resource.

Type Parameters:

R - The resource type that the dependencies should be associated with

Parameters:

id - The id of the resource to add the dependency file to. Not null/empty/blank.

dependencies - The dependency files to add. Max file length is 1024 characters.

resourceClass - The class of the resource

Throws:

NotFoundException - If no resource of type R with id exists

getDependenciesForResource

<R extends CommonResource> java.util.Set<java.lang.String> getDependenciesForResource(@NotBlank
                                                                                      @NotBlank java.lang.String id,
                                                                                      java.lang.Class<R> resourceClass)
                                                                               throws NotFoundException

Get the set of dependency files associated with the resource with the given id.

Type Parameters:

R - The resource type that the dependencies are associated with

Parameters:

id - The id of the resource to get the dependency files for. Not null/empty/blank.

resourceClass - The class of the resource

Returns:

The set of dependency files as paths

Throws:

NotFoundException - If no resource of type R with id exists

updateDependenciesForResource

<R extends CommonResource> void updateDependenciesForResource(@NotBlank
                                                              @NotBlank java.lang.String id,
                                                              java.util.Set<java.lang.String> dependencies,
                                                              java.lang.Class<R> resourceClass)
                                                       throws NotFoundException

Update the set of dependency files associated with the resource with the given id.

Type Parameters:

R - The resource type that the dependencies should be associated with

Parameters:

id - The id of the resource to update the dependency files for. Not null/empty/blank.

dependencies - The dependency files to replace existing dependencys with. Not null/empty.

resourceClass - The class of the resource

Throws:

NotFoundException - If no resource of type R with id exists

removeAllDependenciesForResource

<R extends CommonResource> void removeAllDependenciesForResource(@NotBlank
                                                                 @NotBlank java.lang.String id,
                                                                 java.lang.Class<R> resourceClass)
                                                          throws NotFoundException

Remove all dependency files from the resource.

Type Parameters:

R - The resource type that the dependencies should be associated with

Parameters:

id - The id of the resource to remove the dependency file from. Not null/empty/blank.

resourceClass - The class of the resource

Throws:

NotFoundException - If no resource of type R with id exists

removeDependencyForResource

<R extends CommonResource> void removeDependencyForResource(@NotBlank
                                                            @NotBlank java.lang.String id,
                                                            @NotBlank
                                                            @NotBlank java.lang.String dependency,
                                                            java.lang.Class<R> resourceClass)
                                                     throws NotFoundException

Remove a dependency file from the given resource.

Type Parameters:

R - The resource type that the dependencies should be associated with

Parameters:

id - The id of the resource to remove the dependency file from. Not null/empty/blank.

dependency - The dependency file to remove. Not null/empty/blank.

resourceClass - The class of the resource

Throws:

NotFoundException - If no resource of type R with id exists

addTagsToResource

<R extends CommonResource> void addTagsToResource(@NotBlank
                                                  @NotBlank java.lang.String id,
                                                  java.util.Set<java.lang.String> tags,
                                                  java.lang.Class<R> resourceClass)
                                           throws NotFoundException

Add tags to the existing set for a resource.

Type Parameters:

R - The resource type that the tags should be associated with

Parameters:

id - The id of the resource to add the tags to. Not null/empty/blank.

tags - The tags to add. Max file length is 255 characters.

resourceClass - The class of the resource

Throws:

NotFoundException - If no resource of type R with id exists

getTagsForResource

<R extends CommonResource> java.util.Set<java.lang.String> getTagsForResource(@NotBlank
                                                                              @NotBlank java.lang.String id,
                                                                              java.lang.Class<R> resourceClass)
                                                                       throws NotFoundException

Get the set of tags associated with the resource with the given id.

Type Parameters:

R - The resource type that the tags are associated with

Parameters:

id - The id of the resource to get the tags for. Not null/empty/blank.

resourceClass - The class of the resource

Returns:

The set of tags

Throws:

NotFoundException - If no resource of type R with id exists

updateTagsForResource

<R extends CommonResource> void updateTagsForResource(@NotBlank
                                                      @NotBlank java.lang.String id,
                                                      java.util.Set<java.lang.String> tags,
                                                      java.lang.Class<R> resourceClass)
                                               throws NotFoundException

Update the set of tags associated with the resource with the given id.

Type Parameters:

R - The resource type that the tags should be associated with

Parameters:

id - The id of the resource to update the tags for. Not null/empty/blank.

tags - The tags to replace existing tags with. Not null/empty.

resourceClass - The class of the resource

Throws:

NotFoundException - If no resource of type R with id exists

removeAllTagsForResource

<R extends CommonResource> void removeAllTagsForResource(@NotBlank
                                                         @NotBlank java.lang.String id,
                                                         java.lang.Class<R> resourceClass)
                                                  throws NotFoundException

Remove all tags from the resource.

Type Parameters:

R - The resource type that the tags should be associated with

Parameters:

id - The id of the resource to remove the tags from. Not null/empty/blank.

resourceClass - The class of the resource

Throws:

NotFoundException - If no resource of type R with id exists

removeTagForResource

<R extends CommonResource> void removeTagForResource(@NotBlank
                                                     @NotBlank java.lang.String id,
                                                     @NotBlank
                                                     @NotBlank java.lang.String tag,
                                                     java.lang.Class<R> resourceClass)
                                              throws NotFoundException

Remove a tag from the given resource.

Type Parameters:

R - The resource type that the tag should be associated with

Parameters:

id - The id of the resource to remove the tag from. Not null/empty/blank.

tag - The tag to remove. Not null/empty/blank.

resourceClass - The class of the resource

Throws:

NotFoundException - If no resource of type R with id exists

deleteUnusedTags

long deleteUnusedTags(@NotNull
                      @NotNull java.time.Instant createdThreshold,
                      @Min(value=1L)
                      @Min(value=1L) int batchSize)

Delete all tags from the database that aren't referenced which were created before the supplied created threshold.

Parameters:

createdThreshold - The instant in time where tags created before this time that aren't referenced will be deleted. Inclusive

batchSize - The maximum number of tags to delete in a single transaction

Returns:

The number of tags deleted

deleteUnusedFiles

long deleteUnusedFiles(@NotNull
                       @NotNull java.time.Instant createdThreshold,
                       @Min(value=1L)
                       @Min(value=1L) int batchSize)

Delete all files from the database that aren't referenced which were created before the supplied created threshold.

Parameters:

createdThreshold - The instant in time where files created before this time that aren't referenced will be deleted. Inclusive

batchSize - The maximum number of files to delete in a single transaction

Returns:

The number of files deleted