@twin.org/node-core 0.0.3-next.5 → 0.0.3-next.51
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -1
- package/dist/es/builders/engineEnvBuilder.js +472 -198
- package/dist/es/builders/engineEnvBuilder.js.map +1 -1
- package/dist/es/builders/engineServerEnvBuilder.js +89 -32
- package/dist/es/builders/engineServerEnvBuilder.js.map +1 -1
- package/dist/es/builders/extensionsBuilder.js.map +1 -1
- package/dist/es/cli.js +247 -0
- package/dist/es/cli.js.map +1 -0
- package/dist/es/commands/bootstrapLegacy.js +178 -0
- package/dist/es/commands/bootstrapLegacy.js.map +1 -0
- package/dist/es/commands/help.js +85 -0
- package/dist/es/commands/help.js.map +1 -0
- package/dist/es/commands/identityCreate.js +326 -0
- package/dist/es/commands/identityCreate.js.map +1 -0
- package/dist/es/commands/identityImports.js +81 -0
- package/dist/es/commands/identityImports.js.map +1 -0
- package/dist/es/commands/identityVerifiableCredentialCreate.js +145 -0
- package/dist/es/commands/identityVerifiableCredentialCreate.js.map +1 -0
- package/dist/es/commands/identityVerificationMethodCreate.js +227 -0
- package/dist/es/commands/identityVerificationMethodCreate.js.map +1 -0
- package/dist/es/commands/identityVerificationMethodImport.js +125 -0
- package/dist/es/commands/identityVerificationMethodImport.js.map +1 -0
- package/dist/es/commands/nodeSetIdentity.js +63 -0
- package/dist/es/commands/nodeSetIdentity.js.map +1 -0
- package/dist/es/commands/tenantCreate.js +137 -0
- package/dist/es/commands/tenantCreate.js.map +1 -0
- package/dist/es/commands/tenantImport.js +95 -0
- package/dist/es/commands/tenantImport.js.map +1 -0
- package/dist/es/commands/tenantToken.js +97 -0
- package/dist/es/commands/tenantToken.js.map +1 -0
- package/dist/es/commands/tenantUpdate.js +93 -0
- package/dist/es/commands/tenantUpdate.js.map +1 -0
- package/dist/es/commands/userCreate.js +239 -0
- package/dist/es/commands/userCreate.js.map +1 -0
- package/dist/es/commands/userUpdate.js +154 -0
- package/dist/es/commands/userUpdate.js.map +1 -0
- package/dist/es/commands/vaultKeyCreate.js +190 -0
- package/dist/es/commands/vaultKeyCreate.js.map +1 -0
- package/dist/es/commands/vaultKeyImport.js +103 -0
- package/dist/es/commands/vaultKeyImport.js.map +1 -0
- package/dist/es/defaults.js +18 -2
- package/dist/es/defaults.js.map +1 -1
- package/dist/es/index.js +11 -4
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/ICliArgs.js +4 -0
- package/dist/es/models/ICliArgs.js.map +1 -0
- package/dist/es/models/ICliCommand.js +2 -0
- package/dist/es/models/ICliCommand.js.map +1 -0
- package/dist/es/models/ICliCommandDefinition.js +2 -0
- package/dist/es/models/ICliCommandDefinition.js.map +1 -0
- package/dist/es/models/ICliCommandDefinitionParam.js +2 -0
- package/dist/es/models/ICliCommandDefinitionParam.js.map +1 -0
- package/dist/es/models/IEngineEnvironmentVariables.js.map +1 -1
- package/dist/es/models/IEngineServerEnvironmentVariables.js.map +1 -1
- package/dist/es/models/INodeEngineState.js.map +1 -1
- package/dist/es/models/INodeEnvironmentVariables.js.map +1 -1
- package/dist/es/models/INodeOptions.js.map +1 -1
- package/dist/es/models/cliCommandParamType.js +4 -0
- package/dist/es/models/cliCommandParamType.js.map +1 -0
- package/dist/es/models/nodeExtensionInitialiseEngineMethod.js +2 -0
- package/dist/es/models/nodeExtensionInitialiseEngineMethod.js.map +1 -0
- package/dist/es/models/nodeExtensionInitialiseEngineServerMethod.js +2 -0
- package/dist/es/models/nodeExtensionInitialiseEngineServerMethod.js.map +1 -0
- package/dist/es/models/nodeExtensionInitialiseMethod.js +2 -0
- package/dist/es/models/nodeExtensionInitialiseMethod.js.map +1 -0
- package/dist/es/models/nodeExtensionShutdownMethod.js +4 -0
- package/dist/es/models/nodeExtensionShutdownMethod.js.map +1 -0
- package/dist/es/node.js +86 -39
- package/dist/es/node.js.map +1 -1
- package/dist/es/{server.js → start.js} +72 -27
- package/dist/es/start.js.map +1 -0
- package/dist/es/utils.js +21 -25
- package/dist/es/utils.js.map +1 -1
- package/dist/types/builders/engineEnvBuilder.d.ts +67 -1
- package/dist/types/builders/engineServerEnvBuilder.d.ts +11 -2
- package/dist/types/cli.d.ts +56 -0
- package/dist/types/commands/bootstrapLegacy.d.ts +66 -0
- package/dist/types/commands/help.d.ts +23 -0
- package/dist/types/commands/identityCreate.d.ts +39 -0
- package/dist/types/commands/identityImports.d.ts +24 -0
- package/dist/types/commands/identityVerifiableCredentialCreate.d.ts +43 -0
- package/dist/types/commands/identityVerificationMethodCreate.d.ts +47 -0
- package/dist/types/commands/identityVerificationMethodImport.d.ts +31 -0
- package/dist/types/commands/nodeSetIdentity.d.ts +22 -0
- package/dist/types/commands/tenantCreate.d.ts +38 -0
- package/dist/types/commands/tenantImport.d.ts +26 -0
- package/dist/types/commands/tenantToken.d.ts +28 -0
- package/dist/types/commands/tenantUpdate.d.ts +26 -0
- package/dist/types/commands/userCreate.d.ts +51 -0
- package/dist/types/commands/userUpdate.d.ts +40 -0
- package/dist/types/commands/vaultKeyCreate.d.ts +43 -0
- package/dist/types/commands/vaultKeyImport.d.ts +28 -0
- package/dist/types/defaults.d.ts +10 -2
- package/dist/types/index.d.ts +11 -4
- package/dist/types/models/ICliArgs.d.ts +20 -0
- package/dist/types/models/ICliCommand.d.ts +17 -0
- package/dist/types/models/ICliCommandDefinition.d.ts +41 -0
- package/dist/types/models/ICliCommandDefinitionParam.d.ts +35 -0
- package/dist/types/models/IEngineEnvironmentVariables.d.ts +132 -99
- package/dist/types/models/IEngineServerEnvironmentVariables.d.ts +8 -0
- package/dist/types/models/INodeEngineState.d.ts +0 -12
- package/dist/types/models/INodeEnvironmentVariables.d.ts +0 -38
- package/dist/types/models/INodeOptions.d.ts +6 -2
- package/dist/types/models/cliCommandParamType.d.ts +4 -0
- package/dist/types/models/nodeExtensionInitialiseEngineMethod.d.ts +7 -0
- package/dist/types/models/nodeExtensionInitialiseEngineServerMethod.d.ts +8 -0
- package/dist/types/models/nodeExtensionInitialiseMethod.d.ts +8 -0
- package/dist/types/models/nodeExtensionShutdownMethod.d.ts +5 -0
- package/dist/types/node.d.ts +5 -4
- package/dist/types/{server.d.ts → start.d.ts} +4 -2
- package/dist/types/utils.d.ts +6 -8
- package/docs/changelog.md +611 -178
- package/docs/examples.md +99 -1
- package/docs/reference/functions/buildConfiguration.md +1 -1
- package/docs/reference/functions/buildEngineServerConfiguration.md +1 -1
- package/docs/reference/functions/constructCliCommand.md +27 -0
- package/docs/reference/functions/executeCommand.md +29 -0
- package/docs/reference/functions/getEnvDefaults.md +19 -0
- package/docs/reference/functions/getScriptDirectory.md +19 -0
- package/docs/reference/functions/isAuthEntityStorageRequired.md +20 -0
- package/docs/reference/functions/isAutomationRequired.md +20 -0
- package/docs/reference/functions/isBackgroundTasksRequired.md +20 -0
- package/docs/reference/functions/isFederatedCatalogueRequired.md +20 -0
- package/docs/reference/functions/isImmutableProofRequired.md +20 -0
- package/docs/reference/functions/isRightsManagementRequired.md +23 -0
- package/docs/reference/functions/isTaskSchedulerRequired.md +20 -0
- package/docs/reference/functions/isTelemetryRequired.md +20 -0
- package/docs/reference/functions/isTrustRequired.md +20 -0
- package/docs/reference/functions/isUrlTransformerRequired.md +20 -0
- package/docs/reference/functions/parseCommandLineArgs.md +19 -0
- package/docs/reference/functions/processEnvOptions.md +27 -0
- package/docs/reference/functions/registerCommands.md +9 -0
- package/docs/reference/functions/resolvePackageEntryPoint.md +2 -2
- package/docs/reference/functions/run.md +8 -2
- package/docs/reference/functions/start.md +9 -3
- package/docs/reference/functions/substituteEnvOptions.md +25 -0
- package/docs/reference/index.md +26 -14
- package/docs/reference/interfaces/ICacheMetadata.md +3 -3
- package/docs/reference/interfaces/ICliArgs.md +35 -0
- package/docs/reference/interfaces/ICliCommand.md +23 -0
- package/docs/reference/interfaces/ICliCommandDefinition.md +87 -0
- package/docs/reference/interfaces/ICliCommandDefinitionParam.md +65 -0
- package/docs/reference/interfaces/IEngineEnvironmentVariables.md +418 -369
- package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md +546 -445
- package/docs/reference/interfaces/IModuleProtocol.md +3 -3
- package/docs/reference/interfaces/INodeEngineState.md +2 -26
- package/docs/reference/interfaces/INodeEnvironmentVariables.md +564 -539
- package/docs/reference/interfaces/INodeOptions.md +44 -36
- package/docs/reference/interfaces/IProtocolHandlerResult.md +2 -2
- package/docs/reference/type-aliases/CliCommandParamType.md +5 -0
- package/docs/reference/type-aliases/NodeExtensionInitialiseEngineMethod.md +1 -1
- package/docs/reference/type-aliases/NodeExtensionInitialiseEngineServerMethod.md +1 -1
- package/docs/reference/type-aliases/NodeExtensionInitialiseMethod.md +1 -1
- package/docs/reference/type-aliases/NodeExtensionShutdownMethod.md +1 -1
- package/docs/reference/variables/ModuleProtocol.md +5 -5
- package/docs/reference/variables/TRUST_VERIFICATION_METHOD_ID.md +3 -0
- package/docs/reference/variables/URL_TRANSFORMER_ENCRYPTION_KEY_ID.md +3 -0
- package/locales/en.json +605 -30
- package/package.json +10 -6
- package/dist/es/bootstrap.js +0 -366
- package/dist/es/bootstrap.js.map +0 -1
- package/dist/es/identity.js +0 -182
- package/dist/es/identity.js.map +0 -1
- package/dist/es/models/nodeExtensionMethods.js +0 -2
- package/dist/es/models/nodeExtensionMethods.js.map +0 -1
- package/dist/es/models/nodeFeatures.js +0 -21
- package/dist/es/models/nodeFeatures.js.map +0 -1
- package/dist/es/server.js.map +0 -1
- package/dist/types/bootstrap.d.ts +0 -68
- package/dist/types/identity.d.ts +0 -14
- package/dist/types/models/nodeExtensionMethods.d.ts +0 -27
- package/dist/types/models/nodeFeatures.d.ts +0 -21
- package/docs/detailed-guide.md +0 -129
- package/docs/reference/functions/bootstrap.md +0 -29
- package/docs/reference/functions/bootstrapAuth.md +0 -35
- package/docs/reference/functions/bootstrapBlobEncryption.md +0 -35
- package/docs/reference/functions/bootstrapImmutableProofMethod.md +0 -35
- package/docs/reference/functions/bootstrapNodeAdminUser.md +0 -35
- package/docs/reference/functions/bootstrapNodeId.md +0 -35
- package/docs/reference/functions/bootstrapSynchronisedStorage.md +0 -35
- package/docs/reference/functions/bootstrapTenantId.md +0 -35
- package/docs/reference/functions/getFeatures.md +0 -19
- package/docs/reference/type-aliases/NodeFeatures.md +0 -5
- package/docs/reference/variables/NodeFeatures.md +0 -25
- package/docs/reference/variables/SYNCHRONISED_STORAGE_BLOB_STORAGE_ENCRYPTION_KEY_ID.md +0 -3
- package/docs/reference/variables/VC_AUTHENTICATION_VERIFICATION_METHOD_ID.md +0 -3
|
@@ -12,9 +12,9 @@ The engine server environment variables.
|
|
|
12
12
|
|
|
13
13
|
## Properties
|
|
14
14
|
|
|
15
|
-
### debug?
|
|
15
|
+
### debug? {#debug}
|
|
16
16
|
|
|
17
|
-
> `optional` **debug
|
|
17
|
+
> `optional` **debug?**: `string`
|
|
18
18
|
|
|
19
19
|
Start the engine in debug mode.
|
|
20
20
|
|
|
@@ -24,69 +24,69 @@ Start the engine in debug mode.
|
|
|
24
24
|
|
|
25
25
|
***
|
|
26
26
|
|
|
27
|
-
###
|
|
27
|
+
### silent? {#silent}
|
|
28
28
|
|
|
29
|
-
> `optional` **
|
|
29
|
+
> `optional` **silent?**: `string`
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
Start the engine in silent mode.
|
|
32
32
|
|
|
33
33
|
#### Inherited from
|
|
34
34
|
|
|
35
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
35
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`silent`](IEngineEnvironmentVariables.md#silent)
|
|
36
36
|
|
|
37
37
|
***
|
|
38
38
|
|
|
39
|
-
###
|
|
39
|
+
### storageFileRoot? {#storagefileroot}
|
|
40
40
|
|
|
41
|
-
> `optional` **
|
|
41
|
+
> `optional` **storageFileRoot?**: `string`
|
|
42
42
|
|
|
43
|
-
The
|
|
43
|
+
The root directory for storing items like state file.
|
|
44
44
|
|
|
45
45
|
#### Inherited from
|
|
46
46
|
|
|
47
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
47
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`storageFileRoot`](IEngineEnvironmentVariables.md#storagefileroot)
|
|
48
48
|
|
|
49
49
|
***
|
|
50
50
|
|
|
51
|
-
###
|
|
51
|
+
### stateFilename? {#statefilename}
|
|
52
52
|
|
|
53
|
-
> `optional` **
|
|
53
|
+
> `optional` **stateFilename?**: `string`
|
|
54
54
|
|
|
55
|
-
|
|
55
|
+
The name of the state file.
|
|
56
56
|
|
|
57
57
|
#### Inherited from
|
|
58
58
|
|
|
59
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
59
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`stateFilename`](IEngineEnvironmentVariables.md#statefilename)
|
|
60
60
|
|
|
61
61
|
***
|
|
62
62
|
|
|
63
|
-
###
|
|
63
|
+
### nodeIdentityEnabled? {#nodeidentityenabled}
|
|
64
64
|
|
|
65
|
-
> `optional` **
|
|
65
|
+
> `optional` **nodeIdentityEnabled?**: `string`
|
|
66
66
|
|
|
67
|
-
|
|
67
|
+
Does the node have a unique ID, defaults to true.
|
|
68
68
|
|
|
69
69
|
#### Inherited from
|
|
70
70
|
|
|
71
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
71
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`nodeIdentityEnabled`](IEngineEnvironmentVariables.md#nodeidentityenabled)
|
|
72
72
|
|
|
73
73
|
***
|
|
74
74
|
|
|
75
|
-
###
|
|
75
|
+
### tenantEnabled? {#tenantenabled}
|
|
76
76
|
|
|
77
|
-
> `optional` **
|
|
77
|
+
> `optional` **tenantEnabled?**: `string`
|
|
78
78
|
|
|
79
|
-
|
|
79
|
+
Is multi-tenant support enabled, defaults to false.
|
|
80
80
|
|
|
81
81
|
#### Inherited from
|
|
82
82
|
|
|
83
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
83
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`tenantEnabled`](IEngineEnvironmentVariables.md#tenantenabled)
|
|
84
84
|
|
|
85
85
|
***
|
|
86
86
|
|
|
87
|
-
### entityStorageConnectorType?
|
|
87
|
+
### entityStorageConnectorType? {#entitystorageconnectortype}
|
|
88
88
|
|
|
89
|
-
> `optional` **entityStorageConnectorType
|
|
89
|
+
> `optional` **entityStorageConnectorType?**: `string`
|
|
90
90
|
|
|
91
91
|
The type of the entity storage to create, comma separate for more than one connector.
|
|
92
92
|
values: file, memory, aws-dynamodb, azure-cosmosdb, gcp-firestoredb, scylladb, mysql, mongodb, postgresql
|
|
@@ -97,9 +97,9 @@ values: file, memory, aws-dynamodb, azure-cosmosdb, gcp-firestoredb, scylladb, m
|
|
|
97
97
|
|
|
98
98
|
***
|
|
99
99
|
|
|
100
|
-
### entityStorageConnectorDefault?
|
|
100
|
+
### entityStorageConnectorDefault? {#entitystorageconnectordefault}
|
|
101
101
|
|
|
102
|
-
> `optional` **entityStorageConnectorDefault
|
|
102
|
+
> `optional` **entityStorageConnectorDefault?**: `string`
|
|
103
103
|
|
|
104
104
|
The default entity storage connector to use, defaults to the first one in the list.
|
|
105
105
|
|
|
@@ -109,9 +109,9 @@ The default entity storage connector to use, defaults to the first one in the li
|
|
|
109
109
|
|
|
110
110
|
***
|
|
111
111
|
|
|
112
|
-
### entityStorageTablePrefix?
|
|
112
|
+
### entityStorageTablePrefix? {#entitystoragetableprefix}
|
|
113
113
|
|
|
114
|
-
> `optional` **entityStorageTablePrefix
|
|
114
|
+
> `optional` **entityStorageTablePrefix?**: `string`
|
|
115
115
|
|
|
116
116
|
A prefix for all the table in entity-storage, can be empty.
|
|
117
117
|
|
|
@@ -121,9 +121,9 @@ A prefix for all the table in entity-storage, can be empty.
|
|
|
121
121
|
|
|
122
122
|
***
|
|
123
123
|
|
|
124
|
-
### awsDynamodbAuthMode?
|
|
124
|
+
### awsDynamodbAuthMode? {#awsdynamodbauthmode}
|
|
125
125
|
|
|
126
|
-
> `optional` **awsDynamodbAuthMode
|
|
126
|
+
> `optional` **awsDynamodbAuthMode?**: `string`
|
|
127
127
|
|
|
128
128
|
AWS DynamoDB auth mode, either credentials or pod.
|
|
129
129
|
|
|
@@ -133,9 +133,9 @@ AWS DynamoDB auth mode, either credentials or pod.
|
|
|
133
133
|
|
|
134
134
|
***
|
|
135
135
|
|
|
136
|
-
### awsDynamodbAccessKeyId?
|
|
136
|
+
### awsDynamodbAccessKeyId? {#awsdynamodbaccesskeyid}
|
|
137
137
|
|
|
138
|
-
> `optional` **awsDynamodbAccessKeyId
|
|
138
|
+
> `optional` **awsDynamodbAccessKeyId?**: `string`
|
|
139
139
|
|
|
140
140
|
AWS Dynamo DB access key id.
|
|
141
141
|
|
|
@@ -145,9 +145,9 @@ AWS Dynamo DB access key id.
|
|
|
145
145
|
|
|
146
146
|
***
|
|
147
147
|
|
|
148
|
-
### awsDynamodbEndpoint?
|
|
148
|
+
### awsDynamodbEndpoint? {#awsdynamodbendpoint}
|
|
149
149
|
|
|
150
|
-
> `optional` **awsDynamodbEndpoint
|
|
150
|
+
> `optional` **awsDynamodbEndpoint?**: `string`
|
|
151
151
|
|
|
152
152
|
AWS Dynamo DB Endpoint if running local instance.
|
|
153
153
|
|
|
@@ -157,9 +157,9 @@ AWS Dynamo DB Endpoint if running local instance.
|
|
|
157
157
|
|
|
158
158
|
***
|
|
159
159
|
|
|
160
|
-
### awsDynamodbRegion?
|
|
160
|
+
### awsDynamodbRegion? {#awsdynamodbregion}
|
|
161
161
|
|
|
162
|
-
> `optional` **awsDynamodbRegion
|
|
162
|
+
> `optional` **awsDynamodbRegion?**: `string`
|
|
163
163
|
|
|
164
164
|
AWS Dynamo DB region.
|
|
165
165
|
|
|
@@ -169,9 +169,9 @@ AWS Dynamo DB region.
|
|
|
169
169
|
|
|
170
170
|
***
|
|
171
171
|
|
|
172
|
-
### awsDynamodbSecretAccessKey?
|
|
172
|
+
### awsDynamodbSecretAccessKey? {#awsdynamodbsecretaccesskey}
|
|
173
173
|
|
|
174
|
-
> `optional` **awsDynamodbSecretAccessKey
|
|
174
|
+
> `optional` **awsDynamodbSecretAccessKey?**: `string`
|
|
175
175
|
|
|
176
176
|
AWS Dynamo DB secret access key.
|
|
177
177
|
|
|
@@ -181,9 +181,9 @@ AWS Dynamo DB secret access key.
|
|
|
181
181
|
|
|
182
182
|
***
|
|
183
183
|
|
|
184
|
-
### awsDynamodbConnectionTimeoutMs?
|
|
184
|
+
### awsDynamodbConnectionTimeoutMs? {#awsdynamodbconnectiontimeoutms}
|
|
185
185
|
|
|
186
|
-
> `optional` **awsDynamodbConnectionTimeoutMs
|
|
186
|
+
> `optional` **awsDynamodbConnectionTimeoutMs?**: `string`
|
|
187
187
|
|
|
188
188
|
AWS Dynamo DB connection timeout.
|
|
189
189
|
|
|
@@ -193,9 +193,9 @@ AWS Dynamo DB connection timeout.
|
|
|
193
193
|
|
|
194
194
|
***
|
|
195
195
|
|
|
196
|
-
### azureCosmosdbKey?
|
|
196
|
+
### azureCosmosdbKey? {#azurecosmosdbkey}
|
|
197
197
|
|
|
198
|
-
> `optional` **azureCosmosdbKey
|
|
198
|
+
> `optional` **azureCosmosdbKey?**: `string`
|
|
199
199
|
|
|
200
200
|
Azure Cosmos DB key.
|
|
201
201
|
|
|
@@ -205,9 +205,9 @@ Azure Cosmos DB key.
|
|
|
205
205
|
|
|
206
206
|
***
|
|
207
207
|
|
|
208
|
-
### azureCosmosdbContainerId?
|
|
208
|
+
### azureCosmosdbContainerId? {#azurecosmosdbcontainerid}
|
|
209
209
|
|
|
210
|
-
> `optional` **azureCosmosdbContainerId
|
|
210
|
+
> `optional` **azureCosmosdbContainerId?**: `string`
|
|
211
211
|
|
|
212
212
|
Azure Cosmos DB container id.
|
|
213
213
|
|
|
@@ -217,9 +217,9 @@ Azure Cosmos DB container id.
|
|
|
217
217
|
|
|
218
218
|
***
|
|
219
219
|
|
|
220
|
-
### azureCosmosdbDatabaseId?
|
|
220
|
+
### azureCosmosdbDatabaseId? {#azurecosmosdbdatabaseid}
|
|
221
221
|
|
|
222
|
-
> `optional` **azureCosmosdbDatabaseId
|
|
222
|
+
> `optional` **azureCosmosdbDatabaseId?**: `string`
|
|
223
223
|
|
|
224
224
|
Azure Cosmos DB database id.
|
|
225
225
|
|
|
@@ -229,9 +229,9 @@ Azure Cosmos DB database id.
|
|
|
229
229
|
|
|
230
230
|
***
|
|
231
231
|
|
|
232
|
-
### azureCosmosdbEndpoint?
|
|
232
|
+
### azureCosmosdbEndpoint? {#azurecosmosdbendpoint}
|
|
233
233
|
|
|
234
|
-
> `optional` **azureCosmosdbEndpoint
|
|
234
|
+
> `optional` **azureCosmosdbEndpoint?**: `string`
|
|
235
235
|
|
|
236
236
|
Azure Cosmos DB endpoint.
|
|
237
237
|
|
|
@@ -241,9 +241,9 @@ Azure Cosmos DB endpoint.
|
|
|
241
241
|
|
|
242
242
|
***
|
|
243
243
|
|
|
244
|
-
### gcpFirestoreCollectionName?
|
|
244
|
+
### gcpFirestoreCollectionName? {#gcpfirestorecollectionname}
|
|
245
245
|
|
|
246
|
-
> `optional` **gcpFirestoreCollectionName
|
|
246
|
+
> `optional` **gcpFirestoreCollectionName?**: `string`
|
|
247
247
|
|
|
248
248
|
GCP Firestore collection name.
|
|
249
249
|
|
|
@@ -253,9 +253,9 @@ GCP Firestore collection name.
|
|
|
253
253
|
|
|
254
254
|
***
|
|
255
255
|
|
|
256
|
-
### gcpFirestoreCredentials?
|
|
256
|
+
### gcpFirestoreCredentials? {#gcpfirestorecredentials}
|
|
257
257
|
|
|
258
|
-
> `optional` **gcpFirestoreCredentials
|
|
258
|
+
> `optional` **gcpFirestoreCredentials?**: `string`
|
|
259
259
|
|
|
260
260
|
GCP Firestore credentials.
|
|
261
261
|
|
|
@@ -265,9 +265,9 @@ GCP Firestore credentials.
|
|
|
265
265
|
|
|
266
266
|
***
|
|
267
267
|
|
|
268
|
-
### gcpFirestoreDatabaseId?
|
|
268
|
+
### gcpFirestoreDatabaseId? {#gcpfirestoredatabaseid}
|
|
269
269
|
|
|
270
|
-
> `optional` **gcpFirestoreDatabaseId
|
|
270
|
+
> `optional` **gcpFirestoreDatabaseId?**: `string`
|
|
271
271
|
|
|
272
272
|
GCP Firestore database id.
|
|
273
273
|
|
|
@@ -277,21 +277,21 @@ GCP Firestore database id.
|
|
|
277
277
|
|
|
278
278
|
***
|
|
279
279
|
|
|
280
|
-
###
|
|
280
|
+
### gcpFirestoreEndpoint? {#gcpfirestoreendpoint}
|
|
281
281
|
|
|
282
|
-
> `optional` **
|
|
282
|
+
> `optional` **gcpFirestoreEndpoint?**: `string`
|
|
283
283
|
|
|
284
284
|
GCP Firestore endpoint.
|
|
285
285
|
|
|
286
286
|
#### Inherited from
|
|
287
287
|
|
|
288
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
288
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpFirestoreEndpoint`](IEngineEnvironmentVariables.md#gcpfirestoreendpoint)
|
|
289
289
|
|
|
290
290
|
***
|
|
291
291
|
|
|
292
|
-
### gcpFirestoreProjectId?
|
|
292
|
+
### gcpFirestoreProjectId? {#gcpfirestoreprojectid}
|
|
293
293
|
|
|
294
|
-
> `optional` **gcpFirestoreProjectId
|
|
294
|
+
> `optional` **gcpFirestoreProjectId?**: `string`
|
|
295
295
|
|
|
296
296
|
GCP Firestore project id.
|
|
297
297
|
|
|
@@ -301,9 +301,9 @@ GCP Firestore project id.
|
|
|
301
301
|
|
|
302
302
|
***
|
|
303
303
|
|
|
304
|
-
### scylladbHosts?
|
|
304
|
+
### scylladbHosts? {#scylladbhosts}
|
|
305
305
|
|
|
306
|
-
> `optional` **scylladbHosts
|
|
306
|
+
> `optional` **scylladbHosts?**: `string`
|
|
307
307
|
|
|
308
308
|
ScyllaDB hosts as comma separated string.
|
|
309
309
|
|
|
@@ -313,9 +313,9 @@ ScyllaDB hosts as comma separated string.
|
|
|
313
313
|
|
|
314
314
|
***
|
|
315
315
|
|
|
316
|
-
### scylladbKeyspace?
|
|
316
|
+
### scylladbKeyspace? {#scylladbkeyspace}
|
|
317
317
|
|
|
318
|
-
> `optional` **scylladbKeyspace
|
|
318
|
+
> `optional` **scylladbKeyspace?**: `string`
|
|
319
319
|
|
|
320
320
|
ScyllaDB keyspace.
|
|
321
321
|
|
|
@@ -325,9 +325,9 @@ ScyllaDB keyspace.
|
|
|
325
325
|
|
|
326
326
|
***
|
|
327
327
|
|
|
328
|
-
### scylladbLocalDataCenter?
|
|
328
|
+
### scylladbLocalDataCenter? {#scylladblocaldatacenter}
|
|
329
329
|
|
|
330
|
-
> `optional` **scylladbLocalDataCenter
|
|
330
|
+
> `optional` **scylladbLocalDataCenter?**: `string`
|
|
331
331
|
|
|
332
332
|
ScyllaDB local data center.
|
|
333
333
|
|
|
@@ -337,9 +337,9 @@ ScyllaDB local data center.
|
|
|
337
337
|
|
|
338
338
|
***
|
|
339
339
|
|
|
340
|
-
### scylladbPort?
|
|
340
|
+
### scylladbPort? {#scylladbport}
|
|
341
341
|
|
|
342
|
-
> `optional` **scylladbPort
|
|
342
|
+
> `optional` **scylladbPort?**: `string`
|
|
343
343
|
|
|
344
344
|
ScyllaDB port.
|
|
345
345
|
|
|
@@ -349,9 +349,9 @@ ScyllaDB port.
|
|
|
349
349
|
|
|
350
350
|
***
|
|
351
351
|
|
|
352
|
-
### mySqlHost?
|
|
352
|
+
### mySqlHost? {#mysqlhost}
|
|
353
353
|
|
|
354
|
-
> `optional` **mySqlHost
|
|
354
|
+
> `optional` **mySqlHost?**: `string`
|
|
355
355
|
|
|
356
356
|
MySQL host.
|
|
357
357
|
|
|
@@ -361,9 +361,9 @@ MySQL host.
|
|
|
361
361
|
|
|
362
362
|
***
|
|
363
363
|
|
|
364
|
-
### mySqlPort?
|
|
364
|
+
### mySqlPort? {#mysqlport}
|
|
365
365
|
|
|
366
|
-
> `optional` **mySqlPort
|
|
366
|
+
> `optional` **mySqlPort?**: `number`
|
|
367
367
|
|
|
368
368
|
MySQL port.
|
|
369
369
|
|
|
@@ -373,9 +373,9 @@ MySQL port.
|
|
|
373
373
|
|
|
374
374
|
***
|
|
375
375
|
|
|
376
|
-
### mySqlUser?
|
|
376
|
+
### mySqlUser? {#mysqluser}
|
|
377
377
|
|
|
378
|
-
> `optional` **mySqlUser
|
|
378
|
+
> `optional` **mySqlUser?**: `string`
|
|
379
379
|
|
|
380
380
|
MySQL username.
|
|
381
381
|
|
|
@@ -385,9 +385,9 @@ MySQL username.
|
|
|
385
385
|
|
|
386
386
|
***
|
|
387
387
|
|
|
388
|
-
### mySqlPassword?
|
|
388
|
+
### mySqlPassword? {#mysqlpassword}
|
|
389
389
|
|
|
390
|
-
> `optional` **mySqlPassword
|
|
390
|
+
> `optional` **mySqlPassword?**: `string`
|
|
391
391
|
|
|
392
392
|
MySQL password.
|
|
393
393
|
|
|
@@ -397,9 +397,9 @@ MySQL password.
|
|
|
397
397
|
|
|
398
398
|
***
|
|
399
399
|
|
|
400
|
-
### mySqlDatabase?
|
|
400
|
+
### mySqlDatabase? {#mysqldatabase}
|
|
401
401
|
|
|
402
|
-
> `optional` **mySqlDatabase
|
|
402
|
+
> `optional` **mySqlDatabase?**: `string`
|
|
403
403
|
|
|
404
404
|
MySQL Database.
|
|
405
405
|
|
|
@@ -409,9 +409,9 @@ MySQL Database.
|
|
|
409
409
|
|
|
410
410
|
***
|
|
411
411
|
|
|
412
|
-
### mongoDbHost?
|
|
412
|
+
### mongoDbHost? {#mongodbhost}
|
|
413
413
|
|
|
414
|
-
> `optional` **mongoDbHost
|
|
414
|
+
> `optional` **mongoDbHost?**: `string`
|
|
415
415
|
|
|
416
416
|
MongoDB host.
|
|
417
417
|
|
|
@@ -421,9 +421,9 @@ MongoDB host.
|
|
|
421
421
|
|
|
422
422
|
***
|
|
423
423
|
|
|
424
|
-
### mongoDbPort?
|
|
424
|
+
### mongoDbPort? {#mongodbport}
|
|
425
425
|
|
|
426
|
-
> `optional` **mongoDbPort
|
|
426
|
+
> `optional` **mongoDbPort?**: `number`
|
|
427
427
|
|
|
428
428
|
MongoDB port.
|
|
429
429
|
|
|
@@ -433,9 +433,9 @@ MongoDB port.
|
|
|
433
433
|
|
|
434
434
|
***
|
|
435
435
|
|
|
436
|
-
### mongoDbUser?
|
|
436
|
+
### mongoDbUser? {#mongodbuser}
|
|
437
437
|
|
|
438
|
-
> `optional` **mongoDbUser
|
|
438
|
+
> `optional` **mongoDbUser?**: `string`
|
|
439
439
|
|
|
440
440
|
MongoDB username.
|
|
441
441
|
|
|
@@ -445,9 +445,9 @@ MongoDB username.
|
|
|
445
445
|
|
|
446
446
|
***
|
|
447
447
|
|
|
448
|
-
### mongoDbPassword?
|
|
448
|
+
### mongoDbPassword? {#mongodbpassword}
|
|
449
449
|
|
|
450
|
-
> `optional` **mongoDbPassword
|
|
450
|
+
> `optional` **mongoDbPassword?**: `string`
|
|
451
451
|
|
|
452
452
|
MongoDB password.
|
|
453
453
|
|
|
@@ -457,9 +457,9 @@ MongoDB password.
|
|
|
457
457
|
|
|
458
458
|
***
|
|
459
459
|
|
|
460
|
-
### mongoDbDatabase?
|
|
460
|
+
### mongoDbDatabase? {#mongodbdatabase}
|
|
461
461
|
|
|
462
|
-
> `optional` **mongoDbDatabase
|
|
462
|
+
> `optional` **mongoDbDatabase?**: `string`
|
|
463
463
|
|
|
464
464
|
MongoDB Database.
|
|
465
465
|
|
|
@@ -469,9 +469,9 @@ MongoDB Database.
|
|
|
469
469
|
|
|
470
470
|
***
|
|
471
471
|
|
|
472
|
-
### postgreSqlHost?
|
|
472
|
+
### postgreSqlHost? {#postgresqlhost}
|
|
473
473
|
|
|
474
|
-
> `optional` **postgreSqlHost
|
|
474
|
+
> `optional` **postgreSqlHost?**: `string`
|
|
475
475
|
|
|
476
476
|
PostgreSQl host.
|
|
477
477
|
|
|
@@ -481,9 +481,9 @@ PostgreSQl host.
|
|
|
481
481
|
|
|
482
482
|
***
|
|
483
483
|
|
|
484
|
-
### postgreSqlPort?
|
|
484
|
+
### postgreSqlPort? {#postgresqlport}
|
|
485
485
|
|
|
486
|
-
> `optional` **postgreSqlPort
|
|
486
|
+
> `optional` **postgreSqlPort?**: `number`
|
|
487
487
|
|
|
488
488
|
PostgreSQl port.
|
|
489
489
|
|
|
@@ -493,9 +493,9 @@ PostgreSQl port.
|
|
|
493
493
|
|
|
494
494
|
***
|
|
495
495
|
|
|
496
|
-
### postgreSqlUser?
|
|
496
|
+
### postgreSqlUser? {#postgresqluser}
|
|
497
497
|
|
|
498
|
-
> `optional` **postgreSqlUser
|
|
498
|
+
> `optional` **postgreSqlUser?**: `string`
|
|
499
499
|
|
|
500
500
|
PostgreSQl username.
|
|
501
501
|
|
|
@@ -505,9 +505,9 @@ PostgreSQl username.
|
|
|
505
505
|
|
|
506
506
|
***
|
|
507
507
|
|
|
508
|
-
### postgreSqlPassword?
|
|
508
|
+
### postgreSqlPassword? {#postgresqlpassword}
|
|
509
509
|
|
|
510
|
-
> `optional` **postgreSqlPassword
|
|
510
|
+
> `optional` **postgreSqlPassword?**: `string`
|
|
511
511
|
|
|
512
512
|
PostgreSQl password.
|
|
513
513
|
|
|
@@ -517,9 +517,9 @@ PostgreSQl password.
|
|
|
517
517
|
|
|
518
518
|
***
|
|
519
519
|
|
|
520
|
-
### postgreSqlDatabase?
|
|
520
|
+
### postgreSqlDatabase? {#postgresqldatabase}
|
|
521
521
|
|
|
522
|
-
> `optional` **postgreSqlDatabase
|
|
522
|
+
> `optional` **postgreSqlDatabase?**: `string`
|
|
523
523
|
|
|
524
524
|
PostgreSQl Database.
|
|
525
525
|
|
|
@@ -529,9 +529,9 @@ PostgreSQl Database.
|
|
|
529
529
|
|
|
530
530
|
***
|
|
531
531
|
|
|
532
|
-
### ipfsBearerToken?
|
|
532
|
+
### ipfsBearerToken? {#ipfsbearertoken}
|
|
533
533
|
|
|
534
|
-
> `optional` **ipfsBearerToken
|
|
534
|
+
> `optional` **ipfsBearerToken?**: `string`
|
|
535
535
|
|
|
536
536
|
The security token for accessing IPFS API.
|
|
537
537
|
|
|
@@ -541,9 +541,9 @@ The security token for accessing IPFS API.
|
|
|
541
541
|
|
|
542
542
|
***
|
|
543
543
|
|
|
544
|
-
### ipfsApiUrl?
|
|
544
|
+
### ipfsApiUrl? {#ipfsapiurl}
|
|
545
545
|
|
|
546
|
-
> `optional` **ipfsApiUrl
|
|
546
|
+
> `optional` **ipfsApiUrl?**: `string`
|
|
547
547
|
|
|
548
548
|
The url for accessing IPFS API.
|
|
549
549
|
|
|
@@ -553,9 +553,9 @@ The url for accessing IPFS API.
|
|
|
553
553
|
|
|
554
554
|
***
|
|
555
555
|
|
|
556
|
-
### blobStorageConnectorType?
|
|
556
|
+
### blobStorageConnectorType? {#blobstorageconnectortype}
|
|
557
557
|
|
|
558
|
-
> `optional` **blobStorageConnectorType
|
|
558
|
+
> `optional` **blobStorageConnectorType?**: `string`
|
|
559
559
|
|
|
560
560
|
The type of the entity storage to create, comma separate for more than one connector.
|
|
561
561
|
values: memory, file, ipfs, aws-s3, azure-storage, gcp-storage.
|
|
@@ -566,9 +566,9 @@ values: memory, file, ipfs, aws-s3, azure-storage, gcp-storage.
|
|
|
566
566
|
|
|
567
567
|
***
|
|
568
568
|
|
|
569
|
-
### blobStorageConnectorDefault?
|
|
569
|
+
### blobStorageConnectorDefault? {#blobstorageconnectordefault}
|
|
570
570
|
|
|
571
|
-
> `optional` **blobStorageConnectorDefault
|
|
571
|
+
> `optional` **blobStorageConnectorDefault?**: `string`
|
|
572
572
|
|
|
573
573
|
The default blob storage connector to use, defaults to the first one in the list.
|
|
574
574
|
|
|
@@ -578,21 +578,9 @@ The default blob storage connector to use, defaults to the first one in the list
|
|
|
578
578
|
|
|
579
579
|
***
|
|
580
580
|
|
|
581
|
-
###
|
|
582
|
-
|
|
583
|
-
> `optional` **blobStorageConnectorPublic**: `string`
|
|
581
|
+
### blobStorageEnableEncryption? {#blobstorageenableencryption}
|
|
584
582
|
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
#### Inherited from
|
|
588
|
-
|
|
589
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageConnectorPublic`](IEngineEnvironmentVariables.md#blobstorageconnectorpublic)
|
|
590
|
-
|
|
591
|
-
***
|
|
592
|
-
|
|
593
|
-
### blobStorageEnableEncryption?
|
|
594
|
-
|
|
595
|
-
> `optional` **blobStorageEnableEncryption**: `string`
|
|
583
|
+
> `optional` **blobStorageEnableEncryption?**: `string`
|
|
596
584
|
|
|
597
585
|
Enable encryption for the blob storage.
|
|
598
586
|
|
|
@@ -602,9 +590,9 @@ Enable encryption for the blob storage.
|
|
|
602
590
|
|
|
603
591
|
***
|
|
604
592
|
|
|
605
|
-
### blobStorageEncryptionKeyId?
|
|
593
|
+
### blobStorageEncryptionKeyId? {#blobstorageencryptionkeyid}
|
|
606
594
|
|
|
607
|
-
> `optional` **blobStorageEncryptionKeyId
|
|
595
|
+
> `optional` **blobStorageEncryptionKeyId?**: `string`
|
|
608
596
|
|
|
609
597
|
The id of the encryption key for the blob storage.
|
|
610
598
|
|
|
@@ -614,22 +602,9 @@ The id of the encryption key for the blob storage.
|
|
|
614
602
|
|
|
615
603
|
***
|
|
616
604
|
|
|
617
|
-
###
|
|
618
|
-
|
|
619
|
-
> `optional` **blobStorageSymmetricEncryptionKey**: `string`
|
|
620
|
-
|
|
621
|
-
A symmetric encryption key for the blob storage, should be ChaCha20Poly1305 in base64 format.
|
|
622
|
-
If encryption is enabled but a key is not provided one will be generated.
|
|
605
|
+
### blobStoragePrefix? {#blobstorageprefix}
|
|
623
606
|
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageSymmetricEncryptionKey`](IEngineEnvironmentVariables.md#blobstoragesymmetricencryptionkey)
|
|
627
|
-
|
|
628
|
-
***
|
|
629
|
-
|
|
630
|
-
### blobStoragePrefix?
|
|
631
|
-
|
|
632
|
-
> `optional` **blobStoragePrefix**: `string`
|
|
607
|
+
> `optional` **blobStoragePrefix?**: `string`
|
|
633
608
|
|
|
634
609
|
A prefix for all the blobs in blob-storage, can be empty.
|
|
635
610
|
|
|
@@ -639,9 +614,9 @@ A prefix for all the blobs in blob-storage, can be empty.
|
|
|
639
614
|
|
|
640
615
|
***
|
|
641
616
|
|
|
642
|
-
### awsS3Region?
|
|
617
|
+
### awsS3Region? {#awss3region}
|
|
643
618
|
|
|
644
|
-
> `optional` **awsS3Region
|
|
619
|
+
> `optional` **awsS3Region?**: `string`
|
|
645
620
|
|
|
646
621
|
AWS S3 region.
|
|
647
622
|
|
|
@@ -651,9 +626,9 @@ AWS S3 region.
|
|
|
651
626
|
|
|
652
627
|
***
|
|
653
628
|
|
|
654
|
-
### awsS3BucketName?
|
|
629
|
+
### awsS3BucketName? {#awss3bucketname}
|
|
655
630
|
|
|
656
|
-
> `optional` **awsS3BucketName
|
|
631
|
+
> `optional` **awsS3BucketName?**: `string`
|
|
657
632
|
|
|
658
633
|
AWS S3 bucket name.
|
|
659
634
|
|
|
@@ -663,9 +638,9 @@ AWS S3 bucket name.
|
|
|
663
638
|
|
|
664
639
|
***
|
|
665
640
|
|
|
666
|
-
### awsS3AuthMode?
|
|
641
|
+
### awsS3AuthMode? {#awss3authmode}
|
|
667
642
|
|
|
668
|
-
> `optional` **awsS3AuthMode
|
|
643
|
+
> `optional` **awsS3AuthMode?**: `string`
|
|
669
644
|
|
|
670
645
|
AWS S3 auth mode, either credentials or pod, defaults to credentials.
|
|
671
646
|
|
|
@@ -675,9 +650,9 @@ AWS S3 auth mode, either credentials or pod, defaults to credentials.
|
|
|
675
650
|
|
|
676
651
|
***
|
|
677
652
|
|
|
678
|
-
### awsS3AccessKeyId?
|
|
653
|
+
### awsS3AccessKeyId? {#awss3accesskeyid}
|
|
679
654
|
|
|
680
|
-
> `optional` **awsS3AccessKeyId
|
|
655
|
+
> `optional` **awsS3AccessKeyId?**: `string`
|
|
681
656
|
|
|
682
657
|
AWS S3 access key id.
|
|
683
658
|
|
|
@@ -687,9 +662,9 @@ AWS S3 access key id.
|
|
|
687
662
|
|
|
688
663
|
***
|
|
689
664
|
|
|
690
|
-
### awsS3SecretAccessKey?
|
|
665
|
+
### awsS3SecretAccessKey? {#awss3secretaccesskey}
|
|
691
666
|
|
|
692
|
-
> `optional` **awsS3SecretAccessKey
|
|
667
|
+
> `optional` **awsS3SecretAccessKey?**: `string`
|
|
693
668
|
|
|
694
669
|
AWS S3 secret access key.
|
|
695
670
|
|
|
@@ -699,9 +674,9 @@ AWS S3 secret access key.
|
|
|
699
674
|
|
|
700
675
|
***
|
|
701
676
|
|
|
702
|
-
### awsS3Endpoint?
|
|
677
|
+
### awsS3Endpoint? {#awss3endpoint}
|
|
703
678
|
|
|
704
|
-
> `optional` **awsS3Endpoint
|
|
679
|
+
> `optional` **awsS3Endpoint?**: `string`
|
|
705
680
|
|
|
706
681
|
AWS S3 endpoint.
|
|
707
682
|
|
|
@@ -711,9 +686,9 @@ AWS S3 endpoint.
|
|
|
711
686
|
|
|
712
687
|
***
|
|
713
688
|
|
|
714
|
-
### azureStorageAccountKey?
|
|
689
|
+
### azureStorageAccountKey? {#azurestorageaccountkey}
|
|
715
690
|
|
|
716
|
-
> `optional` **azureStorageAccountKey
|
|
691
|
+
> `optional` **azureStorageAccountKey?**: `string`
|
|
717
692
|
|
|
718
693
|
Azure Storage account key.
|
|
719
694
|
|
|
@@ -723,9 +698,9 @@ Azure Storage account key.
|
|
|
723
698
|
|
|
724
699
|
***
|
|
725
700
|
|
|
726
|
-
### azureStorageAccountName?
|
|
701
|
+
### azureStorageAccountName? {#azurestorageaccountname}
|
|
727
702
|
|
|
728
|
-
> `optional` **azureStorageAccountName
|
|
703
|
+
> `optional` **azureStorageAccountName?**: `string`
|
|
729
704
|
|
|
730
705
|
Azure Storage account name.
|
|
731
706
|
|
|
@@ -735,9 +710,9 @@ Azure Storage account name.
|
|
|
735
710
|
|
|
736
711
|
***
|
|
737
712
|
|
|
738
|
-
### azureStorageContainerName?
|
|
713
|
+
### azureStorageContainerName? {#azurestoragecontainername}
|
|
739
714
|
|
|
740
|
-
> `optional` **azureStorageContainerName
|
|
715
|
+
> `optional` **azureStorageContainerName?**: `string`
|
|
741
716
|
|
|
742
717
|
Azure Storage container.
|
|
743
718
|
|
|
@@ -747,9 +722,9 @@ Azure Storage container.
|
|
|
747
722
|
|
|
748
723
|
***
|
|
749
724
|
|
|
750
|
-
### azureStorageEndpoint?
|
|
725
|
+
### azureStorageEndpoint? {#azurestorageendpoint}
|
|
751
726
|
|
|
752
|
-
> `optional` **azureStorageEndpoint
|
|
727
|
+
> `optional` **azureStorageEndpoint?**: `string`
|
|
753
728
|
|
|
754
729
|
Azure Storage endpoint.
|
|
755
730
|
|
|
@@ -759,9 +734,9 @@ Azure Storage endpoint.
|
|
|
759
734
|
|
|
760
735
|
***
|
|
761
736
|
|
|
762
|
-
### gcpStorageBucketName?
|
|
737
|
+
### gcpStorageBucketName? {#gcpstoragebucketname}
|
|
763
738
|
|
|
764
|
-
> `optional` **gcpStorageBucketName
|
|
739
|
+
> `optional` **gcpStorageBucketName?**: `string`
|
|
765
740
|
|
|
766
741
|
GCP Storage bucket.
|
|
767
742
|
|
|
@@ -771,9 +746,9 @@ GCP Storage bucket.
|
|
|
771
746
|
|
|
772
747
|
***
|
|
773
748
|
|
|
774
|
-
### gcpStorageCredentials?
|
|
749
|
+
### gcpStorageCredentials? {#gcpstoragecredentials}
|
|
775
750
|
|
|
776
|
-
> `optional` **gcpStorageCredentials
|
|
751
|
+
> `optional` **gcpStorageCredentials?**: `string`
|
|
777
752
|
|
|
778
753
|
GCP Storage credentials.
|
|
779
754
|
|
|
@@ -783,9 +758,9 @@ GCP Storage credentials.
|
|
|
783
758
|
|
|
784
759
|
***
|
|
785
760
|
|
|
786
|
-
### gcpStorageEndpoint?
|
|
761
|
+
### gcpStorageEndpoint? {#gcpstorageendpoint}
|
|
787
762
|
|
|
788
|
-
> `optional` **gcpStorageEndpoint
|
|
763
|
+
> `optional` **gcpStorageEndpoint?**: `string`
|
|
789
764
|
|
|
790
765
|
GCP Storage endpoint.
|
|
791
766
|
|
|
@@ -795,9 +770,9 @@ GCP Storage endpoint.
|
|
|
795
770
|
|
|
796
771
|
***
|
|
797
772
|
|
|
798
|
-
### gcpStorageProjectId?
|
|
773
|
+
### gcpStorageProjectId? {#gcpstorageprojectid}
|
|
799
774
|
|
|
800
|
-
> `optional` **gcpStorageProjectId
|
|
775
|
+
> `optional` **gcpStorageProjectId?**: `string`
|
|
801
776
|
|
|
802
777
|
GCP Storage project id.
|
|
803
778
|
|
|
@@ -807,9 +782,9 @@ GCP Storage project id.
|
|
|
807
782
|
|
|
808
783
|
***
|
|
809
784
|
|
|
810
|
-
### vaultConnector?
|
|
785
|
+
### vaultConnector? {#vaultconnector}
|
|
811
786
|
|
|
812
|
-
> `optional` **vaultConnector
|
|
787
|
+
> `optional` **vaultConnector?**: `string`
|
|
813
788
|
|
|
814
789
|
The type of the default vault connector: entity-storage, hashicorp.
|
|
815
790
|
|
|
@@ -819,9 +794,21 @@ The type of the default vault connector: entity-storage, hashicorp.
|
|
|
819
794
|
|
|
820
795
|
***
|
|
821
796
|
|
|
822
|
-
###
|
|
797
|
+
### vaultPrefix? {#vaultprefix}
|
|
798
|
+
|
|
799
|
+
> `optional` **vaultPrefix?**: `string`
|
|
800
|
+
|
|
801
|
+
Prefix to prepend to entries in the vault.
|
|
802
|
+
|
|
803
|
+
#### Inherited from
|
|
804
|
+
|
|
805
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`vaultPrefix`](IEngineEnvironmentVariables.md#vaultprefix)
|
|
806
|
+
|
|
807
|
+
***
|
|
808
|
+
|
|
809
|
+
### hashicorpVaultToken? {#hashicorpvaulttoken}
|
|
823
810
|
|
|
824
|
-
> `optional` **hashicorpVaultToken
|
|
811
|
+
> `optional` **hashicorpVaultToken?**: `string`
|
|
825
812
|
|
|
826
813
|
Hashicorp Vault token.
|
|
827
814
|
|
|
@@ -831,9 +818,9 @@ Hashicorp Vault token.
|
|
|
831
818
|
|
|
832
819
|
***
|
|
833
820
|
|
|
834
|
-
### hashicorpVaultEndpoint?
|
|
821
|
+
### hashicorpVaultEndpoint? {#hashicorpvaultendpoint}
|
|
835
822
|
|
|
836
|
-
> `optional` **hashicorpVaultEndpoint
|
|
823
|
+
> `optional` **hashicorpVaultEndpoint?**: `string`
|
|
837
824
|
|
|
838
825
|
Hashicorp Vault endpoint.
|
|
839
826
|
|
|
@@ -843,9 +830,9 @@ Hashicorp Vault endpoint.
|
|
|
843
830
|
|
|
844
831
|
***
|
|
845
832
|
|
|
846
|
-
### loggingConnector?
|
|
833
|
+
### loggingConnector? {#loggingconnector}
|
|
847
834
|
|
|
848
|
-
> `optional` **loggingConnector
|
|
835
|
+
> `optional` **loggingConnector?**: `string`
|
|
849
836
|
|
|
850
837
|
The type of logging task connector, can be a comma separated list: console, entity-storage.
|
|
851
838
|
|
|
@@ -855,21 +842,33 @@ The type of logging task connector, can be a comma separated list: console, enti
|
|
|
855
842
|
|
|
856
843
|
***
|
|
857
844
|
|
|
858
|
-
###
|
|
845
|
+
### loggingBatchSize? {#loggingbatchsize}
|
|
846
|
+
|
|
847
|
+
> `optional` **loggingBatchSize?**: `string`
|
|
848
|
+
|
|
849
|
+
The batch size for the logging task, set to 1 for no batching.
|
|
850
|
+
|
|
851
|
+
#### Inherited from
|
|
852
|
+
|
|
853
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`loggingBatchSize`](IEngineEnvironmentVariables.md#loggingbatchsize)
|
|
854
|
+
|
|
855
|
+
***
|
|
856
|
+
|
|
857
|
+
### loggingBatchFlushIntervalSeconds? {#loggingbatchflushintervalseconds}
|
|
859
858
|
|
|
860
|
-
> `optional` **
|
|
859
|
+
> `optional` **loggingBatchFlushIntervalSeconds?**: `string`
|
|
861
860
|
|
|
862
|
-
The
|
|
861
|
+
The batch flush interval in seconds for the logging task, how often to flush the logs when using batching, defaults to 5 seconds.
|
|
863
862
|
|
|
864
863
|
#### Inherited from
|
|
865
864
|
|
|
866
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
865
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`loggingBatchFlushIntervalSeconds`](IEngineEnvironmentVariables.md#loggingbatchflushintervalseconds)
|
|
867
866
|
|
|
868
867
|
***
|
|
869
868
|
|
|
870
|
-
### eventBusConnector?
|
|
869
|
+
### eventBusConnector? {#eventbusconnector}
|
|
871
870
|
|
|
872
|
-
> `optional` **eventBusConnector
|
|
871
|
+
> `optional` **eventBusConnector?**: `string`
|
|
873
872
|
|
|
874
873
|
The type of event bus connector: local.
|
|
875
874
|
|
|
@@ -879,9 +878,9 @@ The type of event bus connector: local.
|
|
|
879
878
|
|
|
880
879
|
***
|
|
881
880
|
|
|
882
|
-
### eventBusComponent?
|
|
881
|
+
### eventBusComponent? {#eventbuscomponent}
|
|
883
882
|
|
|
884
|
-
> `optional` **eventBusComponent
|
|
883
|
+
> `optional` **eventBusComponent?**: `string`
|
|
885
884
|
|
|
886
885
|
The type of event bus component: service.
|
|
887
886
|
|
|
@@ -891,9 +890,9 @@ The type of event bus component: service.
|
|
|
891
890
|
|
|
892
891
|
***
|
|
893
892
|
|
|
894
|
-
### messagingEnabled?
|
|
893
|
+
### messagingEnabled? {#messagingenabled}
|
|
895
894
|
|
|
896
|
-
> `optional` **messagingEnabled
|
|
895
|
+
> `optional` **messagingEnabled?**: `string`
|
|
897
896
|
|
|
898
897
|
Are the messaging components enabled, defaults to false.
|
|
899
898
|
|
|
@@ -903,9 +902,9 @@ Are the messaging components enabled, defaults to false.
|
|
|
903
902
|
|
|
904
903
|
***
|
|
905
904
|
|
|
906
|
-
### awsSesRegion?
|
|
905
|
+
### awsSesRegion? {#awssesregion}
|
|
907
906
|
|
|
908
|
-
> `optional` **awsSesRegion
|
|
907
|
+
> `optional` **awsSesRegion?**: `string`
|
|
909
908
|
|
|
910
909
|
AWS SES region.
|
|
911
910
|
|
|
@@ -915,9 +914,9 @@ AWS SES region.
|
|
|
915
914
|
|
|
916
915
|
***
|
|
917
916
|
|
|
918
|
-
### awsSesAuthMode?
|
|
917
|
+
### awsSesAuthMode? {#awssesauthmode}
|
|
919
918
|
|
|
920
|
-
> `optional` **awsSesAuthMode
|
|
919
|
+
> `optional` **awsSesAuthMode?**: `string`
|
|
921
920
|
|
|
922
921
|
AWS SES auth mode, either credentials or pod, defaults to credentials.
|
|
923
922
|
|
|
@@ -927,9 +926,9 @@ AWS SES auth mode, either credentials or pod, defaults to credentials.
|
|
|
927
926
|
|
|
928
927
|
***
|
|
929
928
|
|
|
930
|
-
### awsSesSecretAccessKey?
|
|
929
|
+
### awsSesSecretAccessKey? {#awssessecretaccesskey}
|
|
931
930
|
|
|
932
|
-
> `optional` **awsSesSecretAccessKey
|
|
931
|
+
> `optional` **awsSesSecretAccessKey?**: `string`
|
|
933
932
|
|
|
934
933
|
AWS SES secret access key.
|
|
935
934
|
|
|
@@ -939,9 +938,9 @@ AWS SES secret access key.
|
|
|
939
938
|
|
|
940
939
|
***
|
|
941
940
|
|
|
942
|
-
### awsSesAccessKeyId?
|
|
941
|
+
### awsSesAccessKeyId? {#awssesaccesskeyid}
|
|
943
942
|
|
|
944
|
-
> `optional` **awsSesAccessKeyId
|
|
943
|
+
> `optional` **awsSesAccessKeyId?**: `string`
|
|
945
944
|
|
|
946
945
|
AWS SES access key id.
|
|
947
946
|
|
|
@@ -951,9 +950,9 @@ AWS SES access key id.
|
|
|
951
950
|
|
|
952
951
|
***
|
|
953
952
|
|
|
954
|
-
### awsSesEndpoint?
|
|
953
|
+
### awsSesEndpoint? {#awssesendpoint}
|
|
955
954
|
|
|
956
|
-
> `optional` **awsSesEndpoint
|
|
955
|
+
> `optional` **awsSesEndpoint?**: `string`
|
|
957
956
|
|
|
958
957
|
AWS SES endpoint.
|
|
959
958
|
|
|
@@ -963,11 +962,11 @@ AWS SES endpoint.
|
|
|
963
962
|
|
|
964
963
|
***
|
|
965
964
|
|
|
966
|
-
### awsMessagingPushNotificationApplications?
|
|
965
|
+
### awsMessagingPushNotificationApplications? {#awsmessagingpushnotificationapplications}
|
|
967
966
|
|
|
968
|
-
> `optional` **awsMessagingPushNotificationApplications
|
|
967
|
+
> `optional` **awsMessagingPushNotificationApplications?**: `string`
|
|
969
968
|
|
|
970
|
-
The applications for the push notifications
|
|
969
|
+
The applications for the push notifications reference a separate json with @json: prefix.
|
|
971
970
|
|
|
972
971
|
#### Inherited from
|
|
973
972
|
|
|
@@ -975,9 +974,9 @@ The applications for the push notifications JSON stringified array of IAwsApplic
|
|
|
975
974
|
|
|
976
975
|
***
|
|
977
976
|
|
|
978
|
-
### messagingEmailConnector?
|
|
977
|
+
### messagingEmailConnector? {#messagingemailconnector}
|
|
979
978
|
|
|
980
|
-
> `optional` **messagingEmailConnector
|
|
979
|
+
> `optional` **messagingEmailConnector?**: `string`
|
|
981
980
|
|
|
982
981
|
The type of messaging email connector: entity-storage, aws.
|
|
983
982
|
|
|
@@ -987,9 +986,9 @@ The type of messaging email connector: entity-storage, aws.
|
|
|
987
986
|
|
|
988
987
|
***
|
|
989
988
|
|
|
990
|
-
### messagingSmsConnector?
|
|
989
|
+
### messagingSmsConnector? {#messagingsmsconnector}
|
|
991
990
|
|
|
992
|
-
> `optional` **messagingSmsConnector
|
|
991
|
+
> `optional` **messagingSmsConnector?**: `string`
|
|
993
992
|
|
|
994
993
|
The type of messaging sms connector: entity-storage, aws.
|
|
995
994
|
|
|
@@ -999,9 +998,9 @@ The type of messaging sms connector: entity-storage, aws.
|
|
|
999
998
|
|
|
1000
999
|
***
|
|
1001
1000
|
|
|
1002
|
-
### messagingPushNotificationConnector?
|
|
1001
|
+
### messagingPushNotificationConnector? {#messagingpushnotificationconnector}
|
|
1003
1002
|
|
|
1004
|
-
> `optional` **messagingPushNotificationConnector
|
|
1003
|
+
> `optional` **messagingPushNotificationConnector?**: `string`
|
|
1005
1004
|
|
|
1006
1005
|
The type of messaging push notification connector: entity-storage, aws.
|
|
1007
1006
|
|
|
@@ -1011,9 +1010,9 @@ The type of messaging push notification connector: entity-storage, aws.
|
|
|
1011
1010
|
|
|
1012
1011
|
***
|
|
1013
1012
|
|
|
1014
|
-
### telemetryConnector?
|
|
1013
|
+
### telemetryConnector? {#telemetryconnector}
|
|
1015
1014
|
|
|
1016
|
-
> `optional` **telemetryConnector
|
|
1015
|
+
> `optional` **telemetryConnector?**: `string`
|
|
1017
1016
|
|
|
1018
1017
|
The type of telemetry connector: entity-storage.
|
|
1019
1018
|
|
|
@@ -1023,9 +1022,93 @@ The type of telemetry connector: entity-storage.
|
|
|
1023
1022
|
|
|
1024
1023
|
***
|
|
1025
1024
|
|
|
1026
|
-
###
|
|
1025
|
+
### openTelemetryMeterName? {#opentelemetrymetername}
|
|
1026
|
+
|
|
1027
|
+
> `optional` **openTelemetryMeterName?**: `string`
|
|
1028
|
+
|
|
1029
|
+
The name of the Open Telemetry meter to use, only required if using open-telemetry as telemetry connector, defaults to twin-node.
|
|
1027
1030
|
|
|
1028
|
-
|
|
1031
|
+
#### Inherited from
|
|
1032
|
+
|
|
1033
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`openTelemetryMeterName`](IEngineEnvironmentVariables.md#opentelemetrymetername)
|
|
1034
|
+
|
|
1035
|
+
***
|
|
1036
|
+
|
|
1037
|
+
### openTelemetryMeterVersion? {#opentelemetrymeterversion}
|
|
1038
|
+
|
|
1039
|
+
> `optional` **openTelemetryMeterVersion?**: `string`
|
|
1040
|
+
|
|
1041
|
+
The version of the Open Telemetry metrics specification to use, only required if using open-telemetry as telemetry connector, defaults to 1.0.0.
|
|
1042
|
+
|
|
1043
|
+
#### Inherited from
|
|
1044
|
+
|
|
1045
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`openTelemetryMeterVersion`](IEngineEnvironmentVariables.md#opentelemetrymeterversion)
|
|
1046
|
+
|
|
1047
|
+
***
|
|
1048
|
+
|
|
1049
|
+
### openTelemetryReader? {#opentelemetryreader}
|
|
1050
|
+
|
|
1051
|
+
> `optional` **openTelemetryReader?**: `string`
|
|
1052
|
+
|
|
1053
|
+
The type of Open Telemetry metric reader to use, only required if using open-telemetry as telemetry connector, values: prometheus.
|
|
1054
|
+
|
|
1055
|
+
#### Inherited from
|
|
1056
|
+
|
|
1057
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`openTelemetryReader`](IEngineEnvironmentVariables.md#opentelemetryreader)
|
|
1058
|
+
|
|
1059
|
+
***
|
|
1060
|
+
|
|
1061
|
+
### openTelemetryPrometheusPort? {#opentelemetryprometheusport}
|
|
1062
|
+
|
|
1063
|
+
> `optional` **openTelemetryPrometheusPort?**: `string`
|
|
1064
|
+
|
|
1065
|
+
The port to use for the Open Telemetry Prometheus metrics server, only required if using open-telemetry as telemetry connector and prometheus as reader, defaults to 9464.
|
|
1066
|
+
|
|
1067
|
+
#### Inherited from
|
|
1068
|
+
|
|
1069
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`openTelemetryPrometheusPort`](IEngineEnvironmentVariables.md#opentelemetryprometheusport)
|
|
1070
|
+
|
|
1071
|
+
***
|
|
1072
|
+
|
|
1073
|
+
### telemetryMetricsCollectorIntervalSeconds? {#telemetrymetricscollectorintervalseconds}
|
|
1074
|
+
|
|
1075
|
+
> `optional` **telemetryMetricsCollectorIntervalSeconds?**: `string`
|
|
1076
|
+
|
|
1077
|
+
Polling interval in seconds for the telemetry metrics collector. Defaults to 60.
|
|
1078
|
+
|
|
1079
|
+
#### Inherited from
|
|
1080
|
+
|
|
1081
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`telemetryMetricsCollectorIntervalSeconds`](IEngineEnvironmentVariables.md#telemetrymetricscollectorintervalseconds)
|
|
1082
|
+
|
|
1083
|
+
***
|
|
1084
|
+
|
|
1085
|
+
### telemetryMetricsProducers? {#telemetrymetricsproducers}
|
|
1086
|
+
|
|
1087
|
+
> `optional` **telemetryMetricsProducers?**: `string`
|
|
1088
|
+
|
|
1089
|
+
The type of telemetry metrics producers, can be a comma separated list: system, process.
|
|
1090
|
+
|
|
1091
|
+
#### Inherited from
|
|
1092
|
+
|
|
1093
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`telemetryMetricsProducers`](IEngineEnvironmentVariables.md#telemetrymetricsproducers)
|
|
1094
|
+
|
|
1095
|
+
***
|
|
1096
|
+
|
|
1097
|
+
### telemetryMetricsProducerMaxHistory? {#telemetrymetricsproducermaxhistory}
|
|
1098
|
+
|
|
1099
|
+
> `optional` **telemetryMetricsProducerMaxHistory?**: `string`
|
|
1100
|
+
|
|
1101
|
+
Maximum number of values retained per telemetry metric (count-based history cap). Defaults to 1440.
|
|
1102
|
+
|
|
1103
|
+
#### Inherited from
|
|
1104
|
+
|
|
1105
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`telemetryMetricsProducerMaxHistory`](IEngineEnvironmentVariables.md#telemetrymetricsproducermaxhistory)
|
|
1106
|
+
|
|
1107
|
+
***
|
|
1108
|
+
|
|
1109
|
+
### faucetConnector? {#faucetconnector}
|
|
1110
|
+
|
|
1111
|
+
> `optional` **faucetConnector?**: `string`
|
|
1029
1112
|
|
|
1030
1113
|
The type of faucet connector: entity-storage, iota.
|
|
1031
1114
|
|
|
@@ -1035,9 +1118,9 @@ The type of faucet connector: entity-storage, iota.
|
|
|
1035
1118
|
|
|
1036
1119
|
***
|
|
1037
1120
|
|
|
1038
|
-
### walletConnector?
|
|
1121
|
+
### walletConnector? {#walletconnector}
|
|
1039
1122
|
|
|
1040
|
-
> `optional` **walletConnector
|
|
1123
|
+
> `optional` **walletConnector?**: `string`
|
|
1041
1124
|
|
|
1042
1125
|
The type of wallet connector: entity-storage, iota.
|
|
1043
1126
|
|
|
@@ -1047,9 +1130,9 @@ The type of wallet connector: entity-storage, iota.
|
|
|
1047
1130
|
|
|
1048
1131
|
***
|
|
1049
1132
|
|
|
1050
|
-
### nftConnector?
|
|
1133
|
+
### nftConnector? {#nftconnector}
|
|
1051
1134
|
|
|
1052
|
-
> `optional` **nftConnector
|
|
1135
|
+
> `optional` **nftConnector?**: `string`
|
|
1053
1136
|
|
|
1054
1137
|
The type of NFT connector: entity-storage, iota.
|
|
1055
1138
|
|
|
@@ -1059,9 +1142,33 @@ The type of NFT connector: entity-storage, iota.
|
|
|
1059
1142
|
|
|
1060
1143
|
***
|
|
1061
1144
|
|
|
1062
|
-
###
|
|
1145
|
+
### nftPackageId? {#nftpackageid}
|
|
1146
|
+
|
|
1147
|
+
> `optional` **nftPackageId?**: `string`
|
|
1148
|
+
|
|
1149
|
+
The NFT deployed package id, for custom deployments.
|
|
1150
|
+
|
|
1151
|
+
#### Inherited from
|
|
1152
|
+
|
|
1153
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`nftPackageId`](IEngineEnvironmentVariables.md#nftpackageid)
|
|
1154
|
+
|
|
1155
|
+
***
|
|
1156
|
+
|
|
1157
|
+
### notarizationConnector? {#notarizationconnector}
|
|
1158
|
+
|
|
1159
|
+
> `optional` **notarizationConnector?**: `string`
|
|
1160
|
+
|
|
1161
|
+
The type of notarization connector: entity-storage, iota.
|
|
1162
|
+
|
|
1163
|
+
#### Inherited from
|
|
1164
|
+
|
|
1165
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`notarizationConnector`](IEngineEnvironmentVariables.md#notarizationconnector)
|
|
1166
|
+
|
|
1167
|
+
***
|
|
1168
|
+
|
|
1169
|
+
### identityConnector? {#identityconnector}
|
|
1063
1170
|
|
|
1064
|
-
> `optional` **identityConnector
|
|
1171
|
+
> `optional` **identityConnector?**: `string`
|
|
1065
1172
|
|
|
1066
1173
|
The type of identity connector: entity-storage, iota.
|
|
1067
1174
|
|
|
@@ -1071,33 +1178,33 @@ The type of identity connector: entity-storage, iota.
|
|
|
1071
1178
|
|
|
1072
1179
|
***
|
|
1073
1180
|
|
|
1074
|
-
###
|
|
1181
|
+
### identityWalletAddressIndex? {#identitywalletaddressindex}
|
|
1075
1182
|
|
|
1076
|
-
> `optional` **
|
|
1183
|
+
> `optional` **identityWalletAddressIndex?**: `string`
|
|
1077
1184
|
|
|
1078
|
-
The
|
|
1185
|
+
The index of the wallet address to use, defaults to 0.
|
|
1079
1186
|
|
|
1080
1187
|
#### Inherited from
|
|
1081
1188
|
|
|
1082
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1189
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`identityWalletAddressIndex`](IEngineEnvironmentVariables.md#identitywalletaddressindex)
|
|
1083
1190
|
|
|
1084
1191
|
***
|
|
1085
1192
|
|
|
1086
|
-
###
|
|
1193
|
+
### identityResolverConnector? {#identityresolverconnector}
|
|
1087
1194
|
|
|
1088
|
-
> `optional` **
|
|
1195
|
+
> `optional` **identityResolverConnector?**: `string`
|
|
1089
1196
|
|
|
1090
|
-
The type of
|
|
1197
|
+
The type of identity resolver connector: entity-storage, iota.
|
|
1091
1198
|
|
|
1092
1199
|
#### Inherited from
|
|
1093
1200
|
|
|
1094
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1201
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`identityResolverConnector`](IEngineEnvironmentVariables.md#identityresolverconnector)
|
|
1095
1202
|
|
|
1096
1203
|
***
|
|
1097
1204
|
|
|
1098
|
-
### iotaFaucetEndpoint?
|
|
1205
|
+
### iotaFaucetEndpoint? {#iotafaucetendpoint}
|
|
1099
1206
|
|
|
1100
|
-
> `optional` **iotaFaucetEndpoint
|
|
1207
|
+
> `optional` **iotaFaucetEndpoint?**: `string`
|
|
1101
1208
|
|
|
1102
1209
|
IOTA Faucet Endpoint.
|
|
1103
1210
|
|
|
@@ -1107,9 +1214,9 @@ IOTA Faucet Endpoint.
|
|
|
1107
1214
|
|
|
1108
1215
|
***
|
|
1109
1216
|
|
|
1110
|
-
### iotaNodeEndpoint?
|
|
1217
|
+
### iotaNodeEndpoint? {#iotanodeendpoint}
|
|
1111
1218
|
|
|
1112
|
-
> `optional` **iotaNodeEndpoint
|
|
1219
|
+
> `optional` **iotaNodeEndpoint?**: `string`
|
|
1113
1220
|
|
|
1114
1221
|
IOTA Node Endpoint.
|
|
1115
1222
|
|
|
@@ -1119,9 +1226,9 @@ IOTA Node Endpoint.
|
|
|
1119
1226
|
|
|
1120
1227
|
***
|
|
1121
1228
|
|
|
1122
|
-
### iotaNetwork?
|
|
1229
|
+
### iotaNetwork? {#iotanetwork}
|
|
1123
1230
|
|
|
1124
|
-
> `optional` **iotaNetwork
|
|
1231
|
+
> `optional` **iotaNetwork?**: `string`
|
|
1125
1232
|
|
|
1126
1233
|
IOTA network.
|
|
1127
1234
|
|
|
@@ -1131,9 +1238,9 @@ IOTA network.
|
|
|
1131
1238
|
|
|
1132
1239
|
***
|
|
1133
1240
|
|
|
1134
|
-
### iotaCoinType?
|
|
1241
|
+
### iotaCoinType? {#iotacointype}
|
|
1135
1242
|
|
|
1136
|
-
> `optional` **iotaCoinType
|
|
1243
|
+
> `optional` **iotaCoinType?**: `string`
|
|
1137
1244
|
|
|
1138
1245
|
IOTA coin type.
|
|
1139
1246
|
|
|
@@ -1143,9 +1250,9 @@ IOTA coin type.
|
|
|
1143
1250
|
|
|
1144
1251
|
***
|
|
1145
1252
|
|
|
1146
|
-
### iotaExplorerEndpoint?
|
|
1253
|
+
### iotaExplorerEndpoint? {#iotaexplorerendpoint}
|
|
1147
1254
|
|
|
1148
|
-
> `optional` **iotaExplorerEndpoint
|
|
1255
|
+
> `optional` **iotaExplorerEndpoint?**: `string`
|
|
1149
1256
|
|
|
1150
1257
|
IOTA Explorer Endpoint.
|
|
1151
1258
|
|
|
@@ -1155,9 +1262,9 @@ IOTA Explorer Endpoint.
|
|
|
1155
1262
|
|
|
1156
1263
|
***
|
|
1157
1264
|
|
|
1158
|
-
### iotaGasStationEndpoint?
|
|
1265
|
+
### iotaGasStationEndpoint? {#iotagasstationendpoint}
|
|
1159
1266
|
|
|
1160
|
-
> `optional` **iotaGasStationEndpoint
|
|
1267
|
+
> `optional` **iotaGasStationEndpoint?**: `string`
|
|
1161
1268
|
|
|
1162
1269
|
IOTA Gas Station Endpoint.
|
|
1163
1270
|
|
|
@@ -1167,9 +1274,9 @@ IOTA Gas Station Endpoint.
|
|
|
1167
1274
|
|
|
1168
1275
|
***
|
|
1169
1276
|
|
|
1170
|
-
### iotaGasStationAuthToken?
|
|
1277
|
+
### iotaGasStationAuthToken? {#iotagasstationauthtoken}
|
|
1171
1278
|
|
|
1172
|
-
> `optional` **iotaGasStationAuthToken
|
|
1279
|
+
> `optional` **iotaGasStationAuthToken?**: `string`
|
|
1173
1280
|
|
|
1174
1281
|
IOTA Gas Station Authentication Token.
|
|
1175
1282
|
|
|
@@ -1179,9 +1286,21 @@ IOTA Gas Station Authentication Token.
|
|
|
1179
1286
|
|
|
1180
1287
|
***
|
|
1181
1288
|
|
|
1182
|
-
###
|
|
1289
|
+
### iotaIdentityPackageId? {#iotaidentitypackageid}
|
|
1290
|
+
|
|
1291
|
+
> `optional` **iotaIdentityPackageId?**: `string`
|
|
1292
|
+
|
|
1293
|
+
The IOTA Identity deployed package id, for custom deployments.
|
|
1294
|
+
|
|
1295
|
+
#### Inherited from
|
|
1296
|
+
|
|
1297
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaIdentityPackageId`](IEngineEnvironmentVariables.md#iotaidentitypackageid)
|
|
1298
|
+
|
|
1299
|
+
***
|
|
1300
|
+
|
|
1301
|
+
### universalResolverEndpoint? {#universalresolverendpoint}
|
|
1183
1302
|
|
|
1184
|
-
> `optional` **universalResolverEndpoint
|
|
1303
|
+
> `optional` **universalResolverEndpoint?**: `string`
|
|
1185
1304
|
|
|
1186
1305
|
Universal Resolver Endpoint.
|
|
1187
1306
|
|
|
@@ -1191,9 +1310,9 @@ Universal Resolver Endpoint.
|
|
|
1191
1310
|
|
|
1192
1311
|
***
|
|
1193
1312
|
|
|
1194
|
-
### identityProfileConnector?
|
|
1313
|
+
### identityProfileConnector? {#identityprofileconnector}
|
|
1195
1314
|
|
|
1196
|
-
> `optional` **identityProfileConnector
|
|
1315
|
+
> `optional` **identityProfileConnector?**: `string`
|
|
1197
1316
|
|
|
1198
1317
|
The type of identity profile connector: entity-storage.
|
|
1199
1318
|
|
|
@@ -1203,9 +1322,9 @@ The type of identity profile connector: entity-storage.
|
|
|
1203
1322
|
|
|
1204
1323
|
***
|
|
1205
1324
|
|
|
1206
|
-
### immutableProofVerificationMethodId?
|
|
1325
|
+
### immutableProofVerificationMethodId? {#immutableproofverificationmethodid}
|
|
1207
1326
|
|
|
1208
|
-
> `optional` **immutableProofVerificationMethodId
|
|
1327
|
+
> `optional` **immutableProofVerificationMethodId?**: `string`
|
|
1209
1328
|
|
|
1210
1329
|
The identity verification method id to use with immutable proofs.
|
|
1211
1330
|
|
|
@@ -1215,9 +1334,9 @@ The identity verification method id to use with immutable proofs.
|
|
|
1215
1334
|
|
|
1216
1335
|
***
|
|
1217
1336
|
|
|
1218
|
-
### attestationConnector?
|
|
1337
|
+
### attestationConnector? {#attestationconnector}
|
|
1219
1338
|
|
|
1220
|
-
> `optional` **attestationConnector
|
|
1339
|
+
> `optional` **attestationConnector?**: `string`
|
|
1221
1340
|
|
|
1222
1341
|
The type of attestation connector: entity-storage, iota.
|
|
1223
1342
|
|
|
@@ -1227,9 +1346,9 @@ The type of attestation connector: entity-storage, iota.
|
|
|
1227
1346
|
|
|
1228
1347
|
***
|
|
1229
1348
|
|
|
1230
|
-
### attestationVerificationMethodId?
|
|
1349
|
+
### attestationVerificationMethodId? {#attestationverificationmethodid}
|
|
1231
1350
|
|
|
1232
|
-
> `optional` **attestationVerificationMethodId
|
|
1351
|
+
> `optional` **attestationVerificationMethodId?**: `string`
|
|
1233
1352
|
|
|
1234
1353
|
The identity verification method id to use with attestation.
|
|
1235
1354
|
|
|
@@ -1239,9 +1358,9 @@ The identity verification method id to use with attestation.
|
|
|
1239
1358
|
|
|
1240
1359
|
***
|
|
1241
1360
|
|
|
1242
|
-
### dataProcessingEnabled?
|
|
1361
|
+
### dataProcessingEnabled? {#dataprocessingenabled}
|
|
1243
1362
|
|
|
1244
|
-
> `optional` **dataProcessingEnabled
|
|
1363
|
+
> `optional` **dataProcessingEnabled?**: `string`
|
|
1245
1364
|
|
|
1246
1365
|
Is the data processing enabled, defaults to false.
|
|
1247
1366
|
|
|
@@ -1251,9 +1370,9 @@ Is the data processing enabled, defaults to false.
|
|
|
1251
1370
|
|
|
1252
1371
|
***
|
|
1253
1372
|
|
|
1254
|
-
### dataConverterConnectors?
|
|
1373
|
+
### dataConverterConnectors? {#dataconverterconnectors}
|
|
1255
1374
|
|
|
1256
|
-
> `optional` **dataConverterConnectors
|
|
1375
|
+
> `optional` **dataConverterConnectors?**: `string`
|
|
1257
1376
|
|
|
1258
1377
|
The type of the default data converters, can be a comma separated list: json, xml.
|
|
1259
1378
|
|
|
@@ -1263,9 +1382,9 @@ The type of the default data converters, can be a comma separated list: json, xm
|
|
|
1263
1382
|
|
|
1264
1383
|
***
|
|
1265
1384
|
|
|
1266
|
-
### dataExtractorConnectors?
|
|
1385
|
+
### dataExtractorConnectors? {#dataextractorconnectors}
|
|
1267
1386
|
|
|
1268
|
-
> `optional` **dataExtractorConnectors
|
|
1387
|
+
> `optional` **dataExtractorConnectors?**: `string`
|
|
1269
1388
|
|
|
1270
1389
|
The type of the default data extractor, can be a comma separated list: json-path.
|
|
1271
1390
|
|
|
@@ -1275,9 +1394,9 @@ The type of the default data extractor, can be a comma separated list: json-path
|
|
|
1275
1394
|
|
|
1276
1395
|
***
|
|
1277
1396
|
|
|
1278
|
-
### auditableItemGraphEnabled?
|
|
1397
|
+
### auditableItemGraphEnabled? {#auditableitemgraphenabled}
|
|
1279
1398
|
|
|
1280
|
-
> `optional` **auditableItemGraphEnabled
|
|
1399
|
+
> `optional` **auditableItemGraphEnabled?**: `string`
|
|
1281
1400
|
|
|
1282
1401
|
Is the auditable item graph enabled, defaults to false.
|
|
1283
1402
|
|
|
@@ -1287,9 +1406,9 @@ Is the auditable item graph enabled, defaults to false.
|
|
|
1287
1406
|
|
|
1288
1407
|
***
|
|
1289
1408
|
|
|
1290
|
-
### auditableItemStreamEnabled?
|
|
1409
|
+
### auditableItemStreamEnabled? {#auditableitemstreamenabled}
|
|
1291
1410
|
|
|
1292
|
-
> `optional` **auditableItemStreamEnabled
|
|
1411
|
+
> `optional` **auditableItemStreamEnabled?**: `string`
|
|
1293
1412
|
|
|
1294
1413
|
Is the auditable item stream enabled, defaults to false.
|
|
1295
1414
|
|
|
@@ -1299,9 +1418,9 @@ Is the auditable item stream enabled, defaults to false.
|
|
|
1299
1418
|
|
|
1300
1419
|
***
|
|
1301
1420
|
|
|
1302
|
-
### documentManagementEnabled?
|
|
1421
|
+
### documentManagementEnabled? {#documentmanagementenabled}
|
|
1303
1422
|
|
|
1304
|
-
> `optional` **documentManagementEnabled
|
|
1423
|
+
> `optional` **documentManagementEnabled?**: `string`
|
|
1305
1424
|
|
|
1306
1425
|
Is the document management enabled, defaults to false.
|
|
1307
1426
|
|
|
@@ -1311,381 +1430,347 @@ Is the document management enabled, defaults to false.
|
|
|
1311
1430
|
|
|
1312
1431
|
***
|
|
1313
1432
|
|
|
1314
|
-
###
|
|
1433
|
+
### federatedCatalogueEnabled? {#federatedcatalogueenabled}
|
|
1315
1434
|
|
|
1316
|
-
> `optional` **
|
|
1435
|
+
> `optional` **federatedCatalogueEnabled?**: `string`
|
|
1317
1436
|
|
|
1318
|
-
|
|
1437
|
+
Enable the federated catalogue, defaults to false, automatically enabled if remote endpoint, filters or dataspace is enabled.
|
|
1319
1438
|
|
|
1320
1439
|
#### Inherited from
|
|
1321
1440
|
|
|
1322
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1441
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueEnabled`](IEngineEnvironmentVariables.md#federatedcatalogueenabled)
|
|
1323
1442
|
|
|
1324
1443
|
***
|
|
1325
1444
|
|
|
1326
|
-
###
|
|
1445
|
+
### federatedCatalogueFilters? {#federatedcataloguefilters}
|
|
1327
1446
|
|
|
1328
|
-
> `optional` **
|
|
1447
|
+
> `optional` **federatedCatalogueFilters?**: `string`
|
|
1329
1448
|
|
|
1330
|
-
|
|
1449
|
+
Federated catalog filters, command separated list of filters to add.
|
|
1331
1450
|
|
|
1332
1451
|
#### Inherited from
|
|
1333
1452
|
|
|
1334
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1453
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueFilters`](IEngineEnvironmentVariables.md#federatedcataloguefilters)
|
|
1335
1454
|
|
|
1336
1455
|
***
|
|
1337
1456
|
|
|
1338
|
-
###
|
|
1457
|
+
### federatedCatalogueRemoteEndpoint? {#federatedcatalogueremoteendpoint}
|
|
1339
1458
|
|
|
1340
|
-
> `optional` **
|
|
1459
|
+
> `optional` **federatedCatalogueRemoteEndpoint?**: `string`
|
|
1341
1460
|
|
|
1342
|
-
|
|
1343
|
-
This only required if using a custom verifiable storage item, otherwise it will default to the network name.
|
|
1461
|
+
Federated catalog remote endpoint, if set will use a REST client instead of local service.
|
|
1344
1462
|
|
|
1345
1463
|
#### Inherited from
|
|
1346
1464
|
|
|
1347
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1465
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueRemoteEndpoint`](IEngineEnvironmentVariables.md#federatedcatalogueremoteendpoint)
|
|
1348
1466
|
|
|
1349
1467
|
***
|
|
1350
1468
|
|
|
1351
|
-
###
|
|
1469
|
+
### trustGenerators? {#trustgenerators}
|
|
1352
1470
|
|
|
1353
|
-
> `optional` **
|
|
1471
|
+
> `optional` **trustGenerators?**: `string`
|
|
1354
1472
|
|
|
1355
|
-
The
|
|
1356
|
-
Only required for trusted nodes, as regular nodes will request from the trusted nodes.
|
|
1357
|
-
Defaults to synchronised-storage-blob-encryption
|
|
1473
|
+
The trust generators to add to the factory, comma separated list.
|
|
1358
1474
|
|
|
1359
1475
|
#### Inherited from
|
|
1360
1476
|
|
|
1361
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1477
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustGenerators`](IEngineEnvironmentVariables.md#trustgenerators)
|
|
1362
1478
|
|
|
1363
1479
|
***
|
|
1364
1480
|
|
|
1365
|
-
###
|
|
1481
|
+
### trustVerifiers? {#trustverifiers}
|
|
1366
1482
|
|
|
1367
|
-
> `optional` **
|
|
1483
|
+
> `optional` **trustVerifiers?**: `string`
|
|
1368
1484
|
|
|
1369
|
-
The
|
|
1370
|
-
Only required for trusted nodes, as regular nodes will not write encrypted data.
|
|
1485
|
+
The trust verifiers to add to the factory, comma separated list.
|
|
1371
1486
|
|
|
1372
1487
|
#### Inherited from
|
|
1373
1488
|
|
|
1374
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1489
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustVerifiers`](IEngineEnvironmentVariables.md#trustverifiers)
|
|
1375
1490
|
|
|
1376
1491
|
***
|
|
1377
1492
|
|
|
1378
|
-
###
|
|
1379
|
-
|
|
1380
|
-
> `optional` **synchronisedStorageEntityUpdateIntervalMinutes**: `string`
|
|
1493
|
+
### trustVerificationMethodId? {#trustverificationmethodid}
|
|
1381
1494
|
|
|
1382
|
-
|
|
1495
|
+
> `optional` **trustVerificationMethodId?**: `string`
|
|
1383
1496
|
|
|
1384
|
-
|
|
1385
|
-
|
|
1386
|
-
```ts
|
|
1387
|
-
5
|
|
1388
|
-
```
|
|
1497
|
+
The verification method to use for trust identities.
|
|
1498
|
+
Defaults to trust-assertion.
|
|
1389
1499
|
|
|
1390
1500
|
#### Inherited from
|
|
1391
1501
|
|
|
1392
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1502
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustVerificationMethodId`](IEngineEnvironmentVariables.md#trustverificationmethodid)
|
|
1393
1503
|
|
|
1394
1504
|
***
|
|
1395
1505
|
|
|
1396
|
-
###
|
|
1397
|
-
|
|
1398
|
-
> `optional` **synchronisedStorageConsolidationIntervalMinutes**: `string`
|
|
1399
|
-
|
|
1400
|
-
Interval to perform consolidation of changesets, only used if this is a trusted node.
|
|
1506
|
+
### trustJwtTtlSeconds? {#trustjwtttlseconds}
|
|
1401
1507
|
|
|
1402
|
-
|
|
1508
|
+
> `optional` **trustJwtTtlSeconds?**: `string`
|
|
1403
1509
|
|
|
1404
|
-
|
|
1405
|
-
|
|
1406
|
-
```
|
|
1510
|
+
The trust time to live for generating JWTs.
|
|
1511
|
+
Defaults to undefined for never expiring.
|
|
1407
1512
|
|
|
1408
1513
|
#### Inherited from
|
|
1409
1514
|
|
|
1410
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1515
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustJwtTtlSeconds`](IEngineEnvironmentVariables.md#trustjwtttlseconds)
|
|
1411
1516
|
|
|
1412
1517
|
***
|
|
1413
1518
|
|
|
1414
|
-
###
|
|
1415
|
-
|
|
1416
|
-
> `optional` **synchronisedStorageConsolidationBatchSize**: `string`
|
|
1417
|
-
|
|
1418
|
-
The number of entities to process in a single consolidation batch, only used if this is a trusted node.
|
|
1519
|
+
### trustIdentitiesAllow? {#trustidentitiesallow}
|
|
1419
1520
|
|
|
1420
|
-
|
|
1521
|
+
> `optional` **trustIdentitiesAllow?**: `string`
|
|
1421
1522
|
|
|
1422
|
-
|
|
1423
|
-
1000
|
|
1424
|
-
```
|
|
1523
|
+
The allow lists for the trust identity verifier, comma separated list of identities.
|
|
1425
1524
|
|
|
1426
1525
|
#### Inherited from
|
|
1427
1526
|
|
|
1428
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1527
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustIdentitiesAllow`](IEngineEnvironmentVariables.md#trustidentitiesallow)
|
|
1429
1528
|
|
|
1430
1529
|
***
|
|
1431
1530
|
|
|
1432
|
-
###
|
|
1531
|
+
### trustIdentitiesDeny? {#trustidentitiesdeny}
|
|
1433
1532
|
|
|
1434
|
-
> `optional` **
|
|
1533
|
+
> `optional` **trustIdentitiesDeny?**: `string`
|
|
1435
1534
|
|
|
1436
|
-
The
|
|
1437
|
-
|
|
1438
|
-
#### Default
|
|
1439
|
-
|
|
1440
|
-
```ts
|
|
1441
|
-
5
|
|
1442
|
-
```
|
|
1535
|
+
The deny lists for the trust identity verifier, comma separated list of identities.
|
|
1443
1536
|
|
|
1444
1537
|
#### Inherited from
|
|
1445
1538
|
|
|
1446
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1539
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustIdentitiesDeny`](IEngineEnvironmentVariables.md#trustidentitiesdeny)
|
|
1447
1540
|
|
|
1448
1541
|
***
|
|
1449
1542
|
|
|
1450
|
-
###
|
|
1543
|
+
### rightsManagementCallbackPath? {#rightsmanagementcallbackpath}
|
|
1451
1544
|
|
|
1452
|
-
> `optional` **
|
|
1545
|
+
> `optional` **rightsManagementCallbackPath?**: `string`
|
|
1453
1546
|
|
|
1454
|
-
|
|
1547
|
+
Path under which the rights management service is mounted (single source
|
|
1548
|
+
of truth). The same value drives:
|
|
1549
|
+
- the server route mount (via engine config)
|
|
1550
|
+
- the PNP service's callback URL builder (`buildCallbackUrl`)
|
|
1551
|
+
- the PNP rest-client's pathPrefix (consumer side)
|
|
1552
|
+
Defaults to `rights-management`. Set when deploying behind a reverse proxy
|
|
1553
|
+
with path rewriting, K8s ingress with path-based routing, or any custom
|
|
1554
|
+
mount point.
|
|
1455
1555
|
|
|
1456
1556
|
#### Inherited from
|
|
1457
1557
|
|
|
1458
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1558
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementCallbackPath`](IEngineEnvironmentVariables.md#rightsmanagementcallbackpath)
|
|
1459
1559
|
|
|
1460
1560
|
***
|
|
1461
1561
|
|
|
1462
|
-
###
|
|
1562
|
+
### rightsManagementPolicyInformationSources? {#rightsmanagementpolicyinformationsources}
|
|
1463
1563
|
|
|
1464
|
-
> `optional` **
|
|
1564
|
+
> `optional` **rightsManagementPolicyInformationSources?**: `string`
|
|
1465
1565
|
|
|
1466
|
-
|
|
1566
|
+
The rights management policy information sources to add to the factory.
|
|
1467
1567
|
|
|
1468
1568
|
#### Inherited from
|
|
1469
1569
|
|
|
1470
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1570
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyInformationSources`](IEngineEnvironmentVariables.md#rightsmanagementpolicyinformationsources)
|
|
1471
1571
|
|
|
1472
1572
|
***
|
|
1473
1573
|
|
|
1474
|
-
###
|
|
1574
|
+
### rightsManagementPolicyNegotiators? {#rightsmanagementpolicynegotiators}
|
|
1475
1575
|
|
|
1476
|
-
> `optional` **
|
|
1576
|
+
> `optional` **rightsManagementPolicyNegotiators?**: `string`
|
|
1477
1577
|
|
|
1478
|
-
|
|
1578
|
+
The rights management policy negotiators sources to add to the factory.
|
|
1479
1579
|
|
|
1480
1580
|
#### Inherited from
|
|
1481
1581
|
|
|
1482
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1582
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyNegotiators`](IEngineEnvironmentVariables.md#rightsmanagementpolicynegotiators)
|
|
1483
1583
|
|
|
1484
1584
|
***
|
|
1485
1585
|
|
|
1486
|
-
###
|
|
1586
|
+
### rightsManagementPolicyRequesters? {#rightsmanagementpolicyrequesters}
|
|
1487
1587
|
|
|
1488
|
-
> `optional` **
|
|
1588
|
+
> `optional` **rightsManagementPolicyRequesters?**: `string`
|
|
1489
1589
|
|
|
1490
|
-
|
|
1590
|
+
The rights management policy requesters to add to the factory.
|
|
1491
1591
|
|
|
1492
1592
|
#### Inherited from
|
|
1493
1593
|
|
|
1494
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1594
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyRequesters`](IEngineEnvironmentVariables.md#rightsmanagementpolicyrequesters)
|
|
1495
1595
|
|
|
1496
1596
|
***
|
|
1497
1597
|
|
|
1498
|
-
###
|
|
1598
|
+
### rightsManagementPolicyExecutionActions? {#rightsmanagementpolicyexecutionactions}
|
|
1499
1599
|
|
|
1500
|
-
> `optional` **
|
|
1600
|
+
> `optional` **rightsManagementPolicyExecutionActions?**: `string`
|
|
1501
1601
|
|
|
1502
|
-
|
|
1602
|
+
The rights management policy execution actions to add to the factory.
|
|
1503
1603
|
|
|
1504
1604
|
#### Inherited from
|
|
1505
1605
|
|
|
1506
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1606
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyExecutionActions`](IEngineEnvironmentVariables.md#rightsmanagementpolicyexecutionactions)
|
|
1507
1607
|
|
|
1508
1608
|
***
|
|
1509
1609
|
|
|
1510
|
-
###
|
|
1610
|
+
### rightsManagementPolicyEnforcementProcessors? {#rightsmanagementpolicyenforcementprocessors}
|
|
1511
1611
|
|
|
1512
|
-
> `optional` **
|
|
1612
|
+
> `optional` **rightsManagementPolicyEnforcementProcessors?**: `string`
|
|
1513
1613
|
|
|
1514
|
-
The rights management
|
|
1515
|
-
Use the @json: prefix to specify the path to the JSON configuration file.
|
|
1614
|
+
The rights management policy enforcement processors to add to the factory.
|
|
1516
1615
|
|
|
1517
1616
|
#### Inherited from
|
|
1518
1617
|
|
|
1519
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1618
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyEnforcementProcessors`](IEngineEnvironmentVariables.md#rightsmanagementpolicyenforcementprocessors)
|
|
1520
1619
|
|
|
1521
1620
|
***
|
|
1522
1621
|
|
|
1523
|
-
###
|
|
1622
|
+
### rightsManagementPolicyArbiters? {#rightsmanagementpolicyarbiters}
|
|
1524
1623
|
|
|
1525
|
-
> `optional` **
|
|
1624
|
+
> `optional` **rightsManagementPolicyArbiters?**: `string`
|
|
1526
1625
|
|
|
1527
|
-
The rights management
|
|
1528
|
-
Use the @json: prefix to specify the path to the JSON configuration file.
|
|
1626
|
+
The rights management policy arbiters to add to the factory.
|
|
1529
1627
|
|
|
1530
1628
|
#### Inherited from
|
|
1531
1629
|
|
|
1532
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1630
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyArbiters`](IEngineEnvironmentVariables.md#rightsmanagementpolicyarbiters)
|
|
1533
1631
|
|
|
1534
1632
|
***
|
|
1535
1633
|
|
|
1536
|
-
###
|
|
1634
|
+
### rightsManagementPolicyObligationEnforcers? {#rightsmanagementpolicyobligationenforcers}
|
|
1537
1635
|
|
|
1538
|
-
> `optional` **
|
|
1636
|
+
> `optional` **rightsManagementPolicyObligationEnforcers?**: `string`
|
|
1539
1637
|
|
|
1540
|
-
The rights management
|
|
1541
|
-
Use the @json: prefix to specify the path to the JSON configuration file.
|
|
1638
|
+
The rights management policy obligation enforcers to add to the factory.
|
|
1542
1639
|
|
|
1543
1640
|
#### Inherited from
|
|
1544
1641
|
|
|
1545
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1642
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyObligationEnforcers`](IEngineEnvironmentVariables.md#rightsmanagementpolicyobligationenforcers)
|
|
1546
1643
|
|
|
1547
1644
|
***
|
|
1548
1645
|
|
|
1549
|
-
###
|
|
1646
|
+
### dataspaceEnabled? {#dataspaceenabled}
|
|
1550
1647
|
|
|
1551
|
-
> `optional` **
|
|
1648
|
+
> `optional` **dataspaceEnabled?**: `string`
|
|
1552
1649
|
|
|
1553
|
-
|
|
1554
|
-
Use the @json: prefix to specify the path to the JSON configuration file.
|
|
1650
|
+
Is the dataspace enabled, defaults to false.
|
|
1555
1651
|
|
|
1556
1652
|
#### Inherited from
|
|
1557
1653
|
|
|
1558
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1654
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataspaceEnabled`](IEngineEnvironmentVariables.md#dataspaceenabled)
|
|
1559
1655
|
|
|
1560
1656
|
***
|
|
1561
1657
|
|
|
1562
|
-
###
|
|
1658
|
+
### dataspaceRetainActivityLogsFor? {#dataspaceretainactivitylogsfor}
|
|
1563
1659
|
|
|
1564
|
-
> `optional` **
|
|
1565
|
-
|
|
1566
|
-
The rights management configuration which includes the enforcement processor modules to load.
|
|
1567
|
-
Use the @json: prefix to specify the path to the JSON configuration file.
|
|
1568
|
-
|
|
1569
|
-
#### Inherited from
|
|
1570
|
-
|
|
1571
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementEnforcementProcessors`](IEngineEnvironmentVariables.md#rightsmanagementenforcementprocessors)
|
|
1572
|
-
|
|
1573
|
-
***
|
|
1660
|
+
> `optional` **dataspaceRetainActivityLogsFor?**: `string`
|
|
1574
1661
|
|
|
1575
|
-
|
|
1662
|
+
The length of time to retain the activity logs for in minutes, set to -1 to keep forever.
|
|
1576
1663
|
|
|
1577
|
-
|
|
1664
|
+
#### Default
|
|
1578
1665
|
|
|
1579
|
-
|
|
1580
|
-
|
|
1666
|
+
```ts
|
|
1667
|
+
10
|
|
1668
|
+
```
|
|
1581
1669
|
|
|
1582
1670
|
#### Inherited from
|
|
1583
1671
|
|
|
1584
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1672
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataspaceRetainActivityLogsFor`](IEngineEnvironmentVariables.md#dataspaceretainactivitylogsfor)
|
|
1585
1673
|
|
|
1586
1674
|
***
|
|
1587
1675
|
|
|
1588
|
-
###
|
|
1676
|
+
### dataspaceActivityLogsCleanupInterval? {#dataspaceactivitylogscleanupinterval}
|
|
1677
|
+
|
|
1678
|
+
> `optional` **dataspaceActivityLogsCleanupInterval?**: `string`
|
|
1589
1679
|
|
|
1590
|
-
|
|
1680
|
+
The interval for cleaning up the activity logs.
|
|
1681
|
+
|
|
1682
|
+
#### Default
|
|
1591
1683
|
|
|
1592
|
-
|
|
1593
|
-
|
|
1684
|
+
```ts
|
|
1685
|
+
60
|
|
1686
|
+
```
|
|
1594
1687
|
|
|
1595
1688
|
#### Inherited from
|
|
1596
1689
|
|
|
1597
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1690
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataspaceActivityLogsCleanupInterval`](IEngineEnvironmentVariables.md#dataspaceactivitylogscleanupinterval)
|
|
1598
1691
|
|
|
1599
1692
|
***
|
|
1600
1693
|
|
|
1601
|
-
###
|
|
1694
|
+
### dataspaceDataPlanePath? {#dataspacedataplanepath}
|
|
1602
1695
|
|
|
1603
|
-
> `optional` **
|
|
1696
|
+
> `optional` **dataspaceDataPlanePath?**: `string`
|
|
1604
1697
|
|
|
1605
|
-
|
|
1698
|
+
The data plane path for PULL transfers (path only, not full URL).
|
|
1699
|
+
Will be combined with public origin from hosting component.
|
|
1700
|
+
Required if PULL transfers should be supported.
|
|
1701
|
+
Example: "dataspace/entities"
|
|
1606
1702
|
|
|
1607
1703
|
#### Inherited from
|
|
1608
1704
|
|
|
1609
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1705
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataspaceDataPlanePath`](IEngineEnvironmentVariables.md#dataspacedataplanepath)
|
|
1610
1706
|
|
|
1611
1707
|
***
|
|
1612
1708
|
|
|
1613
|
-
###
|
|
1709
|
+
### healthEnabled? {#healthenabled}
|
|
1614
1710
|
|
|
1615
|
-
> `optional` **
|
|
1711
|
+
> `optional` **healthEnabled?**: `string`
|
|
1616
1712
|
|
|
1617
|
-
|
|
1713
|
+
Are the health components enabled, defaults to false.
|
|
1618
1714
|
|
|
1619
1715
|
#### Inherited from
|
|
1620
1716
|
|
|
1621
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1717
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`healthEnabled`](IEngineEnvironmentVariables.md#healthenabled)
|
|
1622
1718
|
|
|
1623
1719
|
***
|
|
1624
1720
|
|
|
1625
|
-
###
|
|
1721
|
+
### healthIntervalSeconds? {#healthintervalseconds}
|
|
1626
1722
|
|
|
1627
|
-
> `optional` **
|
|
1723
|
+
> `optional` **healthIntervalSeconds?**: `string`
|
|
1628
1724
|
|
|
1629
|
-
The
|
|
1630
|
-
|
|
1631
|
-
#### Default
|
|
1632
|
-
|
|
1633
|
-
```ts
|
|
1634
|
-
10
|
|
1635
|
-
```
|
|
1725
|
+
The interval in seconds for performing health checks, defaults to 60.
|
|
1636
1726
|
|
|
1637
1727
|
#### Inherited from
|
|
1638
1728
|
|
|
1639
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1729
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`healthIntervalSeconds`](IEngineEnvironmentVariables.md#healthintervalseconds)
|
|
1640
1730
|
|
|
1641
1731
|
***
|
|
1642
1732
|
|
|
1643
|
-
###
|
|
1644
|
-
|
|
1645
|
-
> `optional` **dataSpaceConnectorActivityLogsCleanUpInterval**: `string`
|
|
1646
|
-
|
|
1647
|
-
The interval for cleaning up the activity logs.
|
|
1733
|
+
### healthStartupIntervalSeconds? {#healthstartupintervalseconds}
|
|
1648
1734
|
|
|
1649
|
-
|
|
1735
|
+
> `optional` **healthStartupIntervalSeconds?**: `string`
|
|
1650
1736
|
|
|
1651
|
-
|
|
1652
|
-
|
|
1653
|
-
```
|
|
1737
|
+
The interval in seconds for performing health checks at startup, defaults to 2.
|
|
1738
|
+
This allows components that take a long time to initialize to be healthy before the first health check is performed.
|
|
1654
1739
|
|
|
1655
1740
|
#### Inherited from
|
|
1656
1741
|
|
|
1657
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1742
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`healthStartupIntervalSeconds`](IEngineEnvironmentVariables.md#healthstartupintervalseconds)
|
|
1658
1743
|
|
|
1659
1744
|
***
|
|
1660
1745
|
|
|
1661
|
-
###
|
|
1746
|
+
### urlTransformerEncryptionKeyId? {#urltransformerencryptionkeyid}
|
|
1662
1747
|
|
|
1663
|
-
> `optional` **
|
|
1748
|
+
> `optional` **urlTransformerEncryptionKeyId?**: `string`
|
|
1664
1749
|
|
|
1665
|
-
|
|
1750
|
+
The id of the key in the vault to use for encrypting parameters in url transformer.
|
|
1666
1751
|
|
|
1667
1752
|
#### Inherited from
|
|
1668
1753
|
|
|
1669
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1754
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`urlTransformerEncryptionKeyId`](IEngineEnvironmentVariables.md#urltransformerencryptionkeyid)
|
|
1670
1755
|
|
|
1671
1756
|
***
|
|
1672
1757
|
|
|
1673
|
-
###
|
|
1758
|
+
### automationActionTypes? {#automationactiontypes}
|
|
1674
1759
|
|
|
1675
|
-
> `optional` **
|
|
1760
|
+
> `optional` **automationActionTypes?**: `string`
|
|
1676
1761
|
|
|
1677
|
-
|
|
1678
|
-
|
|
1762
|
+
The type of the automation action to create, comma separate for more than one connector.
|
|
1763
|
+
values: fetch
|
|
1679
1764
|
|
|
1680
1765
|
#### Inherited from
|
|
1681
1766
|
|
|
1682
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1767
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`automationActionTypes`](IEngineEnvironmentVariables.md#automationactiontypes)
|
|
1683
1768
|
|
|
1684
1769
|
***
|
|
1685
1770
|
|
|
1686
|
-
### extensions?
|
|
1771
|
+
### extensions? {#extensions}
|
|
1687
1772
|
|
|
1688
|
-
> `optional` **extensions
|
|
1773
|
+
> `optional` **extensions?**: `string`
|
|
1689
1774
|
|
|
1690
1775
|
A comma separated list of additional node extensions to load, the initialiseExtension method will be called for each extension.
|
|
1691
1776
|
|
|
@@ -1695,104 +1780,120 @@ A comma separated list of additional node extensions to load, the initialiseExte
|
|
|
1695
1780
|
|
|
1696
1781
|
***
|
|
1697
1782
|
|
|
1698
|
-
### port?
|
|
1783
|
+
### port? {#port}
|
|
1699
1784
|
|
|
1700
|
-
> `optional` **port
|
|
1785
|
+
> `optional` **port?**: `string`
|
|
1701
1786
|
|
|
1702
1787
|
The port to serve the API from.
|
|
1703
1788
|
|
|
1704
1789
|
***
|
|
1705
1790
|
|
|
1706
|
-
### host?
|
|
1791
|
+
### host? {#host}
|
|
1707
1792
|
|
|
1708
|
-
> `optional` **host
|
|
1793
|
+
> `optional` **host?**: `string`
|
|
1709
1794
|
|
|
1710
1795
|
The host to serve the API from.
|
|
1711
1796
|
|
|
1712
1797
|
***
|
|
1713
1798
|
|
|
1714
|
-
### corsOrigins?
|
|
1799
|
+
### corsOrigins? {#corsorigins}
|
|
1715
1800
|
|
|
1716
|
-
> `optional` **corsOrigins
|
|
1801
|
+
> `optional` **corsOrigins?**: `string`
|
|
1717
1802
|
|
|
1718
1803
|
The CORS origins to allow, defaults to *.
|
|
1719
1804
|
|
|
1720
1805
|
***
|
|
1721
1806
|
|
|
1722
|
-
### httpMethods?
|
|
1807
|
+
### httpMethods? {#httpmethods}
|
|
1723
1808
|
|
|
1724
|
-
> `optional` **httpMethods
|
|
1809
|
+
> `optional` **httpMethods?**: `string`
|
|
1725
1810
|
|
|
1726
1811
|
The CORS methods to allow, defaults to GET, POST, PUT, DELETE, OPTIONS.
|
|
1727
1812
|
|
|
1728
1813
|
***
|
|
1729
1814
|
|
|
1730
|
-
### httpAllowedHeaders?
|
|
1815
|
+
### httpAllowedHeaders? {#httpallowedheaders}
|
|
1731
1816
|
|
|
1732
|
-
> `optional` **httpAllowedHeaders
|
|
1817
|
+
> `optional` **httpAllowedHeaders?**: `string`
|
|
1733
1818
|
|
|
1734
1819
|
The CORS headers to allow.
|
|
1735
1820
|
|
|
1736
1821
|
***
|
|
1737
1822
|
|
|
1738
|
-
### httpExposedHeaders?
|
|
1823
|
+
### httpExposedHeaders? {#httpexposedheaders}
|
|
1739
1824
|
|
|
1740
|
-
> `optional` **httpExposedHeaders
|
|
1825
|
+
> `optional` **httpExposedHeaders?**: `string`
|
|
1741
1826
|
|
|
1742
1827
|
The CORS headers to expose.
|
|
1743
1828
|
|
|
1744
1829
|
***
|
|
1745
1830
|
|
|
1746
|
-
###
|
|
1831
|
+
### publicOrigin? {#publicorigin}
|
|
1832
|
+
|
|
1833
|
+
> `optional` **publicOrigin?**: `string`
|
|
1834
|
+
|
|
1835
|
+
The public origin URL for the API e.g. https://api.example.com:1234
|
|
1836
|
+
|
|
1837
|
+
***
|
|
1838
|
+
|
|
1839
|
+
### authAdminProcessorType? {#authadminprocessortype}
|
|
1747
1840
|
|
|
1748
|
-
> `optional` **authAdminProcessorType
|
|
1841
|
+
> `optional` **authAdminProcessorType?**: `string`
|
|
1749
1842
|
|
|
1750
1843
|
The type of auth admin processor to use on the API: entity-storage.
|
|
1751
1844
|
|
|
1752
1845
|
***
|
|
1753
1846
|
|
|
1754
|
-
### authProcessorType?
|
|
1847
|
+
### authProcessorType? {#authprocessortype}
|
|
1755
1848
|
|
|
1756
|
-
> `optional` **authProcessorType
|
|
1849
|
+
> `optional` **authProcessorType?**: `string`
|
|
1757
1850
|
|
|
1758
1851
|
The type of auth processor to use on the API: entity-storage.
|
|
1759
1852
|
|
|
1760
1853
|
***
|
|
1761
1854
|
|
|
1762
|
-
### authSigningKeyId?
|
|
1855
|
+
### authSigningKeyId? {#authsigningkeyid}
|
|
1763
1856
|
|
|
1764
|
-
> `optional` **authSigningKeyId
|
|
1857
|
+
> `optional` **authSigningKeyId?**: `string`
|
|
1765
1858
|
|
|
1766
1859
|
The id of the key in the vault to use for signing in auth operations.
|
|
1767
1860
|
|
|
1768
1861
|
***
|
|
1769
1862
|
|
|
1770
|
-
###
|
|
1863
|
+
### hostingParamEncryptionKeyId? {#hostingparamencryptionkeyid}
|
|
1864
|
+
|
|
1865
|
+
> `optional` **hostingParamEncryptionKeyId?**: `string`
|
|
1866
|
+
|
|
1867
|
+
The id of the key in the vault to use for encrypting hosting parameters in auth operations.
|
|
1868
|
+
|
|
1869
|
+
***
|
|
1870
|
+
|
|
1871
|
+
### mimeTypeProcessors? {#mimetypeprocessors}
|
|
1771
1872
|
|
|
1772
|
-
> `optional` **mimeTypeProcessors
|
|
1873
|
+
> `optional` **mimeTypeProcessors?**: `string`
|
|
1773
1874
|
|
|
1774
1875
|
Additional MIME type processors to include, comma separated.
|
|
1775
1876
|
|
|
1776
1877
|
***
|
|
1777
1878
|
|
|
1778
|
-
### routeLoggingIncludeBody?
|
|
1879
|
+
### routeLoggingIncludeBody? {#routeloggingincludebody}
|
|
1779
1880
|
|
|
1780
|
-
> `optional` **routeLoggingIncludeBody
|
|
1881
|
+
> `optional` **routeLoggingIncludeBody?**: `string`
|
|
1781
1882
|
|
|
1782
1883
|
Include the body in the REST logging output, useful for debugging.
|
|
1783
1884
|
|
|
1784
1885
|
***
|
|
1785
1886
|
|
|
1786
|
-
### routeLoggingFullBase64?
|
|
1887
|
+
### routeLoggingFullBase64? {#routeloggingfullbase64}
|
|
1787
1888
|
|
|
1788
|
-
> `optional` **routeLoggingFullBase64
|
|
1889
|
+
> `optional` **routeLoggingFullBase64?**: `string`
|
|
1789
1890
|
|
|
1790
1891
|
Include the full base 64 output in the REST logging output, useful for debugging.
|
|
1791
1892
|
|
|
1792
1893
|
***
|
|
1793
1894
|
|
|
1794
|
-
### routeLoggingObfuscateProperties?
|
|
1895
|
+
### routeLoggingObfuscateProperties? {#routeloggingobfuscateproperties}
|
|
1795
1896
|
|
|
1796
|
-
> `optional` **routeLoggingObfuscateProperties
|
|
1897
|
+
> `optional` **routeLoggingObfuscateProperties?**: `string`
|
|
1797
1898
|
|
|
1798
1899
|
List of properties to obfuscate in the REST logging output, comma separated.
|