io.continual.flowcontrol.controlapi

Interface FlowControlDeploymentService

All Known Implementing Classes:

K8sController

public interface FlowControlDeploymentService

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FlowControlDeploymentService.DeploymentSpec
static interface	FlowControlDeploymentService.DeploymentSpecBuilder
static class	FlowControlDeploymentService.RequestException
static class	FlowControlDeploymentService.ServiceException

Method Summary

Modifier and Type	Method and Description
FlowControlDeployment	deploy(FlowControlCallContext ctx, FlowControlDeploymentService.DeploymentSpec spec) Deploy a job
FlowControlDeploymentService.DeploymentSpecBuilder	deploymentBuilder() Get a deployment spec builder for this deployment service
FlowControlDeployment	getDeployment(FlowControlCallContext ctx, String deploymentId) Get a deployment by its deployment ID
List<FlowControlDeployment>	getDeployments(FlowControlCallContext ctx) Get all deployments
List<FlowControlDeployment>	getDeploymentsForJob(FlowControlCallContext ctx, String jobId) Get deployments of a particular job
void	undeploy(FlowControlCallContext ctx, String deploymentId) Remove a job from deployment

Method Detail

deploymentBuilder

FlowControlDeploymentService.DeploymentSpecBuilder deploymentBuilder()

Get a deployment spec builder for this deployment service

Returns:

deploy

FlowControlDeployment deploy(FlowControlCallContext ctx,
                             FlowControlDeploymentService.DeploymentSpec spec)
                      throws FlowControlDeploymentService.ServiceException,
                             FlowControlDeploymentService.RequestException

Deploy a job

Parameters:

ctx -

spec -

Returns:

a deployment instance

Throws:

FlowControlDeploymentService.ServiceException

FlowControlDeploymentService.RequestException

undeploy

void undeploy(FlowControlCallContext ctx,
              String deploymentId)
       throws FlowControlDeploymentService.ServiceException

Remove a job from deployment

Parameters:

ctx -

deploymentId -

Throws:

FlowControlDeploymentService.ServiceException

getDeployment

FlowControlDeployment getDeployment(FlowControlCallContext ctx,
                                    String deploymentId)
                             throws FlowControlDeploymentService.ServiceException

Get a deployment by its deployment ID

Parameters:

ctx -

deploymentId -

Returns:

a deployment, or null if no such deployment

Throws:

FlowControlDeploymentService.ServiceException

getDeployments

List<FlowControlDeployment> getDeployments(FlowControlCallContext ctx)
                                    throws FlowControlDeploymentService.ServiceException

Get all deployments

Parameters:

ctx -

Returns:

a list of deployments

Throws:

FlowControlDeploymentService.ServiceException

getDeploymentsForJob

List<FlowControlDeployment> getDeploymentsForJob(FlowControlCallContext ctx,
                                                 String jobId)
                                          throws FlowControlDeploymentService.ServiceException

Get deployments of a particular job

Parameters:

ctx -

jobId -

Returns:

a list of deployments

Throws:

FlowControlDeploymentService.ServiceException