module.media

Media module

type

object

properties

  • experimentalFeatures

These experimental features are not yet stable and may change at any time.

If you are using them, we would appreciate any feedback.

Once a feature is considered stable, it will either be moved to another configuration parameter or enabled permanently.

Default value is [{“enableHotReload”:false}]

default

enableHotReload

False

ExperimentalFeatures

  • isTemplateGeneratedByOspComposer

Name of the playbook that generated this file. If present, the file is managed by the Composer and may be overwritten on regeneration. Used for selective clean. Do not edit or set manually.

type

string

  • loggingConfiguration

The configuration of module’s logging

Default value is [{“externalLogLevel”:”WARN”,”moduleLogLevel”:”INFO”}]

default

externalLogLevel

WARN

moduleLogLevel

INFO

LoggingConfigurationEntity

  • messagingConfiguration

The configuration of the Rabbit MQ used for communication

MessagingConfigurationEntity

  • startupValueErrorTimeout

The delay during which the error are not published when the module is starting or the value configuration has changed.

When a value without an error is publish the delay will be remove immediately. The following errors will not be delayed.

This also concern the uninitialized value.

During this period, any republish request will generate an uninitialized value.

This can be override on the value configuration.

Default value is [{“unit”:”MINUTES”,”value”:1}]

default

unit

MINUTES

value

1

DurationConfigurationEntity

  • templateId

The id of the template to use for this file

type

string

  • templateVariables

The variables and their values to be replaced from the template

type

object

additionalProperties

  • variablesFiles

The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.

type

array

items

type

string

additionalProperties

False

ExperimentalFeatures

type

object

properties

  • enableHotReload

Flag to enable/disable the hot-reload on the module.

The modules capabilities ↗️ describe which module support it.

Default value is [false]

type

boolean

default

False

additionalProperties

False

LoggingConfigurationEntity

type

object

properties

  • externalLogLevel

The log level for external libraries logging

Default value is [“WARN”]

type

string

enum

TRACE, DEBUG, INFO, WARN, ERROR, DISABLE

default

WARN

  • moduleLogLevel

The log level for module’s behavior logging

Default value is [“INFO”]

type

string

enum

TRACE, DEBUG, INFO, WARN, ERROR, DISABLE

default

INFO

  • scriptLogLevel

The log level for module’s internal script behavior logging (if not set the moduleLogLevel will be used)

type

string

enum

TRACE, DEBUG, INFO, WARN, ERROR, DISABLE

additionalProperties

False

MessagingConfigurationEntity

type

object

properties

  • bufferSize

The size of the buffer to use when the broker is disconnected (default: 60000).

Default value is [60000]

type

integer

minimum

1

default

60000

  • clientId

The ID of the client, must be different for each module instance.

type

string

  • host

The host of the rabbit MQ provider

type

string

  • storeMessagesOnDisk

Flag to indicate to store the message (The path /osp/messages must be mount to a volume).

Default value is [false]

type

boolean

default

False

additionalProperties

False

DurationConfigurationEntity

type

object

properties

  • unit

The unit of time expressed

type

string

enum

NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS

  • value

The amount of time expressed with the unit

type

integer

additionalProperties

False