io.continual.flowcontrol.jobapi

Interface FlowControlJob

All Superinterfaces:

ProtectedResource, Resource

All Known Implementing Classes:

JsonJob

public interface FlowControlJob
extends ProtectedResource

A flow control job is a spec that includes configuration data, secrets, and a runtime system selection.

Method Summary

Modifier and Type	Method and Description
FlowControlJobConfig	getConfiguration() Get the configuration for this job.
String	getName() Get this job's name.
FlowControlRuntimeSpec	getRuntimeSpec() Get the runtime spec for this job.
default Set<String>	getSecretRefs() Get a set of secret references used in this job's deployment.
Map<String,String>	getSecrets() Get a map of secrets and their values
FlowControlJob	registerSecret(String key, String value) Register a secret key and value.
FlowControlJob	removeSecretRef(String key) Remove a secret reference from this job.
FlowControlJob	setConfiguration(FlowControlJobConfig config) Set the configuration for this job.
FlowControlJob	setRuntimeSpec(FlowControlRuntimeSpec runtimeSpec) Set the runtime spec for this job.

Methods inherited from interface io.continual.iam.access.ProtectedResource

getAccessControlList

Methods inherited from interface io.continual.iam.access.Resource

getId

Method Detail

getName

String getName()

Get this job's name.

Returns:

the job's name

getConfiguration

FlowControlJobConfig getConfiguration()

Get the configuration for this job.

Returns:

a configuration

setConfiguration

FlowControlJob setConfiguration(FlowControlJobConfig config)
                         throws IOException

Set the configuration for this job.

Parameters:

config -

Throws:

IOException

getRuntimeSpec

FlowControlRuntimeSpec getRuntimeSpec()

Get the runtime spec for this job.

Returns:

a runtime spec

setRuntimeSpec

FlowControlJob setRuntimeSpec(FlowControlRuntimeSpec runtimeSpec)

Set the runtime spec for this job.

Parameters:

runtimeSpec -

getSecrets

Map<String,String> getSecrets()
                       throws FlowControlJobDb.ServiceException

Get a map of secrets and their values

Returns:

a map of secrets

Throws:

FlowControlJobDb.ServiceException

getSecretRefs

default Set<String> getSecretRefs()
                           throws FlowControlJobDb.ServiceException

Get a set of secret references used in this job's deployment.

Returns:

a list of 0 or more secret references

Throws:

FlowControlJobDb.ServiceException

registerSecret

FlowControlJob registerSecret(String key,
                              String value)
                       throws FlowControlJobDb.ServiceException

Register a secret key and value. The value is encrypted and stored within the FlowControl job database.

Parameters:

key -

value -

Throws:

FlowControlJobDb.ServiceException

removeSecretRef

FlowControlJob removeSecretRef(String key)

Remove a secret reference from this job.

Parameters:

key -