com.netflix.genie.web.services

Interface ClusterPersistenceService

All Known Implementing Classes:

JpaClusterPersistenceServiceImpl

@Validated
public interface ClusterPersistenceService

Abstraction layer to encapsulate data ClusterConfig functionality.
Classes implementing this abstraction layer must be thread-safe

Method Summary

Modifier and Type	Method and Description
void	addCommandsForCluster(@NotBlank(message="No cluster id entered. Unable to add commands.") java.lang.String id, @NotEmpty(message="No command ids entered. Unable to add commands.") java.util.List<java.lang.String> commandIds) Add commands to the cluster.
void	addConfigsForCluster(@NotBlank(message="No cluster id entered. Unable to add configurations.") java.lang.String id, @NotEmpty(message="No configuration files entered. Unable to add.") java.util.Set<java.lang.String> configs) Add configuration files to the cluster.
void	addDependenciesForCluster(@NotBlank(message="No cluster id entered. Unable to add dependencies.") java.lang.String id, @NotEmpty(message="No dependencies entered. Unable to add dependencies.") java.util.Set<java.lang.String> dependencies) Add dependency files to the cluster.
void	addTagsForCluster(@NotBlank(message="No cluster id entered. Unable to add tags.") java.lang.String id, @NotEmpty(message="No tags entered. Unable to add to tags.") java.util.Set<java.lang.String> tags) Add tags to the cluster.
java.lang.String	createCluster(@NotNull(message="No cluster request entered. Unable to create.") @Valid ClusterRequest request) Create new cluster configuration.
void	deleteAllClusters() Delete all clusters from database.
void	deleteCluster(@NotBlank(message="No id entered unable to delete.") java.lang.String id) Delete a cluster configuration by id.
long	deleteTerminatedClusters() Delete all clusters that are in a terminated state and aren't attached to any jobs.
java.util.Map<Cluster,java.lang.String>	findClustersAndCommandsForCriteria(@NotEmpty java.util.List<Criterion> clusterCriteria, @NotNull Criterion commandCriterion) Find the clusters and commands that can run a job given the criteria the user asked for in the job.
java.util.Map<Cluster,java.lang.String>	findClustersAndCommandsForJob(@NotNull(message="JobRequest object is null. Unable to continue.") JobRequest jobRequest) Find the clusters and commands that can run a job given the criteria the user asked for in the job.
Cluster	getCluster(@NotBlank(message="No id entered. Unable to get.") java.lang.String id) Get the cluster configuration by id.
org.springframework.data.domain.Page<Cluster>	getClusters(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) Get cluster info for various parameters.
java.util.List<Command>	getCommandsForCluster(@NotBlank(message="No cluster id entered. Unable to get commands.") java.lang.String id, java.util.Set<CommandStatus> statuses) Get the set of commands associated with the cluster with given id.
java.util.Set<java.lang.String>	getConfigsForCluster(@NotBlank(message="No cluster id sent. Cannot retrieve configurations.") java.lang.String id) Get the set of configuration files associated with the cluster with given id.
java.util.Set<java.lang.String>	getDependenciesForCluster(@NotBlank(message="No cluster id entered. Unable to get dependencies.") java.lang.String id) Get the set of dependency files associated with the cluster with given id.
java.util.Set<java.lang.String>	getTagsForCluster(@NotBlank(message="No cluster id sent. Cannot retrieve tags.") java.lang.String id) Get the set of tags associated with the cluster with given id.
void	patchCluster(@NotBlank java.lang.String id, @NotNull com.github.fge.jsonpatch.JsonPatch patch) Patch a cluster with the given json patch.
void	removeAllCommandsForCluster(@NotBlank(message="No cluster id entered. Unable to remove commands.") java.lang.String id) Remove all commands from the cluster.
void	removeAllConfigsForCluster(@NotBlank(message="No cluster id entered. Unable to remove configs.") java.lang.String id) Remove all configuration files from the cluster.
void	removeAllDependenciesForCluster(@NotBlank(message="No cluster id entered. Unable to remove dependencies.") java.lang.String id) Remove all dependency files from the cluster.
void	removeAllTagsForCluster(@NotBlank(message="No cluster id entered. Unable to remove tags.") java.lang.String id) Remove all tags from the cluster.
void	removeCommandForCluster(@NotBlank(message="No cluster id entered. Unable to remove command.") java.lang.String id, @NotBlank(message="No command id entered. Unable to remove command.") java.lang.String cmdId) Remove a command from the cluster.
void	removeDependencyForCluster(@NotBlank(message="No cluster id entered. Unable to remove dependency.") java.lang.String id, @NotBlank(message="No dependency entered. Unable to remove dependency.") java.lang.String dependency) Remove a dependency file from the cluster.
void	removeTagForCluster(@NotBlank(message="No cluster id entered. Unable to remove tag.") java.lang.String id, @NotBlank(message="No tag entered. Unable to remove.") java.lang.String tag) Remove a tag from the cluster.
void	setCommandsForCluster(@NotBlank(message="No cluster id entered. Unable to update commands.") java.lang.String id, @NotNull(message="No command ids entered. Unable to update commands.") java.util.List<java.lang.String> commandIds) Update the set of command files associated with the cluster with given id.
void	updateCluster(@NotBlank(message="No cluster id entered. Unable to update.") java.lang.String id, @NotNull(message="No cluster information entered. Unable to update.") @Valid Cluster updateCluster) Update a cluster.
void	updateConfigsForCluster(@NotBlank(message="No cluster id entered. Unable to update configurations.") java.lang.String id, @NotEmpty(message="No configs entered. Unable to update.") java.util.Set<java.lang.String> configs) Update the set of configuration files associated with the cluster with given id.
void	updateDependenciesForCluster(@NotBlank(message="No cluster id entered. Unable to update dependencies.") java.lang.String id, @NotNull(message="No dependencies entered. Unable to update.") java.util.Set<java.lang.String> dependencies) Update the set of dependency files associated with the cluster with given id.
void	updateTagsForCluster(@NotBlank(message="No cluster id entered. Unable to update tags.") java.lang.String id, @NotEmpty(message="No tags entered. Unable to update.") java.util.Set<java.lang.String> tags) Update the set of tags associated with the cluster with given id.

