io.continual.flowcontrol.controlapi

Interface FlowControlDeployment

public interface FlowControlDeployment

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FlowControlDeployment.Status

Method Summary

Modifier and Type	Method and Description
String	getId() Get the deployment ID
String	getJobId() Get the job this deployment is running
List<String>	getLog(String instanceId, String sinceRfc3339Time) Get a log listing for a given instance
FlowControlDeployment.Status	getStatus() Get the status of the given deployment
int	instanceCount() Get the deployment's instance count
Set<String>	instances() Get the instance names in this deployment

Method Detail

getId

String getId()

Get the deployment ID

Returns:

a deployment ID

getJobId

String getJobId()

Get the job this deployment is running

Returns:

a job ID

getStatus

FlowControlDeployment.Status getStatus()
                                throws FlowControlDeploymentService.ServiceException

Get the status of the given deployment

Returns:

a status

Throws:

FlowControlDeploymentService.ServiceException

instanceCount

int instanceCount()

Get the deployment's instance count

Returns:

an instance count

instances

Set<String> instances()

Get the instance names in this deployment

Returns:

a set of instance names

getLog

List<String> getLog(String instanceId,
                    String sinceRfc3339Time)
             throws FlowControlDeploymentService.ServiceException,
                    FlowControlDeploymentService.RequestException

Get a log listing for a given instance

Parameters:

instanceId -

sinceRfc3339Time - a time to use as "since", can be null

Returns:

a list of text entries

Throws:

FlowControlDeploymentService.ServiceException

FlowControlDeploymentService.RequestException