IRenderingWorkerConfiguration
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
export interface IRenderingWorkerConfiguration
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
number | (BETA) (Optional) Wait for given number of async requests. If provided, we’ll not wait full asyncRenderRequestedTimeout and terminate the waiting if we reach the given number | ||
number | (BETA) Maximum time limit for the first asynchronous rendering request. If no asynchronous rendering request is fired in this time limit, the dashboard will announce that it is rendered. Default: 5000 (5s). | ||
number | (BETA) Maximum time limit to re-request asynchronous rendering of the component once it’s resolved. Default: 2000 (2s). | ||
() => string | (BETA) Generator of correlation ids Default: uuid4 | ||
boolean | (BETA) (Optional) Indicates whether rendering worker is triggered inside export mode Default: false | ||
number | (BETA) Maximum time limit for rendering the dashboard. Somehow in sync with limits of exporter https://github.com/gooddata/gdc-exporters-microservices/blob/master/microservices/visual-exporter-service/src/main/kotlin/com/gooddata/exporters/visual/config/TabSessionConfig.kt Default: 20*60000 (20min). |
Property details
IRenderingWorkerConfiguration.asyncRenderExpectedCountpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Wait for given number of async requests. If provided, we’ll not wait full asyncRenderRequestedTimeout and terminate the waiting if we reach the given number
asyncRenderExpectedCount?: number;
IRenderingWorkerConfiguration.asyncRenderRequestedTimeoutpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Maximum time limit for the first asynchronous rendering request. If no asynchronous rendering request is fired in this time limit, the dashboard will announce that it is rendered.
Default: 5000 (5s).
asyncRenderRequestedTimeout: number;
IRenderingWorkerConfiguration.asyncRenderResolvedTimeoutpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Maximum time limit to re-request asynchronous rendering of the component once it’s resolved.
Default: 2000 (2s).
asyncRenderResolvedTimeout: number;
IRenderingWorkerConfiguration.correlationIdGeneratorpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Generator of correlation ids
Default: uuid4
correlationIdGenerator: () => string;
IRenderingWorkerConfiguration.isExportpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Indicates whether rendering worker is triggered inside export mode
Default: false
isExport?: boolean;
IRenderingWorkerConfiguration.maxTimeoutpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Maximum time limit for rendering the dashboard. Somehow in sync with limits of exporter https://github.com/gooddata/gdc-exporters-microservices/blob/master/microservices/visual-exporter-service/src/main/kotlin/com/gooddata/exporters/visual/config/TabSessionConfig.kt
Default: 20*60000 (20min).
maxTimeout: number;