Method Detail

createCluster

java.lang.String createCluster(@NotNull(message="No cluster request entered. Unable to create.") @Valid
                               @NotNull(message="No cluster request entered. Unable to create.") @Valid ClusterRequest request)
                        throws GenieException

Create new cluster configuration.

Parameters:

request - The cluster information to create

Returns:

The created clusters id

Throws:

GenieException - if there is an error

getCluster

Cluster getCluster(@NotBlank(message="No id entered. Unable to get.")
                   @NotBlank(message="No id entered. Unable to get.") java.lang.String id)
            throws GenieException

Get the cluster configuration by id.

Parameters:

id - unique id of cluster configuration to return

Returns:

The cluster configuration

Throws:

GenieException - For any error

getClusters

org.springframework.data.domain.Page<Cluster> getClusters(@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)

Get cluster info for various parameters. Null or empty parameters are ignored.

Parameters:

name - cluster name

statuses - valid types - Types.ClusterStatus

tags - tags allocated to this cluster

minUpdateTime - min time when cluster configuration was updated

maxUpdateTime - max time when cluster configuration was updated

page - The page to get

Returns:

All the clusters matching the criteria

findClustersAndCommandsForJob

java.util.Map<Cluster,java.lang.String> findClustersAndCommandsForJob(@NotNull(message="JobRequest object is null. Unable to continue.")
                                                                      @NotNull(message="JobRequest object is null. Unable to continue.") JobRequest jobRequest)
                                                               throws GenieException

