Index (worker 4.0.2 API)

A B C D E F G H I J K L M N O P R S T U V W X Z
All Classes All Packages

A

ABANDONED - com.decisionbrain.optimserver.common.enumeration.JobStatus: A job is abandoned if a it was aborted before the job processing had started, or if the timeout has been reached before the job processing had started, or if the destination task queue was full when receiving the message.
abort() - Method in interface com.decisionbrain.platform.run.ExecutionContext: Deprecated.
Use {ExecutionContext.abortWithPolicy(AbortPolicy) instead
abort() - Method in interface com.decisionbrain.platform.run.ExecutionContext.AbortCallback: Deprecated.
abort() - Method in class com.decisionbrain.platform.run.ExecutionContext.DefaultExecutionContext
abort(AbortPolicy) - Method in interface com.decisionbrain.platform.run.ExecutionContext.AbortCallbackWithPolicy
ABORTED - com.decisionbrain.optimserver.common.enumeration.JobStatus: A job is aborted if has been ended by a call to the abortion API, while it is running.
AbortPolicy - Enum in com.decisionbrain.platform.run
abortWithPolicy(AbortPolicy) - Method in interface com.decisionbrain.platform.run.ExecutionContext
abortWithPolicy(AbortPolicy) - Method in class com.decisionbrain.platform.run.ExecutionContext.DefaultExecutionContext
AbstractBucket - Class in com.decisionbrain.optimserver.common.parameter
AbstractBucket() - Constructor for class com.decisionbrain.optimserver.common.parameter.AbstractBucket
AbstractEnumInPropertyCondition<E extends java.lang.Enum<E>,A extends java.lang.annotation.Annotation> - Class in com.decisionbrain.optimserver.common: Abstract class for Condition that uses an enum value in Spring's properties.
AbstractEnumInPropertyCondition(Class<E>, String, E, Class<A>, Function<A, E[]>) - Constructor for class com.decisionbrain.optimserver.common.AbstractEnumInPropertyCondition: Constructor.
AbstractEventDTO - Class in com.decisionbrain.optimserver.common.dto.event: An event has the identifier of the job it is related to, and a timestamp.
AbstractEventDTO() - Constructor for class com.decisionbrain.optimserver.common.dto.event.AbstractEventDTO
AbstractEventDTO(String) - Constructor for class com.decisionbrain.optimserver.common.dto.event.AbstractEventDTO
AbstractEventDTO(String, Instant) - Constructor for class com.decisionbrain.optimserver.common.dto.event.AbstractEventDTO
AbstractMetrics - Class in com.decisionbrain.platform.run.metrics: AbstractMetrics gathers different Metrics that evaluate the same object (eg: a process solution).
AbstractMetrics() - Constructor for class com.decisionbrain.platform.run.metrics.AbstractMetrics
AbstractParameter<T extends AbstractBucket> - Class in com.decisionbrain.optimserver.common.parameter
AbstractParameter() - Constructor for class com.decisionbrain.optimserver.common.parameter.AbstractParameter
AbstractParameter(Map<String, T>) - Constructor for class com.decisionbrain.optimserver.common.parameter.AbstractParameter
AbstractStdioHandler<T> - Class in com.decisionbrain.optimserver.worker.task.protocol: Base class for handler of message of the StdioProtocol.
AbstractStdioHandler(String, TypeReference<T>) - Constructor for class com.decisionbrain.optimserver.worker.task.protocol.AbstractStdioHandler
AbstractStdioMetricsHandler<M extends AbstractMetrics,T> - Class in com.decisionbrain.optimserver.worker.task.protocol: Base class for handlers that support retrieving metrics
AbstractStdioMetricsHandler(Consumer<M>, String, TypeReference<MetricsMessage<T>>) - Constructor for class com.decisionbrain.optimserver.worker.task.protocol.AbstractStdioMetricsHandler
accept(OutputStream) - Method in interface com.decisionbrain.optimserver.worker.api.ParameterData.OutputStreamConsumer
add(String, T) - Method in class com.decisionbrain.platform.run.metrics.AbstractMetrics: Add a metric.
add(String, T, Double) - Method in class com.decisionbrain.platform.run.metrics.AbstractMetrics: Add a metric, including a coefficient.

B

BasicStdioHandler<T> - Class in com.decisionbrain.optimserver.worker.task.protocol
BasicStdioHandler(String, TypeReference<T>, Consumer<T>) - Constructor for class com.decisionbrain.optimserver.worker.task.protocol.BasicStdioHandler
BATCH - com.decisionbrain.optimserver.common.enumeration.WorkerLifecycleMode: Batch: the worker is started with the job id to run has parameter and exit when the job has finished.
BINARY - com.decisionbrain.optimserver.common.parameter.ParameterType: Binary file, not a text content.
BREAK_AND_CONTINUE_FROM_CURRENT_SOLUTION - com.decisionbrain.platform.run.AbortPolicy
BucketData - Class in com.decisionbrain.optimserver.common.parameter: Bucket data are represented as a byte array and metadata stating if the content is zipped, or not.
BucketData() - Constructor for class com.decisionbrain.optimserver.common.parameter.BucketData
BucketData(byte[], boolean) - Constructor for class com.decisionbrain.optimserver.common.parameter.BucketData: Deprecated.
Use BucketData(Supplier, boolean) instead
BucketData(Supplier<InputStream>, boolean) - Constructor for class com.decisionbrain.optimserver.common.parameter.BucketData
BucketDTO - Class in com.decisionbrain.optimserver.common.dto.jobcreation: A bucket DTO reflects the content of a bucket (eg: job input or output).
BucketDTO() - Constructor for class com.decisionbrain.optimserver.common.dto.jobcreation.BucketDTO
BucketDTO.BucketDTOBuilder - Class in com.decisionbrain.optimserver.common.dto.jobcreation: Builder of BucketDTO instances.
BucketReference - Class in com.decisionbrain.optimserver.common.parameter
BucketReference() - Constructor for class com.decisionbrain.optimserver.common.parameter.BucketReference
BucketReference(String) - Constructor for class com.decisionbrain.optimserver.common.parameter.BucketReference
BucketReference(String, boolean) - Constructor for class com.decisionbrain.optimserver.common.parameter.BucketReference
build() - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.BucketDTO.BucketDTOBuilder
build() - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobRelationDTO.JobRelationDTOBuilder
build() - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobSubmitRequestDTO.Builder
build() - Method in class com.decisionbrain.optimserver.worker.api.configuration.JavaTaskDefinition.JavaTaskDefinitionBuilder
build() - Method in class com.decisionbrain.optimserver.worker.api.configuration.TaskParameter.TaskParameterBuilder
build() - Method in class com.decisionbrain.platform.run.metrics.Metric.MetricBuilder
build() - Method in class com.decisionbrain.platform.run.metrics.RunMetrics.RunMetricsBuilder: Deprecated.
build() - Method in class com.decisionbrain.platform.run.output.SolutionMetrics.SolutionMetricsBuilder
build() - Method in class com.decisionbrain.platform.run.progress.ProgressMetrics.ProgressMetricsBuilder
builder() - Static method in class com.decisionbrain.optimserver.common.dto.jobcreation.BucketDTO
builder() - Static method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobRelationDTO
builder() - Static method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobSubmitRequestDTO
builder() - Static method in class com.decisionbrain.optimserver.worker.api.configuration.JavaTaskDefinition
builder() - Static method in class com.decisionbrain.optimserver.worker.api.configuration.TaskParameter
builder() - Static method in class com.decisionbrain.platform.run.metrics.Metric
builder() - Static method in class com.decisionbrain.platform.run.metrics.RunMetrics: Deprecated.
builder() - Static method in class com.decisionbrain.platform.run.output.SolutionMetrics
builder() - Static method in class com.decisionbrain.platform.run.progress.ProgressMetrics
buildMetrics(MetricsMessage<Double>) - Method in class com.decisionbrain.optimserver.worker.task.protocol.ProgressMetricsHandler
buildMetrics(MetricsMessage<Object>) - Method in class com.decisionbrain.optimserver.worker.task.protocol.InstanceMetricsHandler
buildMetrics(MetricsMessage<Object>) - Method in class com.decisionbrain.optimserver.worker.task.protocol.SolutionMetricsHandler
buildMetrics(MetricsMessage<T>) - Method in class com.decisionbrain.optimserver.worker.task.protocol.AbstractStdioMetricsHandler: Construct the metrics object from the deserialized data.
buildSubprocessBridge(ExecutionContext) - Method in class com.decisionbrain.optimserver.worker.task.WorkerShellTask

C

canHandle(String) - Method in class com.decisionbrain.optimserver.worker.task.protocol.AbstractStdioHandler
CHARACTER_ENCODING - Static variable in class com.decisionbrain.optimserver.worker.task.protocol.StdioProtocol
clientApiAuthenticator(JwtAuthPropertiesProvider) - Method in class com.decisionbrain.optimserver.worker.api.configuration.CustomOptimServerClientConfiguration
close() - Method in class com.decisionbrain.optimserver.worker.task.protocol.SubprocessBridge: Close IO and terminate the subprocess if alive
coefficient(Double) - Method in class com.decisionbrain.platform.run.metrics.Metric.MetricBuilder
com.decisionbrain.optimserver.common - package com.decisionbrain.optimserver.common
com.decisionbrain.optimserver.common.dto.event - package com.decisionbrain.optimserver.common.dto.event: This package provides DTOs related to job events.
com.decisionbrain.optimserver.common.dto.event.master - package com.decisionbrain.optimserver.common.dto.event.master
com.decisionbrain.optimserver.common.dto.jobcreation - package com.decisionbrain.optimserver.common.dto.jobcreation: This package provides DTOs to request job creation or start.
com.decisionbrain.optimserver.common.enumeration - package com.decisionbrain.optimserver.common.enumeration: This package provides enumeration types.
com.decisionbrain.optimserver.common.parameter - package com.decisionbrain.optimserver.common.parameter: This package provides definitions for task parameters (inputs or outputs).
com.decisionbrain.optimserver.worker.api - package com.decisionbrain.optimserver.worker.api: This package provides APIs to write a custom worker.
com.decisionbrain.optimserver.worker.api.configuration - package com.decisionbrain.optimserver.worker.api.configuration: This package specifies how to write a valid worker.yml file in a custom worker.
com.decisionbrain.optimserver.worker.api.configuration.condition - package com.decisionbrain.optimserver.worker.api.configuration.condition
com.decisionbrain.optimserver.worker.api.configuration.properties - package com.decisionbrain.optimserver.worker.api.configuration.properties
com.decisionbrain.optimserver.worker.datastorage - package com.decisionbrain.optimserver.worker.datastorage
com.decisionbrain.optimserver.worker.task - package com.decisionbrain.optimserver.worker.task
com.decisionbrain.optimserver.worker.task.protocol - package com.decisionbrain.optimserver.worker.task.protocol
com.decisionbrain.platform.run - package com.decisionbrain.platform.run: This package provides an execution context for externalized CPU intensive processes, like optimization runs.
com.decisionbrain.platform.run.input.configuration - package com.decisionbrain.platform.run.input.configuration: This package provides classes that allow to configure a process.
com.decisionbrain.platform.run.input.instance - package com.decisionbrain.platform.run.input.instance: This package allows to notify metrics related to the instance given as a process input.
com.decisionbrain.platform.run.metrics - package com.decisionbrain.platform.run.metrics: This package specifies what is a metric that can be notified to the context.
com.decisionbrain.platform.run.output - package com.decisionbrain.platform.run.output: This package allows to notify metrics related to the process output solution.
com.decisionbrain.platform.run.progress - package com.decisionbrain.platform.run.progress: This package allows to notify metrics to quantify progress made by the process execution.
CommonPropertyConstants - Class in com.decisionbrain.optimserver.common: Constants (in kebab-case) for the name/key of Spring properties
COMPLETED - com.decisionbrain.optimserver.common.enumeration.JobStatus: A job successfully completed.
ConditionalOnLifecycle - Annotation Type in com.decisionbrain.optimserver.worker.api.configuration.condition
configuration(ConfigurationMetrics) - Method in class com.decisionbrain.platform.run.metrics.RunMetrics.RunMetricsBuilder: Deprecated.
ConfigurationKey - Interface in com.decisionbrain.platform.run.input.configuration: A configuration key has a default value and can be overridden in a ConfigurationMap.
ConfigurationMap - Class in com.decisionbrain.platform.run.input.configuration: A ConfigurationMap allows to request the value of a ConfigurationKey.
ConfigurationMap() - Constructor for class com.decisionbrain.platform.run.input.configuration.ConfigurationMap
ConfigurationMap(ConfigurationMap) - Constructor for class com.decisionbrain.platform.run.input.configuration.ConfigurationMap
ConfigurationMetrics - Class in com.decisionbrain.platform.run.input.configuration: Deprecated.
This could be used for Benchmarks but is currently not.
ConfigurationMetrics(String) - Constructor for class com.decisionbrain.platform.run.input.configuration.ConfigurationMetrics: Deprecated.
configurations(List<ConfigurationMetrics>) - Method in class com.decisionbrain.platform.run.metrics.RunMetrics.RunMetricsBuilder: Deprecated.
containsInput(String) - Method in interface com.decisionbrain.optimserver.worker.api.ExecutionContext: Tells whether this #ExecutionContext contains an input.
COPY - com.decisionbrain.optimserver.common.enumeration.JobRelationType: If a job j2 is a copy of another job j1, then there should be an arc (j1, j2) with this type in the related flow.
createJob(JobCreationDTO) - Method in interface com.decisionbrain.optimserver.worker.api.ExecutionContext: Sends a job creation request to the master and gets the new job identifier.
CustomOptimServerClientConfiguration - Class in com.decisionbrain.optimserver.worker.api.configuration: Customize @OptimServerApiClientConfiguration
CustomOptimServerClientConfiguration() - Constructor for class com.decisionbrain.optimserver.worker.api.configuration.CustomOptimServerClientConfiguration

D

DAEMON - com.decisionbrain.optimserver.common.enumeration.WorkerLifecycleMode: Daemon: the worker is kept alive and consumes jobs from the Rabbitmq queues.
data(byte[]) - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.BucketDTO.BucketDTOBuilder: Deprecated.
Use only for backward compatibility, bucket content should be stored in GridFS and retrieved separately
DEFAULT_JWT_HEADER - Static variable in interface com.decisionbrain.optimserver.worker.api.configuration.JwtAuthPropertiesProvider
DEFAULT_JWT_KEY - Static variable in interface com.decisionbrain.optimserver.worker.api.configuration.JwtAuthPropertiesProvider
DEFAULT_JWT_TOKEN_TTL_INS_ECS - Static variable in interface com.decisionbrain.optimserver.worker.api.configuration.JwtAuthPropertiesProvider
DefaultExecutionContext() - Constructor for class com.decisionbrain.platform.run.ExecutionContext.DefaultExecutionContext
description(String) - Method in class com.decisionbrain.optimserver.worker.api.configuration.JavaTaskDefinition.JavaTaskDefinitionBuilder
description(String) - Method in class com.decisionbrain.optimserver.worker.api.configuration.TaskParameter.TaskParameterBuilder
determinePersistenceState(URI) - Method in class com.decisionbrain.optimserver.worker.datastorage.MasterApiDataStorage

E

elapsedTime - Variable in class com.decisionbrain.platform.run.output.SolutionMetrics
elapsedTime(long) - Method in class com.decisionbrain.platform.run.metrics.RunMetrics.RunMetricsBuilder: Deprecated.
elapsedTime(long) - Method in class com.decisionbrain.platform.run.output.SolutionMetrics.SolutionMetricsBuilder
emit(String, byte[]) - Method in class com.decisionbrain.optimserver.common.parameter.Parameter: Deprecated.
Use ExecutionContext.notifyOutput instead
emit(String, byte[], boolean) - Method in class com.decisionbrain.optimserver.common.parameter.Parameter: Deprecated.
Use ExecutionContext.notifyOutput instead
EnableOptimServerWorker - Annotation Type in com.decisionbrain.optimserver.worker.api: Annotation to enable an optimserver worker.
equals(Object) - Method in class com.decisionbrain.optimserver.common.dto.event.AbstractEventDTO
equals(Object) - Method in class com.decisionbrain.optimserver.common.dto.event.OutputParameterDTO
equals(Object) - Method in class com.decisionbrain.optimserver.common.dto.event.SolutionDTO
equals(Object) - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.BucketDTO
equals(Object) - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobParameterDTO
equals(Object) - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobRelationDTO
equals(Object) - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobSubmitRequestDTO
equals(Object) - Method in class com.decisionbrain.optimserver.common.parameter.BucketData
equals(Object) - Method in class com.decisionbrain.optimserver.common.parameter.BucketReference
equals(Object) - Method in class com.decisionbrain.optimserver.common.parameter.Parameter
equals(Object) - Method in class com.decisionbrain.optimserver.common.parameter.SolutionParameter
equals(Object) - Method in class com.decisionbrain.optimserver.worker.api.ParameterData
equals(Object) - Method in class com.decisionbrain.optimserver.worker.task.protocol.StopMessage
equals(Object) - Method in class com.decisionbrain.platform.run.input.configuration.ConfigurationMetrics: Deprecated.
equals(Object) - Method in class com.decisionbrain.platform.run.input.instance.InstanceMetrics
equals(Object) - Method in class com.decisionbrain.platform.run.metrics.AbstractMetrics
equals(Object) - Method in class com.decisionbrain.platform.run.metrics.Metric
equals(Object) - Method in class com.decisionbrain.platform.run.metrics.RunMetrics: Deprecated.
equals(Object) - Method in class com.decisionbrain.platform.run.output.SolutionMetrics
equals(Object) - Method in class com.decisionbrain.platform.run.progress.ProgressMetrics
execute(Parameter, Parameter, ExecutionContext) - Method in interface com.decisionbrain.optimserver.worker.api.Task: This method should run a job derived from the task, given the inputs and execution context.
execute(Parameter, Parameter, ExecutionContext) - Method in class com.decisionbrain.optimserver.worker.task.WorkerShellTask
ExecutionContext - Interface in com.decisionbrain.optimserver.worker.api: An execution context allows a job to notify metrics, and to be aborted, during its execution.
ExecutionContext - Interface in com.decisionbrain.platform.run: This is the interface for the solver execution context.
ExecutionContext.AbortCallback - Interface in com.decisionbrain.platform.run: Deprecated.
Use ExecutionContext.AbortCallbackWithPolicy instead.
ExecutionContext.AbortCallbackWithPolicy - Interface in com.decisionbrain.platform.run
ExecutionContext.DefaultExecutionContext - Class in com.decisionbrain.platform.run: This default execution context just logs the received metrics.
ExecutionContext.NoLogExecutionContext - Class in com.decisionbrain.platform.run: This execution context does not do anything with the received metrics.

F

FAILED - com.decisionbrain.optimserver.common.enumeration.JobStatus: A job is failed if an error occurred while it was processed on a worker.
findBlob(URI) - Method in class com.decisionbrain.optimserver.worker.datastorage.MasterApiDataStorage
flowId(String) - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobSubmitRequestDTO.Builder
flowParent(JobRelationDTO) - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobCreationDTO.JobCreationDTOBuilder

G

get(ConfigurationKey) - Method in class com.decisionbrain.platform.run.input.configuration.ConfigurationMap
get(Object) - Method in class com.decisionbrain.platform.run.input.configuration.ConfigurationMap
get(String) - Method in class com.decisionbrain.optimserver.common.parameter.Parameter: Deprecated.
Use ExecutionContext.getInput instead
get(String) - Method in class com.decisionbrain.platform.run.input.configuration.ConfigurationMap
getAllTaskDefinitions() - Method in class com.decisionbrain.optimserver.worker.api.configuration.WorkerYamlConfiguration
getAs(String, Class<T>) - Method in class com.decisionbrain.optimserver.common.parameter.Parameter: Deprecated.
Use ExecutionContext.getInput instead
getBucket() - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobParameterDTO
getBucket(BucketReference) - Method in interface com.decisionbrain.optimserver.worker.api.ExecutionContext: Retrieve and return a Bucket.
getBucketData() - Method in class com.decisionbrain.optimserver.common.parameter.AbstractParameter
getBucketFile(BucketReference) - Method in interface com.decisionbrain.optimserver.worker.api.ExecutionContext: Retrieve and return the content of a Bucket into a File object.
getBucketId() - Method in class com.decisionbrain.optimserver.common.parameter.BucketReference
getBucketValue(String) - Method in class com.decisionbrain.optimserver.common.parameter.AbstractParameter
getCleanParameterFiles() - Method in class com.decisionbrain.optimserver.worker.api.configuration.properties.ShellProperties
getCoefficient() - Method in class com.decisionbrain.optimserver.worker.task.protocol.MetricMessage
getCoefficient() - Method in class com.decisionbrain.platform.run.metrics.Metric
getCommand() - Method in class com.decisionbrain.optimserver.worker.api.configuration.ShellTaskDefinition
getConfigurationId() - Method in class com.decisionbrain.platform.run.input.configuration.ConfigurationMetrics: Deprecated.
getConfigurations() - Method in class com.decisionbrain.platform.run.metrics.RunMetrics: Deprecated.
getCreationDate() - Method in class com.decisionbrain.platform.run.metrics.RunMetrics: Deprecated.
getData() - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.BucketDTO: Deprecated.
Use only for backward compatibility, bucket content should be stored in GridFS and retrieved separately
getData() - Method in class com.decisionbrain.optimserver.common.parameter.BucketData: Deprecated.
Use ExecutionContext.getInput instead
getDataStorageUri() - Method in class com.decisionbrain.optimserver.common.dto.event.OutputParameterDTO
getDefaultValue() - Method in interface com.decisionbrain.platform.run.input.configuration.ConfigurationKey: Returns the default value of the configuration.
getDescription() - Method in class com.decisionbrain.optimserver.worker.api.configuration.TaskDefinition: This method allows to retrieve the description of the task.
getDescription() - Method in class com.decisionbrain.optimserver.worker.api.configuration.TaskParameter: The description of the parameter (free text).
getElapsedTime() - Method in class com.decisionbrain.optimserver.worker.task.protocol.MetricsMessage
getElapsedTime() - Method in class com.decisionbrain.platform.run.ExecutionContext.DefaultExecutionContext
getElapsedTime() - Method in interface com.decisionbrain.platform.run.ExecutionContext: Return the elapsed time since the creation of this context, in milliseconds.
getElapsedTime() - Method in class com.decisionbrain.platform.run.metrics.RunMetrics: Deprecated.
getElapsedTime() - Method in class com.decisionbrain.platform.run.output.SolutionMetrics
getFlowId() - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobSubmitRequestDTO
getFlowId() - Method in interface com.decisionbrain.optimserver.worker.api.ExecutionContext: This method allows to retrieve the identifier of the flow the running job is associated with.
getGroup() - Method in class com.decisionbrain.optimserver.worker.api.configuration.TaskDefinition
getId() - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.BucketDTO
getId() - Method in class com.decisionbrain.optimserver.worker.api.configuration.TaskDefinition: The method allows to retrieve the identifier of the task, that should be unique.
getImplementationClassName() - Method in class com.decisionbrain.optimserver.worker.api.configuration.JavaTaskDefinition: This method allows to retrieve the name of the class that implements the task.
getInputData(String) - Method in interface com.decisionbrain.optimserver.worker.api.ExecutionContext: Returns an input (as ParameterData).
getInputNames() - Method in interface com.decisionbrain.optimserver.worker.api.ExecutionContext: Return a list that contains the name of all inputs.
getInputPath(String) - Method in class com.decisionbrain.optimserver.worker.task.protocol.SubprocessBridge
getInputResource(String) - Method in interface com.decisionbrain.optimserver.worker.api.ExecutionContext: Returns an input (as Resource).
getInputs() - Method in class com.decisionbrain.optimserver.worker.api.configuration.TaskDefinition: This method allows to retrieve the list of task inputs (optional and mandatory ones).
getInputsPath() - Method in class com.decisionbrain.optimserver.worker.task.protocol.SubprocessBridge
getInstanceId() - Method in class com.decisionbrain.optimserver.worker.task.protocol.MetricsMessage
getInstanceId() - Method in class com.decisionbrain.platform.run.input.instance.InstanceMetrics
getInstanceName() - Method in class com.decisionbrain.platform.run.metrics.RunMetrics: Deprecated.
getJavaTaskDefinitions() - Method in class com.decisionbrain.optimserver.worker.api.configuration.WorkerYamlConfiguration: This method allows to retrieve the list of task definitions for the given worker.
getJobId() - Method in class com.decisionbrain.optimserver.common.dto.event.AbstractEventDTO
getJobId() - Method in interface com.decisionbrain.optimserver.worker.api.ExecutionContext: This method allows to retrieve the identifier of the running job it is associated with.
getJobStatus() - Method in class com.decisionbrain.optimserver.common.dto.event.SolutionDTO
getJwtHeader() - Method in interface com.decisionbrain.optimserver.worker.api.configuration.JwtAuthPropertiesProvider
getJwtKey() - Method in interface com.decisionbrain.optimserver.worker.api.configuration.JwtAuthPropertiesProvider
getJwtTokenTTLInSecs() - Method in interface com.decisionbrain.optimserver.worker.api.configuration.JwtAuthPropertiesProvider
getKpis() - Method in class com.decisionbrain.platform.run.metrics.RunMetrics: Deprecated.
getMessage() - Method in class com.decisionbrain.optimserver.common.dto.event.SolutionDTO
getMessage() - Method in class com.decisionbrain.optimserver.worker.task.protocol.MetricsMessage
getMessage() - Method in class com.decisionbrain.platform.run.progress.ProgressMetrics
getModels() - Method in class com.decisionbrain.platform.run.metrics.RunMetrics: Deprecated.
getName() - Method in class com.decisionbrain.optimserver.common.dto.event.OutputParameterDTO
getName() - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobParameterDTO
getName() - Method in class com.decisionbrain.optimserver.worker.api.configuration.TaskParameter: The name of the parameter, its identifier.
getName() - Method in class com.decisionbrain.optimserver.worker.task.protocol.MetricMessage
getName() - Method in class com.decisionbrain.optimserver.worker.task.protocol.OutputMessage
getName() - Method in interface com.decisionbrain.platform.run.input.configuration.ConfigurationKey: Returns the name of the configuration.
getName() - Method in class com.decisionbrain.platform.run.metrics.Metric
getOptimizationModels() - Method in class com.decisionbrain.platform.run.metrics.RunMetrics: Deprecated.
getOutputPath(String) - Method in class com.decisionbrain.optimserver.worker.task.protocol.SubprocessBridge
getOutputs() - Method in class com.decisionbrain.optimserver.worker.api.configuration.TaskDefinition: This method allows to retrieve the list of possible task outputs.
getOutputsPath() - Method in class com.decisionbrain.optimserver.worker.task.protocol.SubprocessBridge
getParameterFilesLocation() - Method in class com.decisionbrain.optimserver.worker.api.configuration.properties.ShellProperties
getParameters() - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobSubmitRequestDTO
getParameters() - Method in class com.decisionbrain.optimserver.common.parameter.Parameter: Deprecated.
Use ExecutionContext.getInputNames instead
getParametersPath() - Method in class com.decisionbrain.optimserver.worker.task.protocol.SubprocessBridge
getPolicy() - Method in class com.decisionbrain.optimserver.worker.task.protocol.StopMessage
getPolicyIfShouldAbort() - Method in class com.decisionbrain.platform.run.ExecutionContext.DefaultExecutionContext
getPolicyIfShouldAbort() - Method in interface com.decisionbrain.platform.run.ExecutionContext: This method returns the abort policy to use if the running job should abort.
getProperties() - Method in class com.decisionbrain.optimserver.worker.api.configuration.TaskDefinition: This method allows to retrieve a map of additional properties that you want to set on the task.
getReason() - Method in enum com.decisionbrain.platform.run.AbortPolicy
getRejectMessage() - Method in interface com.decisionbrain.optimserver.worker.api.ExecutionContext: Gets the reject message if any.
getRelatedJobId() - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobRelationDTO
getRelationType() - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobRelationDTO
getScriptedTaskDefinition() - Method in class com.decisionbrain.optimserver.worker.api.configuration.WorkerYamlConfiguration: Deprecated.
Replaced by WorkerYamlConfiguration.getShellTaskDefinition()
getShellTaskDefinition() - Method in class com.decisionbrain.optimserver.worker.api.configuration.WorkerYamlConfiguration
getSolution() - Method in class com.decisionbrain.optimserver.common.dto.event.SolutionDTO
getSolutions() - Method in class com.decisionbrain.platform.run.metrics.RunMetrics: Deprecated.
getTaskDefinition(String) - Method in class com.decisionbrain.optimserver.worker.api.configuration.WorkerYamlConfiguration
getTaskId() - Method in class com.decisionbrain.optimserver.common.dto.event.SolutionDTO
getTaskId() - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobSubmitRequestDTO
getTaskId() - Method in exception com.decisionbrain.optimserver.worker.api.UnknownTaskException
getTimeout() - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobSubmitRequestDTO
getTimestamp() - Method in class com.decisionbrain.optimserver.common.dto.event.AbstractEventDTO
getType() - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.BucketDTO
getType() - Method in class com.decisionbrain.optimserver.worker.api.configuration.TaskParameter: The type of the parameter: should it be an XML file, a number, etc.
getValue() - Method in enum com.decisionbrain.optimserver.common.enumeration.JobRelationType
getValue() - Method in enum com.decisionbrain.optimserver.common.enumeration.JobStatus
getValue() - Method in class com.decisionbrain.optimserver.worker.task.protocol.MetricMessage
getValue() - Method in class com.decisionbrain.platform.run.metrics.Metric
getValue(String) - Method in class com.decisionbrain.platform.run.metrics.AbstractMetrics: Return the value of the dimension as a character string.
getValues() - Method in class com.decisionbrain.optimserver.worker.task.protocol.MetricsMessage
getValues() - Method in class com.decisionbrain.platform.run.metrics.AbstractMetrics: Return the map of dimensions of the model values
getWorkingDirectory() - Method in class com.decisionbrain.optimserver.worker.api.configuration.ShellTaskDefinition
group(String) - Method in class com.decisionbrain.optimserver.worker.api.configuration.JavaTaskDefinition.JavaTaskDefinitionBuilder

H

handle(MetricsMessage<T>) - Method in class com.decisionbrain.optimserver.worker.task.protocol.AbstractStdioMetricsHandler
handle(String) - Method in class com.decisionbrain.optimserver.worker.task.protocol.AbstractStdioHandler
handle(T) - Method in class com.decisionbrain.optimserver.worker.task.protocol.AbstractStdioHandler
handle(T) - Method in class com.decisionbrain.optimserver.worker.task.protocol.BasicStdioHandler
hashCode() - Method in class com.decisionbrain.optimserver.common.dto.event.AbstractEventDTO
hashCode() - Method in class com.decisionbrain.optimserver.common.dto.event.OutputParameterDTO
hashCode() - Method in class com.decisionbrain.optimserver.common.dto.event.SolutionDTO
hashCode() - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.BucketDTO
hashCode() - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobParameterDTO
hashCode() - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobRelationDTO
hashCode() - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobSubmitRequestDTO
hashCode() - Method in class com.decisionbrain.optimserver.common.parameter.AbstractParameter
hashCode() - Method in class com.decisionbrain.optimserver.common.parameter.BucketData
hashCode() - Method in class com.decisionbrain.optimserver.common.parameter.BucketReference
hashCode() - Method in class com.decisionbrain.optimserver.worker.api.ParameterData
hashCode() - Method in class com.decisionbrain.optimserver.worker.task.protocol.StopMessage
hashCode() - Method in class com.decisionbrain.platform.run.input.configuration.ConfigurationMetrics: Deprecated.
hashCode() - Method in class com.decisionbrain.platform.run.input.instance.InstanceMetrics
hashCode() - Method in class com.decisionbrain.platform.run.metrics.AbstractMetrics
hashCode() - Method in class com.decisionbrain.platform.run.metrics.Metric
hashCode() - Method in class com.decisionbrain.platform.run.metrics.RunMetrics: Deprecated.
hashCode() - Method in class com.decisionbrain.platform.run.output.SolutionMetrics
hashCode() - Method in class com.decisionbrain.platform.run.progress.ProgressMetrics

I

id(String) - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.BucketDTO.BucketDTOBuilder
id(String) - Method in class com.decisionbrain.optimserver.worker.api.configuration.JavaTaskDefinition.JavaTaskDefinitionBuilder
implementationClassName(String) - Method in class com.decisionbrain.optimserver.worker.api.configuration.JavaTaskDefinition.JavaTaskDefinitionBuilder
input(JobParameterDTO) - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobCreationDTO.JobCreationDTOBuilder
inputs(List<TaskParameter>) - Method in class com.decisionbrain.optimserver.worker.api.configuration.JavaTaskDefinition.JavaTaskDefinitionBuilder
INPUTS_DIR - Static variable in class com.decisionbrain.optimserver.worker.task.protocol.SubprocessEnv: Environment variable that holds the folder that contains input parameters.
INSTANCE_METRICS - Static variable in class com.decisionbrain.optimserver.worker.task.protocol.StdioProtocol
InstanceMetrics - Class in com.decisionbrain.platform.run.input.instance: This class contains information on a given model e.g.
InstanceMetrics(String) - Constructor for class com.decisionbrain.platform.run.input.instance.InstanceMetrics
InstanceMetricsHandler - Class in com.decisionbrain.optimserver.worker.task.protocol: Handle instance metrics messages.
InstanceMetricsHandler(Consumer<InstanceMetrics>) - Constructor for class com.decisionbrain.optimserver.worker.task.protocol.InstanceMetricsHandler
instanceName(String) - Method in class com.decisionbrain.platform.run.metrics.RunMetrics.RunMetricsBuilder: Deprecated.
isFailure() - Method in enum com.decisionbrain.optimserver.common.enumeration.JobStatus
isFallback() - Method in class com.decisionbrain.optimserver.worker.datastorage.MasterApiDataStorage
isLast() - Method in enum com.decisionbrain.optimserver.common.enumeration.JobStatus
isProtocolMessage(String) - Static method in class com.decisionbrain.optimserver.worker.task.protocol.StdioProtocol
isRequired() - Method in class com.decisionbrain.optimserver.worker.api.configuration.TaskParameter: Is the parameter mandatory or optional for jobs derived from this task.
isZipped() - Method in class com.decisionbrain.optimserver.common.dto.event.OutputParameterDTO
isZipped() - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.BucketDTO
isZipped() - Method in class com.decisionbrain.optimserver.worker.api.ParameterData: Whether the data are zipped.
isZipped() - Method in class com.decisionbrain.optimserver.worker.task.protocol.OutputMessage
isZipped(String) - Method in class com.decisionbrain.optimserver.common.parameter.AbstractParameter
isZipped(String) - Method in class com.decisionbrain.optimserver.common.parameter.Parameter

J

JavaTaskDefinition - Class in com.decisionbrain.optimserver.worker.api.configuration
JavaTaskDefinition() - Constructor for class com.decisionbrain.optimserver.worker.api.configuration.JavaTaskDefinition
JavaTaskDefinition(String, String, String, List<TaskParameter>, List<TaskParameter>, Map<String, Object>, String) - Constructor for class com.decisionbrain.optimserver.worker.api.configuration.JavaTaskDefinition
JavaTaskDefinition.JavaTaskDefinitionBuilder - Class in com.decisionbrain.optimserver.worker.api.configuration: Builder for a JavaTaskDefinition object.
JobCreationDTO - Class in com.decisionbrain.optimserver.common.dto.jobcreation: A job creation DTO allows to request job creation (not start), giving needed job inputs.
JobCreationDTO() - Constructor for class com.decisionbrain.optimserver.common.dto.jobcreation.JobCreationDTO
JobCreationDTO.JobCreationDTOBuilder - Class in com.decisionbrain.optimserver.common.dto.jobcreation: Builder of JobCreationDTO instances.
JobCreationDTOBuilder() - Constructor for class com.decisionbrain.optimserver.common.dto.jobcreation.JobCreationDTO.JobCreationDTOBuilder
JobFlag - Enum in com.decisionbrain.optimserver.common.enumeration: Flags on job that add information.
jobId(String) - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobSubmitRequestDTO.Builder
JobParameterDTO - Class in com.decisionbrain.optimserver.common.dto.jobcreation: A job parameter is a named BucketDTO.
JobParameterDTO() - Constructor for class com.decisionbrain.optimserver.common.dto.jobcreation.JobParameterDTO
JobParameterDTO(String, BucketDTO) - Constructor for class com.decisionbrain.optimserver.common.dto.jobcreation.JobParameterDTO
JobRelationDTO - Class in com.decisionbrain.optimserver.common.dto.jobcreation: A job relation DTO describes the relation a job has with another job in a flow.
JobRelationDTO() - Constructor for class com.decisionbrain.optimserver.common.dto.jobcreation.JobRelationDTO
JobRelationDTO.JobRelationDTOBuilder - Class in com.decisionbrain.optimserver.common.dto.jobcreation: Builder of JobRelationDTO instances.
JobRelationType - Enum in com.decisionbrain.optimserver.common.enumeration: This enumeration defines possible relations between jobs, in a job flow.
JobStartRequestDTO - Class in com.decisionbrain.optimserver.common.dto.jobcreation
JobStartRequestDTO() - Constructor for class com.decisionbrain.optimserver.common.dto.jobcreation.JobStartRequestDTO
JobStartRequestDTO(String) - Constructor for class com.decisionbrain.optimserver.common.dto.jobcreation.JobStartRequestDTO
JobStatus - Enum in com.decisionbrain.optimserver.common.enumeration: This enumeration defines possible execution statuses for a job.
JobSubmitRequestDTO - Class in com.decisionbrain.optimserver.common.dto.jobcreation: Request to start a job.
JobSubmitRequestDTO() - Constructor for class com.decisionbrain.optimserver.common.dto.jobcreation.JobSubmitRequestDTO
JobSubmitRequestDTO(String, String, List<JobParameterDTO>, Long) - Constructor for class com.decisionbrain.optimserver.common.dto.jobcreation.JobSubmitRequestDTO: Deprecated.
Deprecated constructor.
JobSubmitRequestDTO.Builder - Class in com.decisionbrain.optimserver.common.dto.jobcreation: Builder of JobSubmitRequestDTO instances.
JSON - com.decisionbrain.optimserver.common.parameter.ParameterType: A parameter can be a Json file.
JwtAuthPropertiesProvider - Interface in com.decisionbrain.optimserver.worker.api.configuration

K

kpi(String, Double) - Method in class com.decisionbrain.platform.run.metrics.RunMetrics.RunMetricsBuilder: Deprecated.
kpis(Map<String, Double>) - Method in class com.decisionbrain.platform.run.metrics.RunMetrics.RunMetricsBuilder: Deprecated.

L

loadAsBytes() - Method in class com.decisionbrain.optimserver.worker.api.ParameterData: Loads the input content into a byte array.
loadAsString() - Method in class com.decisionbrain.optimserver.worker.api.ParameterData: Loads the input content into a string.

M

MasterApiDataStorage - Class in com.decisionbrain.optimserver.worker.datastorage
MasterApiDataStorage(DataStorageApi) - Constructor for class com.decisionbrain.optimserver.worker.datastorage.MasterApiDataStorage
MasterClientProperties - Class in com.decisionbrain.optimserver.worker.api.configuration
MasterClientProperties() - Constructor for class com.decisionbrain.optimserver.worker.api.configuration.MasterClientProperties
masterJwtAuthPropertiesProvider() - Method in class com.decisionbrain.optimserver.worker.api.configuration.CustomOptimServerClientConfiguration
matches(ConditionContext, AnnotatedTypeMetadata) - Method in class com.decisionbrain.optimserver.common.AbstractEnumInPropertyCondition
message(String) - Method in class com.decisionbrain.platform.run.progress.ProgressMetrics.ProgressMetricsBuilder
metric(String, T) - Method in class com.decisionbrain.platform.run.output.SolutionMetrics.SolutionMetricsBuilder
metric(String, T, double) - Method in class com.decisionbrain.platform.run.output.SolutionMetrics.SolutionMetricsBuilder
Metric<T> - Class in com.decisionbrain.platform.run.metrics: A metric value evaluates input, output or progress of a process.
Metric.MetricBuilder<T> - Class in com.decisionbrain.platform.run.metrics: Builder for Metric instances.
MetricMessage<T> - Class in com.decisionbrain.optimserver.worker.task.protocol: Represent one metric that is received from a subprocess.
MetricMessage() - Constructor for class com.decisionbrain.optimserver.worker.task.protocol.MetricMessage
MetricMessage(String, T, Double) - Constructor for class com.decisionbrain.optimserver.worker.task.protocol.MetricMessage
MetricsMessage<T> - Class in com.decisionbrain.optimserver.worker.task.protocol: Represent several metrics that is received from a subprocess.
MetricsMessage() - Constructor for class com.decisionbrain.optimserver.worker.task.protocol.MetricsMessage
model(InstanceMetrics) - Method in class com.decisionbrain.platform.run.metrics.RunMetrics.RunMetricsBuilder: Deprecated.
models(List<InstanceMetrics>) - Method in class com.decisionbrain.platform.run.metrics.RunMetrics.RunMetricsBuilder: Deprecated.

N

name(String) - Method in class com.decisionbrain.optimserver.worker.api.configuration.TaskParameter.TaskParameterBuilder
name(String) - Method in class com.decisionbrain.platform.run.metrics.Metric.MetricBuilder
NoLogExecutionContext() - Constructor for class com.decisionbrain.platform.run.ExecutionContext.NoLogExecutionContext
notifyInstanceMetrics(InstanceMetrics) - Method in class com.decisionbrain.platform.run.ExecutionContext.DefaultExecutionContext
notifyInstanceMetrics(InstanceMetrics) - Method in class com.decisionbrain.platform.run.ExecutionContext.NoLogExecutionContext
notifyInstanceMetrics(InstanceMetrics) - Method in interface com.decisionbrain.platform.run.ExecutionContext: Add a new optimization model statistics in this context.
notifyKpi(String, T) - Method in interface com.decisionbrain.optimserver.worker.api.ExecutionContext: Deprecated.
use notifySolutionMetrics instead This method allows to notify a Key Performance Indicator relative to the job execution inside a worker. If this KPI has a numeric value, it will be plotted as a line in the Web Console chart in real time.
notifyKpi(String, T, Double) - Method in interface com.decisionbrain.optimserver.worker.api.ExecutionContext: Deprecated.
use notifySolutionMetrics instead This method allows to notify a Key Performance Indicator relative to the job execution inside a worker. If this KPI has a numeric value, it will be plotted as a stacked area in the Web Console chart in real time, along with the other KPIs with a coefficient, on the same scale.
notifyMessage(String) - Method in interface com.decisionbrain.optimserver.worker.api.ExecutionContext: Deprecated.
use a standard logger in the worker instead This method allows to notify a string message.
notifyOutput(String, ParameterData) - Method in interface com.decisionbrain.optimserver.worker.api.ExecutionContext: Notify (send immediately) an output parameter from a ParameterData.
notifyProgress(String, String, double) - Method in interface com.decisionbrain.optimserver.worker.api.ExecutionContext: Deprecated.
use notifyProgressMetrics instead This method allows to notify a progress on the job inside a worker.
notifyProgressMetrics(ProgressMetrics) - Method in class com.decisionbrain.platform.run.ExecutionContext.DefaultExecutionContext
notifyProgressMetrics(ProgressMetrics) - Method in class com.decisionbrain.platform.run.ExecutionContext.NoLogExecutionContext
notifyProgressMetrics(ProgressMetrics) - Method in interface com.decisionbrain.platform.run.ExecutionContext: This method allows to notify progress metrics while a process is running.
notifySolutionMetrics(SolutionMetrics) - Method in class com.decisionbrain.platform.run.ExecutionContext.DefaultExecutionContext
notifySolutionMetrics(SolutionMetrics) - Method in class com.decisionbrain.platform.run.ExecutionContext.NoLogExecutionContext
notifySolutionMetrics(SolutionMetrics) - Method in interface com.decisionbrain.platform.run.ExecutionContext: Add a new solution statistics to this context.
NUMERIC - com.decisionbrain.optimserver.common.parameter.ParameterType: A parameter can be a string readable as an number.

O

of(byte[]) - Static method in class com.decisionbrain.optimserver.worker.api.ParameterData: Creates a ParameterData from bytes.
of(ParameterData.OutputStreamConsumer) - Static method in class com.decisionbrain.optimserver.worker.api.ParameterData: Creates a ParameterData from a consumer.
of(String) - Static method in class com.decisionbrain.optimserver.worker.api.ParameterData: Creates a ParameterData from a String.
of(InputStreamSource) - Static method in class com.decisionbrain.optimserver.worker.api.ParameterData: Creates a ParameterData from an InputStreamSource.
OnLifecycleCondition - Class in com.decisionbrain.optimserver.worker.api.configuration.condition: Condition that matches when the worker runs in a specific lifecycle mode.
OnLifecycleCondition() - Constructor for class com.decisionbrain.optimserver.worker.api.configuration.condition.OnLifecycleCondition
open() - Method in class com.decisionbrain.optimserver.worker.api.ParameterData: Opens an #InputStream that gives access to the input's content.
openBlob(URI) - Method in class com.decisionbrain.optimserver.worker.datastorage.MasterApiDataStorage
openRaw() - Method in class com.decisionbrain.optimserver.worker.api.ParameterData: Opens an #InputStream that gives access to the input's raw content.
optimizationModel(String, InstanceMetrics) - Method in class com.decisionbrain.platform.run.metrics.RunMetrics.RunMetricsBuilder: Deprecated.
optimizationModels(Map<String, InstanceMetrics>) - Method in class com.decisionbrain.platform.run.metrics.RunMetrics.RunMetricsBuilder: Deprecated.
optimizationServerApiClientConfiguration(OptimServerClientProperties, MasterClientProperties, HttpHeadersProvider) - Method in class com.decisionbrain.optimserver.worker.api.configuration.CustomOptimServerClientConfiguration
optimizationServerJwtAuthPropertiesProvider() - Method in class com.decisionbrain.optimserver.worker.api.configuration.CustomOptimServerClientConfiguration
optimServerClientProperties(MasterClientProperties) - Method in class com.decisionbrain.optimserver.worker.api.configuration.CustomOptimServerClientConfiguration
OptimServerJwtAuthProperties - Class in com.decisionbrain.optimserver.worker.api.configuration
OptimServerJwtAuthProperties() - Constructor for class com.decisionbrain.optimserver.worker.api.configuration.OptimServerJwtAuthProperties
OTHER - com.decisionbrain.platform.run.AbortPolicy
otherPolicy(String) - Static method in enum com.decisionbrain.platform.run.AbortPolicy
OUTPUT - Static variable in class com.decisionbrain.optimserver.worker.task.protocol.StdioProtocol
OutputMessage - Class in com.decisionbrain.optimserver.worker.task.protocol: Represent an output that is received from a subprocess.
OutputMessage() - Constructor for class com.decisionbrain.optimserver.worker.task.protocol.OutputMessage
OutputParameterDTO - Class in com.decisionbrain.optimserver.common.dto.event
OutputParameterDTO() - Constructor for class com.decisionbrain.optimserver.common.dto.event.OutputParameterDTO
OutputParameterDTO(String, String, URI, boolean) - Constructor for class com.decisionbrain.optimserver.common.dto.event.OutputParameterDTO
outputs(List<TaskParameter>) - Method in class com.decisionbrain.optimserver.worker.api.configuration.JavaTaskDefinition.JavaTaskDefinitionBuilder
outputs(Map<String, Object>) - Method in class com.decisionbrain.optimserver.worker.api.configuration.JavaTaskDefinition.JavaTaskDefinitionBuilder
OUTPUTS_DIR - Static variable in class com.decisionbrain.optimserver.worker.task.protocol.SubprocessEnv: Environment variable that holds the folder that contains output parameters.

P

Parameter - Class in com.decisionbrain.optimserver.common.parameter: Job parameters as BucketData, stored in a map.
Parameter() - Constructor for class com.decisionbrain.optimserver.common.parameter.Parameter
Parameter(Map<String, BucketData>) - Constructor for class com.decisionbrain.optimserver.common.parameter.Parameter
ParameterData - Class in com.decisionbrain.optimserver.worker.api: Class that holds the data of a parameter
ParameterData(InputStreamSource, boolean) - Constructor for class com.decisionbrain.optimserver.worker.api.ParameterData
ParameterData.OutputStreamConsumer - Interface in com.decisionbrain.optimserver.worker.api
parameters - Variable in class com.decisionbrain.optimserver.common.parameter.AbstractParameter
parameters(List<JobParameterDTO>) - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobSubmitRequestDTO.Builder
ParameterType - Enum in com.decisionbrain.optimserver.common.parameter: ParameterType is the enum of the possible types for a job parameter (input or output).
PARENTHOOD - com.decisionbrain.optimserver.common.enumeration.JobRelationType: If a job j1 creates a sub-job j2, then there should be an arc (j1, j2) with this type in the related flow.
PREFIX - Static variable in class com.decisionbrain.optimserver.worker.task.protocol.StdioProtocol
progress(String, Double) - Method in class com.decisionbrain.platform.run.progress.ProgressMetrics.ProgressMetricsBuilder
PROGRESS_METRICS - Static variable in class com.decisionbrain.optimserver.worker.task.protocol.StdioProtocol
ProgressMetrics - Class in com.decisionbrain.platform.run.progress: ProgressMetrics allows to notify the progression of a running process, in percentage.
ProgressMetrics.ProgressMetricsBuilder - Class in com.decisionbrain.platform.run.progress: Builder of ProgressMetrics instances.
ProgressMetricsHandler - Class in com.decisionbrain.optimserver.worker.task.protocol: Handle progress metrics messages.
ProgressMetricsHandler(Consumer<ProgressMetrics>) - Constructor for class com.decisionbrain.optimserver.worker.task.protocol.ProgressMetricsHandler

R

REGISTER - com.decisionbrain.optimserver.common.enumeration.WorkerLifecycleMode: Register: the worker send to master the information about its tasks and exit.
reject(String) - Method in interface com.decisionbrain.optimserver.worker.api.ExecutionContext: Rejects the current job, for example when the inputs are invalid.
REJECTED - com.decisionbrain.optimserver.common.enumeration.JobStatus: A worker can reject a job if invalid inputs are received.
relatedJobId(String) - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobRelationDTO.JobRelationDTOBuilder
relationType(JobRelationType) - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobRelationDTO.JobRelationDTOBuilder
required(boolean) - Method in class com.decisionbrain.optimserver.worker.api.configuration.TaskParameter.TaskParameterBuilder
RESTRICTED - com.decisionbrain.optimserver.common.enumeration.JobStatus: When a message has been sent, but queued for restriction.
run() - Method in class com.decisionbrain.optimserver.worker.task.protocol.SubprocessBridge: Blocking method that run the process and manage the communication with it
RunMetrics - Class in com.decisionbrain.platform.run.metrics: Deprecated.
This could be used for Benchmarks but is currently not.
RunMetrics.RunMetricsBuilder - Class in com.decisionbrain.platform.run.metrics: Deprecated.

Builder of RunMetrics instances.
RUNNING - com.decisionbrain.optimserver.common.enumeration.JobStatus: A job that is currently processed by a worker is running.

S

SCHEDULED - com.decisionbrain.optimserver.common.enumeration.JobStatus: When a message has been sent to the worker(s) queue, the job is scheduled.
SEPARATOR - Static variable in class com.decisionbrain.optimserver.worker.task.protocol.StdioProtocol
setAbortCallback(ExecutionContext.AbortCallback) - Method in class com.decisionbrain.platform.run.ExecutionContext.DefaultExecutionContext
setAbortCallback(ExecutionContext.AbortCallback) - Method in interface com.decisionbrain.platform.run.ExecutionContext: Deprecated.
Use ExecutionContext.setAbortCallbackWithPolicy(AbortCallbackWithPolicy) instead.
setAbortCallbackWithPolicy(ExecutionContext.AbortCallbackWithPolicy) - Method in class com.decisionbrain.platform.run.ExecutionContext.DefaultExecutionContext
setAbortCallbackWithPolicy(ExecutionContext.AbortCallbackWithPolicy) - Method in interface com.decisionbrain.platform.run.ExecutionContext
setApplicationContext(ApplicationContext) - Method in interface com.decisionbrain.optimserver.worker.api.Task
setApplicationContext(ApplicationContext) - Method in class com.decisionbrain.optimserver.worker.task.WorkerShellTask
setBucketId(String) - Method in class com.decisionbrain.optimserver.common.parameter.BucketReference
setCleanParameterFiles(Boolean) - Method in class com.decisionbrain.optimserver.worker.api.configuration.properties.ShellProperties
setCoefficient(Double) - Method in class com.decisionbrain.optimserver.worker.task.protocol.MetricMessage
setData(byte[]) - Method in class com.decisionbrain.optimserver.common.parameter.BucketData: Deprecated.
Use BucketData(Supplier, boolean) constructor
setElapsedTime(Long) - Method in class com.decisionbrain.optimserver.worker.task.protocol.MetricsMessage
setInstanceId(String) - Method in class com.decisionbrain.optimserver.worker.task.protocol.MetricsMessage
setMessage(String) - Method in class com.decisionbrain.optimserver.worker.task.protocol.MetricsMessage
setMessage(String) - Method in class com.decisionbrain.platform.run.progress.ProgressMetrics
setName(String) - Method in class com.decisionbrain.optimserver.worker.task.protocol.MetricMessage
setName(String) - Method in class com.decisionbrain.optimserver.worker.task.protocol.OutputMessage
setParameterFilesLocation(String) - Method in class com.decisionbrain.optimserver.worker.api.configuration.properties.ShellProperties
setPolicy(AbortPolicy) - Method in class com.decisionbrain.optimserver.worker.task.protocol.StopMessage
setReason(String) - Method in enum com.decisionbrain.platform.run.AbortPolicy
setValue(T) - Method in class com.decisionbrain.optimserver.worker.task.protocol.MetricMessage
setValues(List<MetricMessage<T>>) - Method in class com.decisionbrain.optimserver.worker.task.protocol.MetricsMessage
setZipped(boolean) - Method in class com.decisionbrain.optimserver.worker.task.protocol.OutputMessage
ShellProperties - Class in com.decisionbrain.optimserver.worker.api.configuration.properties
ShellProperties() - Constructor for class com.decisionbrain.optimserver.worker.api.configuration.properties.ShellProperties
ShellTaskDefinition - Class in com.decisionbrain.optimserver.worker.api.configuration
ShellTaskDefinition() - Constructor for class com.decisionbrain.optimserver.worker.api.configuration.ShellTaskDefinition
ShellTaskDefinition(String, String, List<TaskParameter>, List<TaskParameter>, Map<String, Object>, String, String, String) - Constructor for class com.decisionbrain.optimserver.worker.api.configuration.ShellTaskDefinition
shouldAbort() - Method in class com.decisionbrain.platform.run.ExecutionContext.DefaultExecutionContext
shouldAbort() - Method in interface com.decisionbrain.platform.run.ExecutionContext: This method allows to check if the running job should abort.
solution(SolutionMetrics) - Method in class com.decisionbrain.platform.run.metrics.RunMetrics.RunMetricsBuilder: Deprecated.
SOLUTION_METRICS - Static variable in class com.decisionbrain.optimserver.worker.task.protocol.StdioProtocol
SolutionDTO - Class in com.decisionbrain.optimserver.common.dto.event: A solution DTO contains the output(s) emitted by a job before completion.
SolutionDTO() - Constructor for class com.decisionbrain.optimserver.common.dto.event.SolutionDTO
SolutionDTO(String, SolutionParameter, String) - Constructor for class com.decisionbrain.optimserver.common.dto.event.SolutionDTO
SolutionDTO(String, SolutionParameter, String, String, JobStatus) - Constructor for class com.decisionbrain.optimserver.common.dto.event.SolutionDTO
SolutionMetrics - Class in com.decisionbrain.platform.run.output: This class allows to notify Key Performance Indicators on a solution obtained during the process.
SolutionMetrics() - Constructor for class com.decisionbrain.platform.run.output.SolutionMetrics
SolutionMetrics.SolutionMetricsBuilder - Class in com.decisionbrain.platform.run.output: Builder of SolutionMetrics instances.
SolutionMetricsHandler - Class in com.decisionbrain.optimserver.worker.task.protocol: Handle solution metrics messages.
SolutionMetricsHandler(Consumer<SolutionMetrics>) - Constructor for class com.decisionbrain.optimserver.worker.task.protocol.SolutionMetricsHandler
SolutionParameter - Class in com.decisionbrain.optimserver.common.parameter
SolutionParameter() - Constructor for class com.decisionbrain.optimserver.common.parameter.SolutionParameter
SolutionParameter(Map<String, BucketReference>) - Constructor for class com.decisionbrain.optimserver.common.parameter.SolutionParameter
solutions(List<SolutionMetrics>) - Method in class com.decisionbrain.platform.run.metrics.RunMetrics.RunMetricsBuilder: Deprecated.
startJob(JobSubmitRequestDTO) - Method in interface com.decisionbrain.optimserver.worker.api.ExecutionContext: Sends a job start request to the master and gets the (nullable) status of the job to be started.
startJobAndWaitForCompletion(JobSubmitRequestDTO) - Method in interface com.decisionbrain.optimserver.worker.api.ExecutionContext: Sends a job start request to the master and waits for completion (solution or failure).
StdioProtocol - Class in com.decisionbrain.optimserver.worker.task.protocol: Class that holds constants and utilities for the protocol used to communication with a sub-process using SubprocessBridge.
STOP - Static variable in class com.decisionbrain.optimserver.worker.task.protocol.StdioProtocol
StopMessage - Class in com.decisionbrain.optimserver.worker.task.protocol
StopMessage() - Constructor for class com.decisionbrain.optimserver.worker.task.protocol.StopMessage
StopMessage(AbortPolicy) - Constructor for class com.decisionbrain.optimserver.worker.task.protocol.StopMessage
SUBMITTED - com.decisionbrain.optimserver.common.enumeration.JobStatus: A job entity saved in the database is submitted.
SubprocessBridge - Class in com.decisionbrain.optimserver.worker.task.protocol: Task that wrap a sub-process execution and communication.
SubprocessBridge(ProcessBuilder, ExecutionContext, Path) - Constructor for class com.decisionbrain.optimserver.worker.task.protocol.SubprocessBridge
SubprocessEnv - Class in com.decisionbrain.optimserver.worker.task.protocol: Class that holds constants related to variable environment used by SubprocessBridge.
supports(URI) - Method in class com.decisionbrain.optimserver.worker.datastorage.MasterApiDataStorage

T

Task - Interface in com.decisionbrain.optimserver.worker.api: This interface should be implemented in a worker, for each task the worker can execute.
TaskDefinition - Class in com.decisionbrain.optimserver.worker.api.configuration: Definition of a task a worker can perform.
TaskDefinition() - Constructor for class com.decisionbrain.optimserver.worker.api.configuration.TaskDefinition
TaskDefinition(String, String, List<TaskParameter>, List<TaskParameter>, Map<String, Object>, String) - Constructor for class com.decisionbrain.optimserver.worker.api.configuration.TaskDefinition
TaskExecutionException - Exception in com.decisionbrain.optimserver.worker.api: Exception thrown when a task throws an Exception.
TaskExecutionException(String, Throwable) - Constructor for exception com.decisionbrain.optimserver.worker.api.TaskExecutionException
TaskExecutionException(Throwable) - Constructor for exception com.decisionbrain.optimserver.worker.api.TaskExecutionException
taskId(String) - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobSubmitRequestDTO.Builder
TaskParameter - Class in com.decisionbrain.optimserver.worker.api.configuration: A TaskParameter defines an input or an output each job derived from the task could use.
TaskParameter() - Constructor for class com.decisionbrain.optimserver.worker.api.configuration.TaskParameter
TaskParameter.TaskParameterBuilder - Class in com.decisionbrain.optimserver.worker.api.configuration: Builder for TaskParameter objects.
TERMINATE_WITH_CURRENT_SOLUTION - com.decisionbrain.platform.run.AbortPolicy
TERMINATE_WITH_NO_SOLUTION - com.decisionbrain.platform.run.AbortPolicy
TEXT - com.decisionbrain.optimserver.common.parameter.ParameterType: A parameter can be a text file, with any kind of (structured) content.
timeout(Long) - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobSubmitRequestDTO.Builder
TimeoutDTO - Interface in com.decisionbrain.optimserver.common.dto.event.master: Common interface for DTOs that can be sent with a timeout.
toString() - Method in class com.decisionbrain.optimserver.common.dto.event.AbstractEventDTO
toString() - Method in class com.decisionbrain.optimserver.common.dto.event.OutputParameterDTO
toString() - Method in class com.decisionbrain.optimserver.common.dto.event.SolutionDTO
toString() - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobRelationDTO
toString() - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.JobSubmitRequestDTO
toString() - Method in class com.decisionbrain.optimserver.common.parameter.BucketData
toString() - Method in class com.decisionbrain.optimserver.worker.api.configuration.JavaTaskDefinition
toString() - Method in class com.decisionbrain.optimserver.worker.api.configuration.TaskParameter
toString() - Method in class com.decisionbrain.optimserver.worker.api.configuration.WorkerYamlConfiguration
toString() - Method in class com.decisionbrain.platform.run.metrics.AbstractMetrics
toString() - Method in class com.decisionbrain.platform.run.metrics.Metric
toString() - Method in class com.decisionbrain.platform.run.output.SolutionMetrics
toString() - Method in class com.decisionbrain.platform.run.progress.ProgressMetrics
type(ParameterType) - Method in class com.decisionbrain.optimserver.worker.api.configuration.TaskParameter.TaskParameterBuilder
type(String) - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.BucketDTO.BucketDTOBuilder

U

UnknownTaskException - Exception in com.decisionbrain.optimserver.worker.api: Exception thrown when an unknown task is requested.
UnknownTaskException(String) - Constructor for exception com.decisionbrain.optimserver.worker.api.UnknownTaskException

V

value() - Method in annotation type com.decisionbrain.optimserver.worker.api.configuration.condition.ConditionalOnLifecycle
value(T) - Method in class com.decisionbrain.platform.run.metrics.Metric.MetricBuilder
valueOf(String) - Static method in enum com.decisionbrain.optimserver.common.enumeration.JobFlag: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.decisionbrain.optimserver.common.enumeration.JobRelationType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.decisionbrain.optimserver.common.enumeration.JobStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.decisionbrain.optimserver.common.enumeration.WorkerLifecycleMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.decisionbrain.optimserver.common.parameter.ParameterType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.decisionbrain.platform.run.AbortPolicy: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.decisionbrain.optimserver.common.enumeration.JobFlag: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.decisionbrain.optimserver.common.enumeration.JobRelationType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.decisionbrain.optimserver.common.enumeration.JobStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.decisionbrain.optimserver.common.enumeration.WorkerLifecycleMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.decisionbrain.optimserver.common.parameter.ParameterType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.decisionbrain.platform.run.AbortPolicy: Returns an array containing the constants of this enum type, in the order they are declared.

W

WORKER - Static variable in class com.decisionbrain.optimserver.common.CommonPropertyConstants
WORKER_BATCH_JOBID - Static variable in class com.decisionbrain.optimserver.common.CommonPropertyConstants
WORKER_LIB_VERSION_MISMATCH - com.decisionbrain.optimserver.common.enumeration.JobFlag: Means the job has run in a worker that uses a worker lib that has a different version from master version.
WORKER_LIFECYLEMODE - Static variable in class com.decisionbrain.optimserver.common.CommonPropertyConstants
WORKER_REGISTER_KEY - Static variable in class com.decisionbrain.optimserver.common.CommonPropertyConstants
WorkerBatchProperties - Class in com.decisionbrain.optimserver.worker.api.configuration.properties: Properties for the worker in #WorkerLifecycleMode.BATCH mode
WorkerBatchProperties() - Constructor for class com.decisionbrain.optimserver.worker.api.configuration.properties.WorkerBatchProperties
WorkerLifecycleMode - Enum in com.decisionbrain.optimserver.common.enumeration: Represent the type of lifecycle the worker is running in.
WorkerProperties - Class in com.decisionbrain.optimserver.worker.api.configuration.properties
WorkerProperties() - Constructor for class com.decisionbrain.optimserver.worker.api.configuration.properties.WorkerProperties
WorkerRegisterProperties - Class in com.decisionbrain.optimserver.worker.api.configuration.properties
WorkerRegisterProperties() - Constructor for class com.decisionbrain.optimserver.worker.api.configuration.properties.WorkerRegisterProperties
WorkerShellTask - Class in com.decisionbrain.optimserver.worker.task: A task that run a sub-process and communicate with it on standard IO using pipes.
WorkerShellTask(String, String, ShellProperties) - Constructor for class com.decisionbrain.optimserver.worker.task.WorkerShellTask
WorkerYamlConfiguration - Class in com.decisionbrain.optimserver.worker.api.configuration: This class defines the allowed content for a worker configuration file (worker.yml file).
WorkerYamlConfiguration() - Constructor for class com.decisionbrain.optimserver.worker.api.configuration.WorkerYamlConfiguration
WorkerYamlConfiguration(List<JavaTaskDefinition>) - Constructor for class com.decisionbrain.optimserver.worker.api.configuration.WorkerYamlConfiguration
WorkerYamlConfiguration(List<JavaTaskDefinition>, List<ShellTaskDefinition>) - Constructor for class com.decisionbrain.optimserver.worker.api.configuration.WorkerYamlConfiguration
WorkerYamlConfigurationException - Exception in com.decisionbrain.optimserver.worker.api.configuration: This exception is raised when starting a worker in case of invalid worker.yml configuration file.
WorkerYamlConfigurationException(String) - Constructor for exception com.decisionbrain.optimserver.worker.api.configuration.WorkerYamlConfigurationException
WorkerYamlConfigurationException(String, Throwable) - Constructor for exception com.decisionbrain.optimserver.worker.api.configuration.WorkerYamlConfigurationException
writeTemporaryBlob(InputStreamSource, String) - Method in class com.decisionbrain.optimserver.worker.datastorage.MasterApiDataStorage

X

XML - com.decisionbrain.optimserver.common.parameter.ParameterType: A parameter can be an XML file.

Z

zipped() - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.BucketDTO.BucketDTOBuilder
zipped() - Method in class com.decisionbrain.optimserver.worker.api.ParameterData: Alias for ParameterData.zipped(boolean) using "true" as parameter.
zipped(boolean) - Method in class com.decisionbrain.optimserver.common.dto.jobcreation.BucketDTO.BucketDTOBuilder
zipped(boolean) - Method in class com.decisionbrain.optimserver.worker.api.ParameterData: Create a new ParameterData from this one by changing the value returned by ParameterData.isZipped

A B C D E F G H I J K L M N O P R S T U V W X Z
All Classes All Packages