API

Enumerations

Enumeration	Description
AuthProtocol	-
AuthState	-
Direction	Relations are directed from A to B and can be followed in either direction.
GlobalProperties	Label of global properties used by convention through bricks and applications. Example of use:
Order	The sorting order for a QueryPart.
PredefinedDataSource	Predefined data sources that can be used for Transaction.setSource.
ProbeType	Types of probe that can be used to check the health of the process: - LIVENESS: used to check if the process is alive - READINESS: used to check if the process is ready to operate - ALL: used to check both liveness and readiness
ServiceRequestType	Types of requests that can be received in a Service. This is used to know what method call on the request to answer the requester.

Classes

Class	Description
ActionBrick	-
Auth	A static class that gathers all the required methods to handle the authentication and sessions with Olympe.
BooleanModel	BooleanModel represents a PropertyModel for a boolean property of a data type.
Brick	A CloudObject is the base class for all objects that can be persisted and exchanged between Olympe applications. In essence, it represents a remote reference to an object in the data cloud. It is identified by its unique ID, or tag. From a CloudObject you can access related CloudObjects.
BrickContext	Softcoded application context
BurstTransaction	BurstTransactions are designed to continuously apply high rates of updates on properties (FIFO ordering). The only operation supported by BurstTransactions is to update properties of an instance.
Cache	-
CloudObject	A CloudObject is the base class for all objects that can be persisted and exchanged between Olympe applications. In essence, it represents a remote reference to an object in the data cloud. It is identified by its unique ID, or tag. From a CloudObject you can access related CloudObjects.
Color	-
ColorModel	ColorModel represents a PropertyModel for a color property of a data type.
Config	-
Context	Softcoded application context
DataResult	A class representing the necessary operations to create the result of a query in the client database that emitted the query.
DataSource	Represents a data source that can be used to retrieve, manipulate and store data outside the Olympe application environment. This class provides several methods for performing CRUD (create, read, update, delete) operations on data, as well as file upload and download functionality.
DatetimeModel	DatetimeModel represents a PropertyModel for a datetime property of a data type.
Enum	An Enum is an ordered list of string key-values mappings
EnumValue	An EnumValue is a single value part of an Enum. It has a string name, a rank (its position in the Enum list).
ErrorFlow	Error type used to propagate errors through flows between bricks.
File	File is the main class used to create business objects with a binary/string data content. It is a Data Type so can be extended and associated to a data source.
NumberModel	NumberModel represents a PropertyModel for a number property of a data type.
Predicate	Predicates are used to filter queries.
Process	-
PropertyModel	A property model defines a property of a data type. A property is defined by its type and the model it defines a property for.
Query	A Query is an immutable object used to build queries on the datacloud. It is a graph query builder. It starts from an origin InstanceOrTag (typically, the InstanceOrTag of a data type or of an instance). From there, it can follow relations between data types and filter results.
QueryResult	A QueryResult is a list of key-value pairs that has been generated as a result of a Query. It contains the result of a query at a specific time.
QuerySingle	A QuerySingle is a Query which follows relations that should be unique between data types (0..1 and 1..1 cardinalities). It returns the instance related to the origin, following the specified relation(s).
RelationModel	A relation model defines a relation between two data types. It defines what data types is the origin and the destination of the relation.
Service	A service that processes requests coming from other VMs connected to the data cloud.
ServiceRequest	A request consumed by a service.
StringModel	StringModel represents a PropertyModel for a string property of a data type.
Theme	Theme object describing the main visual properties used by components
Transaction	Transactions are the unique way to apply a list of operations to the datacloud. A transaction can be merged into another transaction so that both are executed as a single set of operations.
TransactionResult	A transaction result is the object received after a transaction has been executed successfully. It provides information about what has been done.
User	User object for authentication purposes
VisualBrick	A CloudObject is the base class for all objects that can be persisted and exchanged between Olympe applications. In essence, it represents a remote reference to an object in the data cloud. It is identified by its unique ID, or tag. From a CloudObject you can access related CloudObjects.
Workflow	A Workflow is a sequence of WorkflowState in which instances of a model goes through. WorkflowState are linked by WorkflowTransition that can have an optional process function. The Workflow also historize the WorkflowState of the instance and optionally serialize the object itself in a WorkflowObjectState.
WorkflowObjectState	A WorkflowObjectState represents the state of an instance at a certain point in time. It is automatically created when initializing a Workflow on an instance or when triggering a WorkflowTransition.
WorkflowState	A WorkflowState defines a state in a Workflow.
WorkflowTransition	A WorkflowTransition defines a transition between 2 WorkflowState. It has a direction (fromStateRel to toStateRel) and can have an optional process function. The process function (processRefProp) is automatically triggered when the transition occurs.

Interfaces

Interface	Description
HasTag	The HasTag interface defines objects that have a tag. The tag of these objects must be returned by the overridden method: getTag()
Property	A property of a model defines an attribute. A property has a tag. Each instance of a model can have value for these defined properties.
QueryPart	A part of a Query that specifies a relationship to traverse.
Relation	Relations can be defined between from a CloudObject to another, for example between two data types. Relations are directed and have two types: the origin type, the destination type.
RelationConstructor	-
RootQueryPart	The first part of a Query. It breaks down the starting point of the query.
ServiceConfig	-
SubscriptionServiceConfig	-

Type Aliases

Type Alias	Description
CacheStatus	-
Class	-
FollowRule	-
ImplicitQueryOption	-
InstanceOrTag	A InstanceOrTag can be either a string, a HasTag (CloudObject instance, Property, Relation, ...) or the class constructor for a CloudObject
List	-
Operation	Represents an operation that can be performed regarding data type instances.
ParsedPredicate	Details for a predicate from the OLYMPE query API
QueryOptions	-
Source	When manipulating CloudObjects, sometimes it is required to manually set the data source of that object. Source determines where the object comes from: what data source is the owner of the object across the ecosystem.
SRPData	-
TransactionOptions	Additional options for transactions to be processed by a data source. - batch: if true, it means that the transaction has been executed using the () function.
UserToken	-

Variables

Variable	Description
Relation	Global variable, constructor of class Relation.

Functions

Function	Description
defineInverseRelation	Returns a constant object corresponding to the specified relation going to the opposite direction
defineProperty	Create a constant property object which has the specified tag and type to be used in coded bricks.
defineRelation	Create a constant relation object between two specified DataTypes.
generateTag	Generates a unique olympe tag used to identify CloudObjects
register	Register the class constructor as the class associated to the specified tag.
registerBrick	Static function that must be called for every brick used in an application. It registers the brick code in the registry with the specified tag and return the Entry for that brick.
tagToString	Get the unique identifier of the specified InstanceOrTag as a string