Find the clusters and commands that can run a job given the criteria the user asked for in the job.

Parameters:

jobRequest - The request to runt he job. Not null.

Returns:

a map of cluster to the unique id of the command to use if that cluster is used

Throws:

GenieException - if there is an error

findClustersAndCommandsForCriteria

java.util.Map<Cluster,java.lang.String> findClustersAndCommandsForCriteria(@NotEmpty
                                                                           @NotEmpty java.util.List<Criterion> clusterCriteria,
                                                                           @NotNull
                                                                           @NotNull Criterion commandCriterion)
                                                                    throws GenieException

Find the clusters and commands that can run a job given the criteria the user asked for in the job.

Parameters:

clusterCriteria - The ordered list of cluster criterion provided by user to select a cluster for a job

commandCriterion - The criterion to use to select a command for a job on a cluster

Returns:

a map of cluster to the unique id of the command to use if that cluster is used

Throws:

GenieException - if there is an error

updateCluster

void updateCluster(@NotBlank(message="No cluster id entered. Unable to update.")
                   @NotBlank(message="No cluster id entered. Unable to update.") java.lang.String id,
                   @NotNull(message="No cluster information entered. Unable to update.") @Valid
                   @NotNull(message="No cluster information entered. Unable to update.") @Valid Cluster updateCluster)
            throws GenieException

Update a cluster.

Parameters:

id - The id of the cluster to update

updateCluster - The information to update the cluster with

Throws:

GenieException - if there is an error

patchCluster

void patchCluster(@NotBlank
                  @NotBlank java.lang.String id,
                  @NotNull
                  @NotNull com.github.fge.jsonpatch.JsonPatch patch)
           throws GenieException

Patch a cluster with the given json patch.

Parameters:

id - The id of the cluster to update

patch - The json patch to use to update the given cluster

Throws:

GenieException - if there is an error

deleteAllClusters

void deleteAllClusters()
                throws GenieException

Delete all clusters from database.

Throws:

GenieException - if there is an error

deleteCluster

void deleteCluster(@NotBlank(message="No id entered unable to delete.")
                   @NotBlank(message="No id entered unable to delete.") java.lang.String id)
            throws GenieException

Delete a cluster configuration by id.

Parameters:

id - unique id for cluster to delete

Throws:

GenieException - if there is an error

addConfigsForCluster

void addConfigsForCluster(@NotBlank(message="No cluster id entered. Unable to add configurations.")
                          @NotBlank(message="No cluster id entered. Unable to add configurations.") java.lang.String id,
                          @NotEmpty(message="No configuration files entered. Unable to add.")
                          @NotEmpty(message="No configuration files entered. Unable to add.") java.util.Set<java.lang.String> configs)
                   throws GenieException

Add configuration files to the cluster.

Parameters:

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

configs - The configuration files to add. Not null/empty.

Throws:

GenieException - if there is an error

getConfigsForCluster

java.util.Set<java.lang.String> getConfigsForCluster(@NotBlank(message="No cluster id sent. Cannot retrieve configurations.")
                                                     @NotBlank(message="No cluster id sent. Cannot retrieve configurations.") java.lang.String id)
                                              throws GenieException

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

Parameters:

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

Returns:

The set of configuration files as paths

Throws:

GenieException - if there is an error

updateConfigsForCluster

void updateConfigsForCluster(@NotBlank(message="No cluster id entered. Unable to update configurations.")
                             @NotBlank(message="No cluster id entered. Unable to update configurations.") java.lang.String id,
                             @NotEmpty(message="No configs entered. Unable to update.")
                             @NotEmpty(message="No configs entered. Unable to update.") java.util.Set<java.lang.String> configs)
                      throws GenieException

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

Parameters:

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

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

Throws:

GenieException - if there is an error

removeAllConfigsForCluster

void removeAllConfigsForCluster(@NotBlank(message="No cluster id entered. Unable to remove configs.")
                                @NotBlank(message="No cluster id entered. Unable to remove configs.") java.lang.String id)
                         throws GenieException

Remove all configuration files from the cluster.

Parameters:

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

Throws:

GenieException - if there is an error

addDependenciesForCluster

void addDependenciesForCluster(@NotBlank(message="No cluster id entered. Unable to add dependencies.")
                               @NotBlank(message="No cluster id entered. Unable to add dependencies.") java.lang.String id,
                               @NotEmpty(message="No dependencies entered. Unable to add dependencies.")
                               @NotEmpty(message="No dependencies entered. Unable to add dependencies.") java.util.Set<java.lang.String> dependencies)
                        throws GenieException

Add dependency files to the cluster.

Parameters:

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

dependencies - The dependency files to add. Not null.

Throws:

GenieException - if there is an error

getDependenciesForCluster

java.util.Set<java.lang.String> getDependenciesForCluster(@NotBlank(message="No cluster id entered. Unable to get dependencies.")
                                                          @NotBlank(message="No cluster id entered. Unable to get dependencies.") java.lang.String id)
                                                   throws GenieException

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

Parameters:

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

Returns:

The set of dependency files as paths

Throws:

GenieException - if there is an error

updateDependenciesForCluster

void updateDependenciesForCluster(@NotBlank(message="No cluster id entered. Unable to update dependencies.")
                                  @NotBlank(message="No cluster id entered. Unable to update dependencies.") java.lang.String id,
                                  @NotNull(message="No dependencies entered. Unable to update.")
                                  @NotNull(message="No dependencies entered. Unable to update.") java.util.Set<java.lang.String> dependencies)
                           throws GenieException

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

Parameters:

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

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

Throws:

GenieException - if there is an error

removeAllDependenciesForCluster

void removeAllDependenciesForCluster(@NotBlank(message="No cluster id entered. Unable to remove dependencies.")
                                     @NotBlank(message="No cluster id entered. Unable to remove dependencies.") java.lang.String id)
                              throws GenieException

Remove all dependency files from the cluster.

Parameters:

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

Throws:

GenieException - if there is an error

removeDependencyForCluster

void removeDependencyForCluster(@NotBlank(message="No cluster id entered. Unable to remove dependency.")
                                @NotBlank(message="No cluster id entered. Unable to remove dependency.") java.lang.String id,
                                @NotBlank(message="No dependency entered. Unable to remove dependency.")
                                @NotBlank(message="No dependency entered. Unable to remove dependency.") java.lang.String dependency)
                         throws GenieException

Remove a dependency file from the cluster.

Parameters:

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

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

Throws:

GenieException - if there is an error

addTagsForCluster

void addTagsForCluster(@NotBlank(message="No cluster id entered. Unable to add tags.")
                       @NotBlank(message="No cluster id entered. Unable to add tags.") java.lang.String id,
                       @NotEmpty(message="No tags entered. Unable to add to tags.")
                       @NotEmpty(message="No tags entered. Unable to add to tags.") java.util.Set<java.lang.String> tags)
                throws GenieException

Add tags to the cluster.

Parameters:

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

tags - The tags to add. Not null/empty.

Throws:

GenieException - if there is an error

getTagsForCluster

java.util.Set<java.lang.String> getTagsForCluster(@NotBlank(message="No cluster id sent. Cannot retrieve tags.")
                                                  @NotBlank(message="No cluster id sent. Cannot retrieve tags.") java.lang.String id)
                                           throws GenieException

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

Parameters:

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

Returns:

The set of tags as paths

Throws:

GenieException - if there is an error

updateTagsForCluster

void updateTagsForCluster(@NotBlank(message="No cluster id entered. Unable to update tags.")
                          @NotBlank(message="No cluster id entered. Unable to update tags.") java.lang.String id,
                          @NotEmpty(message="No tags entered. Unable to update.")
                          @NotEmpty(message="No tags entered. Unable to update.") java.util.Set<java.lang.String> tags)
                   throws GenieException

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

Parameters:

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

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

Throws:

GenieException - if there is an error

removeAllTagsForCluster

void removeAllTagsForCluster(@NotBlank(message="No cluster id entered. Unable to remove tags.")
                             @NotBlank(message="No cluster id entered. Unable to remove tags.") java.lang.String id)
                      throws GenieException

Remove all tags from the cluster.

Parameters:

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

Throws:

GenieException - if there is an error

removeTagForCluster

void removeTagForCluster(@NotBlank(message="No cluster id entered. Unable to remove tag.")
                         @NotBlank(message="No cluster id entered. Unable to remove tag.") java.lang.String id,
                         @NotBlank(message="No tag entered. Unable to remove.")
                         @NotBlank(message="No tag entered. Unable to remove.") java.lang.String tag)
                  throws GenieException

Remove a tag from the cluster.

Parameters:

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

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

Throws:

GenieException - if there is an error

addCommandsForCluster

void addCommandsForCluster(@NotBlank(message="No cluster id entered. Unable to add commands.")
                           @NotBlank(message="No cluster id entered. Unable to add commands.") java.lang.String id,
                           @NotEmpty(message="No command ids entered. Unable to add commands.")
                           @NotEmpty(message="No command ids entered. Unable to add commands.") java.util.List<java.lang.String> commandIds)
                    throws GenieException

Add commands to the cluster.

Parameters:

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

commandIds - The ids of the commands to add. Not null/empty.

Throws:

GenieException - if there is an error

getCommandsForCluster

java.util.List<Command> getCommandsForCluster(@NotBlank(message="No cluster id entered. Unable to get commands.")
                                              @NotBlank(message="No cluster id entered. Unable to get commands.") java.lang.String id,
                                              @Nullable
                                              java.util.Set<CommandStatus> statuses)
                                       throws GenieException

Get the set of commands associated with the cluster with given id.

Parameters:

id - The id of the cluster to get the commands for. Not null/empty/blank.

statuses - The statuses to get commands for

Returns:

The list of commands

Throws:

GenieException - if there is an error

setCommandsForCluster

void setCommandsForCluster(@NotBlank(message="No cluster id entered. Unable to update commands.")
                           @NotBlank(message="No cluster id entered. Unable to update commands.") java.lang.String id,
                           @NotNull(message="No command ids entered. Unable to update commands.")
                           @NotNull(message="No command ids entered. Unable to update commands.") java.util.List<java.lang.String> commandIds)
                    throws GenieException

Update the set of command files associated with the cluster with given id.

Parameters:

id - The id of the cluster to update the command files for. Not null/empty/blank.

commandIds - The ids of the commands to replace existing commands with. Not null/empty.

Throws:

GenieException - if there is an error

removeAllCommandsForCluster

void removeAllCommandsForCluster(@NotBlank(message="No cluster id entered. Unable to remove commands.")
                                 @NotBlank(message="No cluster id entered. Unable to remove commands.") java.lang.String id)
                          throws GenieException

Remove all commands from the cluster.

Parameters:

id - The id of the cluster to remove the commands from. Not null/empty/blank.

Throws:

GenieException - if there is an error

removeCommandForCluster

void removeCommandForCluster(@NotBlank(message="No cluster id entered. Unable to remove command.")
                             @NotBlank(message="No cluster id entered. Unable to remove command.") java.lang.String id,
                             @NotBlank(message="No command id entered. Unable to remove command.")
                             @NotBlank(message="No command id entered. Unable to remove command.") java.lang.String cmdId)
                      throws GenieException

Remove a command from the cluster.

Parameters:

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

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

Throws:

GenieException - if there is an error

deleteTerminatedClusters

long deleteTerminatedClusters()

Delete all clusters that are in a terminated state and aren't attached to any jobs.

Returns:

The number of clusters deleted