@twin.org/node-core 0.0.3-next.5 → 0.0.3-next.50
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 +463 -195
- 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 +125 -100
- 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 +604 -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 +405 -372
- package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md +527 -450
- package/docs/reference/interfaces/IModuleProtocol.md +3 -3
- package/docs/reference/interfaces/INodeEngineState.md +2 -26
- package/docs/reference/interfaces/INodeEnvironmentVariables.md +545 -544
- 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,9 +277,9 @@ GCP Firestore database id.
|
|
|
277
277
|
|
|
278
278
|
***
|
|
279
279
|
|
|
280
|
-
### gcpFirestoreApiEndpoint?
|
|
280
|
+
### gcpFirestoreApiEndpoint? {#gcpfirestoreapiendpoint}
|
|
281
281
|
|
|
282
|
-
> `optional` **gcpFirestoreApiEndpoint
|
|
282
|
+
> `optional` **gcpFirestoreApiEndpoint?**: `string`
|
|
283
283
|
|
|
284
284
|
GCP Firestore endpoint.
|
|
285
285
|
|
|
@@ -289,9 +289,9 @@ GCP Firestore endpoint.
|
|
|
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
|
-
###
|
|
581
|
+
### blobStorageEnableEncryption? {#blobstorageenableencryption}
|
|
582
582
|
|
|
583
|
-
> `optional` **
|
|
584
|
-
|
|
585
|
-
Blog storage connector which has public access.
|
|
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.
|
|
623
|
-
|
|
624
|
-
#### Inherited from
|
|
625
|
-
|
|
626
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageSymmetricEncryptionKey`](IEngineEnvironmentVariables.md#blobstoragesymmetricencryptionkey)
|
|
627
|
-
|
|
628
|
-
***
|
|
629
|
-
|
|
630
|
-
### blobStoragePrefix?
|
|
605
|
+
### blobStoragePrefix? {#blobstorageprefix}
|
|
631
606
|
|
|
632
|
-
> `optional` **blobStoragePrefix
|
|
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,57 +794,57 @@ The type of the default vault connector: entity-storage, hashicorp.
|
|
|
819
794
|
|
|
820
795
|
***
|
|
821
796
|
|
|
822
|
-
###
|
|
797
|
+
### vaultPrefix? {#vaultprefix}
|
|
823
798
|
|
|
824
|
-
> `optional` **
|
|
799
|
+
> `optional` **vaultPrefix?**: `string`
|
|
825
800
|
|
|
826
|
-
|
|
801
|
+
Prefix to prepend to entries in the vault.
|
|
827
802
|
|
|
828
803
|
#### Inherited from
|
|
829
804
|
|
|
830
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
805
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`vaultPrefix`](IEngineEnvironmentVariables.md#vaultprefix)
|
|
831
806
|
|
|
832
807
|
***
|
|
833
808
|
|
|
834
|
-
###
|
|
809
|
+
### hashicorpVaultToken? {#hashicorpvaulttoken}
|
|
835
810
|
|
|
836
|
-
> `optional` **
|
|
811
|
+
> `optional` **hashicorpVaultToken?**: `string`
|
|
837
812
|
|
|
838
|
-
Hashicorp Vault
|
|
813
|
+
Hashicorp Vault token.
|
|
839
814
|
|
|
840
815
|
#### Inherited from
|
|
841
816
|
|
|
842
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
817
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`hashicorpVaultToken`](IEngineEnvironmentVariables.md#hashicorpvaulttoken)
|
|
843
818
|
|
|
844
819
|
***
|
|
845
820
|
|
|
846
|
-
###
|
|
821
|
+
### hashicorpVaultEndpoint? {#hashicorpvaultendpoint}
|
|
847
822
|
|
|
848
|
-
> `optional` **
|
|
823
|
+
> `optional` **hashicorpVaultEndpoint?**: `string`
|
|
849
824
|
|
|
850
|
-
|
|
825
|
+
Hashicorp Vault endpoint.
|
|
851
826
|
|
|
852
827
|
#### Inherited from
|
|
853
828
|
|
|
854
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
829
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`hashicorpVaultEndpoint`](IEngineEnvironmentVariables.md#hashicorpvaultendpoint)
|
|
855
830
|
|
|
856
831
|
***
|
|
857
832
|
|
|
858
|
-
###
|
|
833
|
+
### loggingConnector? {#loggingconnector}
|
|
859
834
|
|
|
860
|
-
> `optional` **
|
|
835
|
+
> `optional` **loggingConnector?**: `string`
|
|
861
836
|
|
|
862
|
-
The type of
|
|
837
|
+
The type of logging task connector, can be a comma separated list: console, entity-storage.
|
|
863
838
|
|
|
864
839
|
#### Inherited from
|
|
865
840
|
|
|
866
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
841
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`loggingConnector`](IEngineEnvironmentVariables.md#loggingconnector)
|
|
867
842
|
|
|
868
843
|
***
|
|
869
844
|
|
|
870
|
-
### eventBusConnector?
|
|
845
|
+
### eventBusConnector? {#eventbusconnector}
|
|
871
846
|
|
|
872
|
-
> `optional` **eventBusConnector
|
|
847
|
+
> `optional` **eventBusConnector?**: `string`
|
|
873
848
|
|
|
874
849
|
The type of event bus connector: local.
|
|
875
850
|
|
|
@@ -879,9 +854,9 @@ The type of event bus connector: local.
|
|
|
879
854
|
|
|
880
855
|
***
|
|
881
856
|
|
|
882
|
-
### eventBusComponent?
|
|
857
|
+
### eventBusComponent? {#eventbuscomponent}
|
|
883
858
|
|
|
884
|
-
> `optional` **eventBusComponent
|
|
859
|
+
> `optional` **eventBusComponent?**: `string`
|
|
885
860
|
|
|
886
861
|
The type of event bus component: service.
|
|
887
862
|
|
|
@@ -891,9 +866,9 @@ The type of event bus component: service.
|
|
|
891
866
|
|
|
892
867
|
***
|
|
893
868
|
|
|
894
|
-
### messagingEnabled?
|
|
869
|
+
### messagingEnabled? {#messagingenabled}
|
|
895
870
|
|
|
896
|
-
> `optional` **messagingEnabled
|
|
871
|
+
> `optional` **messagingEnabled?**: `string`
|
|
897
872
|
|
|
898
873
|
Are the messaging components enabled, defaults to false.
|
|
899
874
|
|
|
@@ -903,9 +878,9 @@ Are the messaging components enabled, defaults to false.
|
|
|
903
878
|
|
|
904
879
|
***
|
|
905
880
|
|
|
906
|
-
### awsSesRegion?
|
|
881
|
+
### awsSesRegion? {#awssesregion}
|
|
907
882
|
|
|
908
|
-
> `optional` **awsSesRegion
|
|
883
|
+
> `optional` **awsSesRegion?**: `string`
|
|
909
884
|
|
|
910
885
|
AWS SES region.
|
|
911
886
|
|
|
@@ -915,9 +890,9 @@ AWS SES region.
|
|
|
915
890
|
|
|
916
891
|
***
|
|
917
892
|
|
|
918
|
-
### awsSesAuthMode?
|
|
893
|
+
### awsSesAuthMode? {#awssesauthmode}
|
|
919
894
|
|
|
920
|
-
> `optional` **awsSesAuthMode
|
|
895
|
+
> `optional` **awsSesAuthMode?**: `string`
|
|
921
896
|
|
|
922
897
|
AWS SES auth mode, either credentials or pod, defaults to credentials.
|
|
923
898
|
|
|
@@ -927,9 +902,9 @@ AWS SES auth mode, either credentials or pod, defaults to credentials.
|
|
|
927
902
|
|
|
928
903
|
***
|
|
929
904
|
|
|
930
|
-
### awsSesSecretAccessKey?
|
|
905
|
+
### awsSesSecretAccessKey? {#awssessecretaccesskey}
|
|
931
906
|
|
|
932
|
-
> `optional` **awsSesSecretAccessKey
|
|
907
|
+
> `optional` **awsSesSecretAccessKey?**: `string`
|
|
933
908
|
|
|
934
909
|
AWS SES secret access key.
|
|
935
910
|
|
|
@@ -939,9 +914,9 @@ AWS SES secret access key.
|
|
|
939
914
|
|
|
940
915
|
***
|
|
941
916
|
|
|
942
|
-
### awsSesAccessKeyId?
|
|
917
|
+
### awsSesAccessKeyId? {#awssesaccesskeyid}
|
|
943
918
|
|
|
944
|
-
> `optional` **awsSesAccessKeyId
|
|
919
|
+
> `optional` **awsSesAccessKeyId?**: `string`
|
|
945
920
|
|
|
946
921
|
AWS SES access key id.
|
|
947
922
|
|
|
@@ -951,9 +926,9 @@ AWS SES access key id.
|
|
|
951
926
|
|
|
952
927
|
***
|
|
953
928
|
|
|
954
|
-
### awsSesEndpoint?
|
|
929
|
+
### awsSesEndpoint? {#awssesendpoint}
|
|
955
930
|
|
|
956
|
-
> `optional` **awsSesEndpoint
|
|
931
|
+
> `optional` **awsSesEndpoint?**: `string`
|
|
957
932
|
|
|
958
933
|
AWS SES endpoint.
|
|
959
934
|
|
|
@@ -963,11 +938,11 @@ AWS SES endpoint.
|
|
|
963
938
|
|
|
964
939
|
***
|
|
965
940
|
|
|
966
|
-
### awsMessagingPushNotificationApplications?
|
|
941
|
+
### awsMessagingPushNotificationApplications? {#awsmessagingpushnotificationapplications}
|
|
967
942
|
|
|
968
|
-
> `optional` **awsMessagingPushNotificationApplications
|
|
943
|
+
> `optional` **awsMessagingPushNotificationApplications?**: `string`
|
|
969
944
|
|
|
970
|
-
The applications for the push notifications
|
|
945
|
+
The applications for the push notifications reference a separate json with @json: prefix.
|
|
971
946
|
|
|
972
947
|
#### Inherited from
|
|
973
948
|
|
|
@@ -975,9 +950,9 @@ The applications for the push notifications JSON stringified array of IAwsApplic
|
|
|
975
950
|
|
|
976
951
|
***
|
|
977
952
|
|
|
978
|
-
### messagingEmailConnector?
|
|
953
|
+
### messagingEmailConnector? {#messagingemailconnector}
|
|
979
954
|
|
|
980
|
-
> `optional` **messagingEmailConnector
|
|
955
|
+
> `optional` **messagingEmailConnector?**: `string`
|
|
981
956
|
|
|
982
957
|
The type of messaging email connector: entity-storage, aws.
|
|
983
958
|
|
|
@@ -987,9 +962,9 @@ The type of messaging email connector: entity-storage, aws.
|
|
|
987
962
|
|
|
988
963
|
***
|
|
989
964
|
|
|
990
|
-
### messagingSmsConnector?
|
|
965
|
+
### messagingSmsConnector? {#messagingsmsconnector}
|
|
991
966
|
|
|
992
|
-
> `optional` **messagingSmsConnector
|
|
967
|
+
> `optional` **messagingSmsConnector?**: `string`
|
|
993
968
|
|
|
994
969
|
The type of messaging sms connector: entity-storage, aws.
|
|
995
970
|
|
|
@@ -999,9 +974,9 @@ The type of messaging sms connector: entity-storage, aws.
|
|
|
999
974
|
|
|
1000
975
|
***
|
|
1001
976
|
|
|
1002
|
-
### messagingPushNotificationConnector?
|
|
977
|
+
### messagingPushNotificationConnector? {#messagingpushnotificationconnector}
|
|
1003
978
|
|
|
1004
|
-
> `optional` **messagingPushNotificationConnector
|
|
979
|
+
> `optional` **messagingPushNotificationConnector?**: `string`
|
|
1005
980
|
|
|
1006
981
|
The type of messaging push notification connector: entity-storage, aws.
|
|
1007
982
|
|
|
@@ -1011,9 +986,9 @@ The type of messaging push notification connector: entity-storage, aws.
|
|
|
1011
986
|
|
|
1012
987
|
***
|
|
1013
988
|
|
|
1014
|
-
### telemetryConnector?
|
|
989
|
+
### telemetryConnector? {#telemetryconnector}
|
|
1015
990
|
|
|
1016
|
-
> `optional` **telemetryConnector
|
|
991
|
+
> `optional` **telemetryConnector?**: `string`
|
|
1017
992
|
|
|
1018
993
|
The type of telemetry connector: entity-storage.
|
|
1019
994
|
|
|
@@ -1023,9 +998,93 @@ The type of telemetry connector: entity-storage.
|
|
|
1023
998
|
|
|
1024
999
|
***
|
|
1025
1000
|
|
|
1026
|
-
###
|
|
1001
|
+
### openTelemetryMeterName? {#opentelemetrymetername}
|
|
1002
|
+
|
|
1003
|
+
> `optional` **openTelemetryMeterName?**: `string`
|
|
1004
|
+
|
|
1005
|
+
The name of the Open Telemetry meter to use, only required if using open-telemetry as telemetry connector, defaults to twin-node.
|
|
1006
|
+
|
|
1007
|
+
#### Inherited from
|
|
1008
|
+
|
|
1009
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`openTelemetryMeterName`](IEngineEnvironmentVariables.md#opentelemetrymetername)
|
|
1010
|
+
|
|
1011
|
+
***
|
|
1012
|
+
|
|
1013
|
+
### openTelemetryMeterVersion? {#opentelemetrymeterversion}
|
|
1014
|
+
|
|
1015
|
+
> `optional` **openTelemetryMeterVersion?**: `string`
|
|
1016
|
+
|
|
1017
|
+
The version of the Open Telemetry metrics specification to use, only required if using open-telemetry as telemetry connector, defaults to 1.0.0.
|
|
1018
|
+
|
|
1019
|
+
#### Inherited from
|
|
1020
|
+
|
|
1021
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`openTelemetryMeterVersion`](IEngineEnvironmentVariables.md#opentelemetrymeterversion)
|
|
1022
|
+
|
|
1023
|
+
***
|
|
1024
|
+
|
|
1025
|
+
### openTelemetryReader? {#opentelemetryreader}
|
|
1026
|
+
|
|
1027
|
+
> `optional` **openTelemetryReader?**: `string`
|
|
1028
|
+
|
|
1029
|
+
The type of Open Telemetry metric reader to use, only required if using open-telemetry as telemetry connector, values: prometheus.
|
|
1030
|
+
|
|
1031
|
+
#### Inherited from
|
|
1032
|
+
|
|
1033
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`openTelemetryReader`](IEngineEnvironmentVariables.md#opentelemetryreader)
|
|
1034
|
+
|
|
1035
|
+
***
|
|
1036
|
+
|
|
1037
|
+
### openTelemetryPrometheusPort? {#opentelemetryprometheusport}
|
|
1038
|
+
|
|
1039
|
+
> `optional` **openTelemetryPrometheusPort?**: `string`
|
|
1040
|
+
|
|
1041
|
+
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.
|
|
1042
|
+
|
|
1043
|
+
#### Inherited from
|
|
1044
|
+
|
|
1045
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`openTelemetryPrometheusPort`](IEngineEnvironmentVariables.md#opentelemetryprometheusport)
|
|
1046
|
+
|
|
1047
|
+
***
|
|
1048
|
+
|
|
1049
|
+
### telemetryMetricsCollectorIntervalSeconds? {#telemetrymetricscollectorintervalseconds}
|
|
1050
|
+
|
|
1051
|
+
> `optional` **telemetryMetricsCollectorIntervalSeconds?**: `string`
|
|
1052
|
+
|
|
1053
|
+
Polling interval in seconds for the telemetry metrics collector. Defaults to 60.
|
|
1054
|
+
|
|
1055
|
+
#### Inherited from
|
|
1056
|
+
|
|
1057
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`telemetryMetricsCollectorIntervalSeconds`](IEngineEnvironmentVariables.md#telemetrymetricscollectorintervalseconds)
|
|
1058
|
+
|
|
1059
|
+
***
|
|
1060
|
+
|
|
1061
|
+
### telemetryMetricsProducers? {#telemetrymetricsproducers}
|
|
1062
|
+
|
|
1063
|
+
> `optional` **telemetryMetricsProducers?**: `string`
|
|
1064
|
+
|
|
1065
|
+
The type of telemetry metrics producers, can be a comma separated list: system, process.
|
|
1066
|
+
|
|
1067
|
+
#### Inherited from
|
|
1068
|
+
|
|
1069
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`telemetryMetricsProducers`](IEngineEnvironmentVariables.md#telemetrymetricsproducers)
|
|
1070
|
+
|
|
1071
|
+
***
|
|
1072
|
+
|
|
1073
|
+
### telemetryMetricsProducerMaxHistory? {#telemetrymetricsproducermaxhistory}
|
|
1074
|
+
|
|
1075
|
+
> `optional` **telemetryMetricsProducerMaxHistory?**: `string`
|
|
1076
|
+
|
|
1077
|
+
Maximum number of values retained per telemetry metric (count-based history cap). Defaults to 1440.
|
|
1078
|
+
|
|
1079
|
+
#### Inherited from
|
|
1080
|
+
|
|
1081
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`telemetryMetricsProducerMaxHistory`](IEngineEnvironmentVariables.md#telemetrymetricsproducermaxhistory)
|
|
1082
|
+
|
|
1083
|
+
***
|
|
1027
1084
|
|
|
1028
|
-
|
|
1085
|
+
### faucetConnector? {#faucetconnector}
|
|
1086
|
+
|
|
1087
|
+
> `optional` **faucetConnector?**: `string`
|
|
1029
1088
|
|
|
1030
1089
|
The type of faucet connector: entity-storage, iota.
|
|
1031
1090
|
|
|
@@ -1035,9 +1094,9 @@ The type of faucet connector: entity-storage, iota.
|
|
|
1035
1094
|
|
|
1036
1095
|
***
|
|
1037
1096
|
|
|
1038
|
-
### walletConnector?
|
|
1097
|
+
### walletConnector? {#walletconnector}
|
|
1039
1098
|
|
|
1040
|
-
> `optional` **walletConnector
|
|
1099
|
+
> `optional` **walletConnector?**: `string`
|
|
1041
1100
|
|
|
1042
1101
|
The type of wallet connector: entity-storage, iota.
|
|
1043
1102
|
|
|
@@ -1047,9 +1106,9 @@ The type of wallet connector: entity-storage, iota.
|
|
|
1047
1106
|
|
|
1048
1107
|
***
|
|
1049
1108
|
|
|
1050
|
-
### nftConnector?
|
|
1109
|
+
### nftConnector? {#nftconnector}
|
|
1051
1110
|
|
|
1052
|
-
> `optional` **nftConnector
|
|
1111
|
+
> `optional` **nftConnector?**: `string`
|
|
1053
1112
|
|
|
1054
1113
|
The type of NFT connector: entity-storage, iota.
|
|
1055
1114
|
|
|
@@ -1059,9 +1118,33 @@ The type of NFT connector: entity-storage, iota.
|
|
|
1059
1118
|
|
|
1060
1119
|
***
|
|
1061
1120
|
|
|
1062
|
-
###
|
|
1121
|
+
### nftPackageId? {#nftpackageid}
|
|
1122
|
+
|
|
1123
|
+
> `optional` **nftPackageId?**: `string`
|
|
1124
|
+
|
|
1125
|
+
The NFT deployed package id, for custom deployments.
|
|
1126
|
+
|
|
1127
|
+
#### Inherited from
|
|
1128
|
+
|
|
1129
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`nftPackageId`](IEngineEnvironmentVariables.md#nftpackageid)
|
|
1130
|
+
|
|
1131
|
+
***
|
|
1132
|
+
|
|
1133
|
+
### notarizationConnector? {#notarizationconnector}
|
|
1134
|
+
|
|
1135
|
+
> `optional` **notarizationConnector?**: `string`
|
|
1136
|
+
|
|
1137
|
+
The type of notarization connector: entity-storage, iota.
|
|
1138
|
+
|
|
1139
|
+
#### Inherited from
|
|
1140
|
+
|
|
1141
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`notarizationConnector`](IEngineEnvironmentVariables.md#notarizationconnector)
|
|
1142
|
+
|
|
1143
|
+
***
|
|
1144
|
+
|
|
1145
|
+
### identityConnector? {#identityconnector}
|
|
1063
1146
|
|
|
1064
|
-
> `optional` **identityConnector
|
|
1147
|
+
> `optional` **identityConnector?**: `string`
|
|
1065
1148
|
|
|
1066
1149
|
The type of identity connector: entity-storage, iota.
|
|
1067
1150
|
|
|
@@ -1071,33 +1154,33 @@ The type of identity connector: entity-storage, iota.
|
|
|
1071
1154
|
|
|
1072
1155
|
***
|
|
1073
1156
|
|
|
1074
|
-
###
|
|
1157
|
+
### identityWalletAddressIndex? {#identitywalletaddressindex}
|
|
1075
1158
|
|
|
1076
|
-
> `optional` **
|
|
1159
|
+
> `optional` **identityWalletAddressIndex?**: `string`
|
|
1077
1160
|
|
|
1078
|
-
The
|
|
1161
|
+
The index of the wallet address to use, defaults to 0.
|
|
1079
1162
|
|
|
1080
1163
|
#### Inherited from
|
|
1081
1164
|
|
|
1082
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1165
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`identityWalletAddressIndex`](IEngineEnvironmentVariables.md#identitywalletaddressindex)
|
|
1083
1166
|
|
|
1084
1167
|
***
|
|
1085
1168
|
|
|
1086
|
-
###
|
|
1169
|
+
### identityResolverConnector? {#identityresolverconnector}
|
|
1087
1170
|
|
|
1088
|
-
> `optional` **
|
|
1171
|
+
> `optional` **identityResolverConnector?**: `string`
|
|
1089
1172
|
|
|
1090
|
-
The type of
|
|
1173
|
+
The type of identity resolver connector: entity-storage, iota.
|
|
1091
1174
|
|
|
1092
1175
|
#### Inherited from
|
|
1093
1176
|
|
|
1094
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1177
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`identityResolverConnector`](IEngineEnvironmentVariables.md#identityresolverconnector)
|
|
1095
1178
|
|
|
1096
1179
|
***
|
|
1097
1180
|
|
|
1098
|
-
### iotaFaucetEndpoint?
|
|
1181
|
+
### iotaFaucetEndpoint? {#iotafaucetendpoint}
|
|
1099
1182
|
|
|
1100
|
-
> `optional` **iotaFaucetEndpoint
|
|
1183
|
+
> `optional` **iotaFaucetEndpoint?**: `string`
|
|
1101
1184
|
|
|
1102
1185
|
IOTA Faucet Endpoint.
|
|
1103
1186
|
|
|
@@ -1107,9 +1190,9 @@ IOTA Faucet Endpoint.
|
|
|
1107
1190
|
|
|
1108
1191
|
***
|
|
1109
1192
|
|
|
1110
|
-
### iotaNodeEndpoint?
|
|
1193
|
+
### iotaNodeEndpoint? {#iotanodeendpoint}
|
|
1111
1194
|
|
|
1112
|
-
> `optional` **iotaNodeEndpoint
|
|
1195
|
+
> `optional` **iotaNodeEndpoint?**: `string`
|
|
1113
1196
|
|
|
1114
1197
|
IOTA Node Endpoint.
|
|
1115
1198
|
|
|
@@ -1119,9 +1202,9 @@ IOTA Node Endpoint.
|
|
|
1119
1202
|
|
|
1120
1203
|
***
|
|
1121
1204
|
|
|
1122
|
-
### iotaNetwork?
|
|
1205
|
+
### iotaNetwork? {#iotanetwork}
|
|
1123
1206
|
|
|
1124
|
-
> `optional` **iotaNetwork
|
|
1207
|
+
> `optional` **iotaNetwork?**: `string`
|
|
1125
1208
|
|
|
1126
1209
|
IOTA network.
|
|
1127
1210
|
|
|
@@ -1131,9 +1214,9 @@ IOTA network.
|
|
|
1131
1214
|
|
|
1132
1215
|
***
|
|
1133
1216
|
|
|
1134
|
-
### iotaCoinType?
|
|
1217
|
+
### iotaCoinType? {#iotacointype}
|
|
1135
1218
|
|
|
1136
|
-
> `optional` **iotaCoinType
|
|
1219
|
+
> `optional` **iotaCoinType?**: `string`
|
|
1137
1220
|
|
|
1138
1221
|
IOTA coin type.
|
|
1139
1222
|
|
|
@@ -1143,9 +1226,9 @@ IOTA coin type.
|
|
|
1143
1226
|
|
|
1144
1227
|
***
|
|
1145
1228
|
|
|
1146
|
-
### iotaExplorerEndpoint?
|
|
1229
|
+
### iotaExplorerEndpoint? {#iotaexplorerendpoint}
|
|
1147
1230
|
|
|
1148
|
-
> `optional` **iotaExplorerEndpoint
|
|
1231
|
+
> `optional` **iotaExplorerEndpoint?**: `string`
|
|
1149
1232
|
|
|
1150
1233
|
IOTA Explorer Endpoint.
|
|
1151
1234
|
|
|
@@ -1155,9 +1238,9 @@ IOTA Explorer Endpoint.
|
|
|
1155
1238
|
|
|
1156
1239
|
***
|
|
1157
1240
|
|
|
1158
|
-
### iotaGasStationEndpoint?
|
|
1241
|
+
### iotaGasStationEndpoint? {#iotagasstationendpoint}
|
|
1159
1242
|
|
|
1160
|
-
> `optional` **iotaGasStationEndpoint
|
|
1243
|
+
> `optional` **iotaGasStationEndpoint?**: `string`
|
|
1161
1244
|
|
|
1162
1245
|
IOTA Gas Station Endpoint.
|
|
1163
1246
|
|
|
@@ -1167,9 +1250,9 @@ IOTA Gas Station Endpoint.
|
|
|
1167
1250
|
|
|
1168
1251
|
***
|
|
1169
1252
|
|
|
1170
|
-
### iotaGasStationAuthToken?
|
|
1253
|
+
### iotaGasStationAuthToken? {#iotagasstationauthtoken}
|
|
1171
1254
|
|
|
1172
|
-
> `optional` **iotaGasStationAuthToken
|
|
1255
|
+
> `optional` **iotaGasStationAuthToken?**: `string`
|
|
1173
1256
|
|
|
1174
1257
|
IOTA Gas Station Authentication Token.
|
|
1175
1258
|
|
|
@@ -1179,9 +1262,21 @@ IOTA Gas Station Authentication Token.
|
|
|
1179
1262
|
|
|
1180
1263
|
***
|
|
1181
1264
|
|
|
1182
|
-
###
|
|
1265
|
+
### iotaIdentityPackageId? {#iotaidentitypackageid}
|
|
1183
1266
|
|
|
1184
|
-
> `optional` **
|
|
1267
|
+
> `optional` **iotaIdentityPackageId?**: `string`
|
|
1268
|
+
|
|
1269
|
+
The IOTA Identity deployed package id, for custom deployments.
|
|
1270
|
+
|
|
1271
|
+
#### Inherited from
|
|
1272
|
+
|
|
1273
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaIdentityPackageId`](IEngineEnvironmentVariables.md#iotaidentitypackageid)
|
|
1274
|
+
|
|
1275
|
+
***
|
|
1276
|
+
|
|
1277
|
+
### universalResolverEndpoint? {#universalresolverendpoint}
|
|
1278
|
+
|
|
1279
|
+
> `optional` **universalResolverEndpoint?**: `string`
|
|
1185
1280
|
|
|
1186
1281
|
Universal Resolver Endpoint.
|
|
1187
1282
|
|
|
@@ -1191,9 +1286,9 @@ Universal Resolver Endpoint.
|
|
|
1191
1286
|
|
|
1192
1287
|
***
|
|
1193
1288
|
|
|
1194
|
-
### identityProfileConnector?
|
|
1289
|
+
### identityProfileConnector? {#identityprofileconnector}
|
|
1195
1290
|
|
|
1196
|
-
> `optional` **identityProfileConnector
|
|
1291
|
+
> `optional` **identityProfileConnector?**: `string`
|
|
1197
1292
|
|
|
1198
1293
|
The type of identity profile connector: entity-storage.
|
|
1199
1294
|
|
|
@@ -1203,9 +1298,9 @@ The type of identity profile connector: entity-storage.
|
|
|
1203
1298
|
|
|
1204
1299
|
***
|
|
1205
1300
|
|
|
1206
|
-
### immutableProofVerificationMethodId?
|
|
1301
|
+
### immutableProofVerificationMethodId? {#immutableproofverificationmethodid}
|
|
1207
1302
|
|
|
1208
|
-
> `optional` **immutableProofVerificationMethodId
|
|
1303
|
+
> `optional` **immutableProofVerificationMethodId?**: `string`
|
|
1209
1304
|
|
|
1210
1305
|
The identity verification method id to use with immutable proofs.
|
|
1211
1306
|
|
|
@@ -1215,9 +1310,9 @@ The identity verification method id to use with immutable proofs.
|
|
|
1215
1310
|
|
|
1216
1311
|
***
|
|
1217
1312
|
|
|
1218
|
-
### attestationConnector?
|
|
1313
|
+
### attestationConnector? {#attestationconnector}
|
|
1219
1314
|
|
|
1220
|
-
> `optional` **attestationConnector
|
|
1315
|
+
> `optional` **attestationConnector?**: `string`
|
|
1221
1316
|
|
|
1222
1317
|
The type of attestation connector: entity-storage, iota.
|
|
1223
1318
|
|
|
@@ -1227,9 +1322,9 @@ The type of attestation connector: entity-storage, iota.
|
|
|
1227
1322
|
|
|
1228
1323
|
***
|
|
1229
1324
|
|
|
1230
|
-
### attestationVerificationMethodId?
|
|
1325
|
+
### attestationVerificationMethodId? {#attestationverificationmethodid}
|
|
1231
1326
|
|
|
1232
|
-
> `optional` **attestationVerificationMethodId
|
|
1327
|
+
> `optional` **attestationVerificationMethodId?**: `string`
|
|
1233
1328
|
|
|
1234
1329
|
The identity verification method id to use with attestation.
|
|
1235
1330
|
|
|
@@ -1239,9 +1334,9 @@ The identity verification method id to use with attestation.
|
|
|
1239
1334
|
|
|
1240
1335
|
***
|
|
1241
1336
|
|
|
1242
|
-
### dataProcessingEnabled?
|
|
1337
|
+
### dataProcessingEnabled? {#dataprocessingenabled}
|
|
1243
1338
|
|
|
1244
|
-
> `optional` **dataProcessingEnabled
|
|
1339
|
+
> `optional` **dataProcessingEnabled?**: `string`
|
|
1245
1340
|
|
|
1246
1341
|
Is the data processing enabled, defaults to false.
|
|
1247
1342
|
|
|
@@ -1251,9 +1346,9 @@ Is the data processing enabled, defaults to false.
|
|
|
1251
1346
|
|
|
1252
1347
|
***
|
|
1253
1348
|
|
|
1254
|
-
### dataConverterConnectors?
|
|
1349
|
+
### dataConverterConnectors? {#dataconverterconnectors}
|
|
1255
1350
|
|
|
1256
|
-
> `optional` **dataConverterConnectors
|
|
1351
|
+
> `optional` **dataConverterConnectors?**: `string`
|
|
1257
1352
|
|
|
1258
1353
|
The type of the default data converters, can be a comma separated list: json, xml.
|
|
1259
1354
|
|
|
@@ -1263,9 +1358,9 @@ The type of the default data converters, can be a comma separated list: json, xm
|
|
|
1263
1358
|
|
|
1264
1359
|
***
|
|
1265
1360
|
|
|
1266
|
-
### dataExtractorConnectors?
|
|
1361
|
+
### dataExtractorConnectors? {#dataextractorconnectors}
|
|
1267
1362
|
|
|
1268
|
-
> `optional` **dataExtractorConnectors
|
|
1363
|
+
> `optional` **dataExtractorConnectors?**: `string`
|
|
1269
1364
|
|
|
1270
1365
|
The type of the default data extractor, can be a comma separated list: json-path.
|
|
1271
1366
|
|
|
@@ -1275,9 +1370,9 @@ The type of the default data extractor, can be a comma separated list: json-path
|
|
|
1275
1370
|
|
|
1276
1371
|
***
|
|
1277
1372
|
|
|
1278
|
-
### auditableItemGraphEnabled?
|
|
1373
|
+
### auditableItemGraphEnabled? {#auditableitemgraphenabled}
|
|
1279
1374
|
|
|
1280
|
-
> `optional` **auditableItemGraphEnabled
|
|
1375
|
+
> `optional` **auditableItemGraphEnabled?**: `string`
|
|
1281
1376
|
|
|
1282
1377
|
Is the auditable item graph enabled, defaults to false.
|
|
1283
1378
|
|
|
@@ -1287,9 +1382,9 @@ Is the auditable item graph enabled, defaults to false.
|
|
|
1287
1382
|
|
|
1288
1383
|
***
|
|
1289
1384
|
|
|
1290
|
-
### auditableItemStreamEnabled?
|
|
1385
|
+
### auditableItemStreamEnabled? {#auditableitemstreamenabled}
|
|
1291
1386
|
|
|
1292
|
-
> `optional` **auditableItemStreamEnabled
|
|
1387
|
+
> `optional` **auditableItemStreamEnabled?**: `string`
|
|
1293
1388
|
|
|
1294
1389
|
Is the auditable item stream enabled, defaults to false.
|
|
1295
1390
|
|
|
@@ -1299,9 +1394,9 @@ Is the auditable item stream enabled, defaults to false.
|
|
|
1299
1394
|
|
|
1300
1395
|
***
|
|
1301
1396
|
|
|
1302
|
-
### documentManagementEnabled?
|
|
1397
|
+
### documentManagementEnabled? {#documentmanagementenabled}
|
|
1303
1398
|
|
|
1304
|
-
> `optional` **documentManagementEnabled
|
|
1399
|
+
> `optional` **documentManagementEnabled?**: `string`
|
|
1305
1400
|
|
|
1306
1401
|
Is the document management enabled, defaults to false.
|
|
1307
1402
|
|
|
@@ -1311,381 +1406,347 @@ Is the document management enabled, defaults to false.
|
|
|
1311
1406
|
|
|
1312
1407
|
***
|
|
1313
1408
|
|
|
1314
|
-
###
|
|
1409
|
+
### federatedCatalogueEnabled? {#federatedcatalogueenabled}
|
|
1315
1410
|
|
|
1316
|
-
> `optional` **
|
|
1411
|
+
> `optional` **federatedCatalogueEnabled?**: `string`
|
|
1317
1412
|
|
|
1318
|
-
|
|
1413
|
+
Enable the federated catalogue, defaults to false, automatically enabled if remote endpoint, filters or dataspace is enabled.
|
|
1319
1414
|
|
|
1320
1415
|
#### Inherited from
|
|
1321
1416
|
|
|
1322
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1417
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueEnabled`](IEngineEnvironmentVariables.md#federatedcatalogueenabled)
|
|
1323
1418
|
|
|
1324
1419
|
***
|
|
1325
1420
|
|
|
1326
|
-
###
|
|
1421
|
+
### federatedCatalogueFilters? {#federatedcataloguefilters}
|
|
1327
1422
|
|
|
1328
|
-
> `optional` **
|
|
1423
|
+
> `optional` **federatedCatalogueFilters?**: `string`
|
|
1329
1424
|
|
|
1330
|
-
|
|
1425
|
+
Federated catalog filters, command separated list of filters to add.
|
|
1331
1426
|
|
|
1332
1427
|
#### Inherited from
|
|
1333
1428
|
|
|
1334
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1429
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueFilters`](IEngineEnvironmentVariables.md#federatedcataloguefilters)
|
|
1335
1430
|
|
|
1336
1431
|
***
|
|
1337
1432
|
|
|
1338
|
-
###
|
|
1433
|
+
### federatedCatalogueRemoteEndpoint? {#federatedcatalogueremoteendpoint}
|
|
1339
1434
|
|
|
1340
|
-
> `optional` **
|
|
1435
|
+
> `optional` **federatedCatalogueRemoteEndpoint?**: `string`
|
|
1341
1436
|
|
|
1342
|
-
|
|
1343
|
-
This only required if using a custom verifiable storage item, otherwise it will default to the network name.
|
|
1437
|
+
Federated catalog remote endpoint, if set will use a REST client instead of local service.
|
|
1344
1438
|
|
|
1345
1439
|
#### Inherited from
|
|
1346
1440
|
|
|
1347
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1441
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueRemoteEndpoint`](IEngineEnvironmentVariables.md#federatedcatalogueremoteendpoint)
|
|
1348
1442
|
|
|
1349
1443
|
***
|
|
1350
1444
|
|
|
1351
|
-
###
|
|
1445
|
+
### trustGenerators? {#trustgenerators}
|
|
1352
1446
|
|
|
1353
|
-
> `optional` **
|
|
1447
|
+
> `optional` **trustGenerators?**: `string`
|
|
1354
1448
|
|
|
1355
|
-
The
|
|
1356
|
-
Only required for trusted nodes, as regular nodes will request from the trusted nodes.
|
|
1357
|
-
Defaults to synchronised-storage-blob-encryption
|
|
1449
|
+
The trust generators to add to the factory, comma separated list.
|
|
1358
1450
|
|
|
1359
1451
|
#### Inherited from
|
|
1360
1452
|
|
|
1361
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1453
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustGenerators`](IEngineEnvironmentVariables.md#trustgenerators)
|
|
1362
1454
|
|
|
1363
1455
|
***
|
|
1364
1456
|
|
|
1365
|
-
###
|
|
1457
|
+
### trustVerifiers? {#trustverifiers}
|
|
1366
1458
|
|
|
1367
|
-
> `optional` **
|
|
1459
|
+
> `optional` **trustVerifiers?**: `string`
|
|
1368
1460
|
|
|
1369
|
-
The
|
|
1370
|
-
Only required for trusted nodes, as regular nodes will not write encrypted data.
|
|
1461
|
+
The trust verifiers to add to the factory, comma separated list.
|
|
1371
1462
|
|
|
1372
1463
|
#### Inherited from
|
|
1373
1464
|
|
|
1374
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1465
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustVerifiers`](IEngineEnvironmentVariables.md#trustverifiers)
|
|
1375
1466
|
|
|
1376
1467
|
***
|
|
1377
1468
|
|
|
1378
|
-
###
|
|
1469
|
+
### trustVerificationMethodId? {#trustverificationmethodid}
|
|
1379
1470
|
|
|
1380
|
-
> `optional` **
|
|
1471
|
+
> `optional` **trustVerificationMethodId?**: `string`
|
|
1381
1472
|
|
|
1382
|
-
|
|
1383
|
-
|
|
1384
|
-
#### Default
|
|
1385
|
-
|
|
1386
|
-
```ts
|
|
1387
|
-
5
|
|
1388
|
-
```
|
|
1473
|
+
The verification method to use for trust identities.
|
|
1474
|
+
Defaults to trust-assertion.
|
|
1389
1475
|
|
|
1390
1476
|
#### Inherited from
|
|
1391
1477
|
|
|
1392
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1478
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustVerificationMethodId`](IEngineEnvironmentVariables.md#trustverificationmethodid)
|
|
1393
1479
|
|
|
1394
1480
|
***
|
|
1395
1481
|
|
|
1396
|
-
###
|
|
1482
|
+
### trustJwtTtlSeconds? {#trustjwtttlseconds}
|
|
1397
1483
|
|
|
1398
|
-
> `optional` **
|
|
1484
|
+
> `optional` **trustJwtTtlSeconds?**: `string`
|
|
1399
1485
|
|
|
1400
|
-
|
|
1401
|
-
|
|
1402
|
-
#### Default
|
|
1403
|
-
|
|
1404
|
-
```ts
|
|
1405
|
-
60
|
|
1406
|
-
```
|
|
1486
|
+
The trust time to live for generating JWTs.
|
|
1487
|
+
Defaults to undefined for never expiring.
|
|
1407
1488
|
|
|
1408
1489
|
#### Inherited from
|
|
1409
1490
|
|
|
1410
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1491
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustJwtTtlSeconds`](IEngineEnvironmentVariables.md#trustjwtttlseconds)
|
|
1411
1492
|
|
|
1412
1493
|
***
|
|
1413
1494
|
|
|
1414
|
-
###
|
|
1495
|
+
### trustIdentitiesAllow? {#trustidentitiesallow}
|
|
1415
1496
|
|
|
1416
|
-
> `optional` **
|
|
1497
|
+
> `optional` **trustIdentitiesAllow?**: `string`
|
|
1417
1498
|
|
|
1418
|
-
The
|
|
1419
|
-
|
|
1420
|
-
#### Default
|
|
1421
|
-
|
|
1422
|
-
```ts
|
|
1423
|
-
1000
|
|
1424
|
-
```
|
|
1499
|
+
The allow lists for the trust identity verifier, comma separated list of identities.
|
|
1425
1500
|
|
|
1426
1501
|
#### Inherited from
|
|
1427
1502
|
|
|
1428
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1503
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustIdentitiesAllow`](IEngineEnvironmentVariables.md#trustidentitiesallow)
|
|
1429
1504
|
|
|
1430
1505
|
***
|
|
1431
1506
|
|
|
1432
|
-
###
|
|
1433
|
-
|
|
1434
|
-
> `optional` **synchronisedStorageMaxConsolidations**: `string`
|
|
1507
|
+
### trustIdentitiesDeny? {#trustidentitiesdeny}
|
|
1435
1508
|
|
|
1436
|
-
|
|
1509
|
+
> `optional` **trustIdentitiesDeny?**: `string`
|
|
1437
1510
|
|
|
1438
|
-
|
|
1439
|
-
|
|
1440
|
-
```ts
|
|
1441
|
-
5
|
|
1442
|
-
```
|
|
1511
|
+
The deny lists for the trust identity verifier, comma separated list of identities.
|
|
1443
1512
|
|
|
1444
1513
|
#### Inherited from
|
|
1445
1514
|
|
|
1446
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1515
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustIdentitiesDeny`](IEngineEnvironmentVariables.md#trustidentitiesdeny)
|
|
1447
1516
|
|
|
1448
1517
|
***
|
|
1449
1518
|
|
|
1450
|
-
###
|
|
1519
|
+
### rightsManagementCallbackPath? {#rightsmanagementcallbackpath}
|
|
1451
1520
|
|
|
1452
|
-
> `optional` **
|
|
1521
|
+
> `optional` **rightsManagementCallbackPath?**: `string`
|
|
1453
1522
|
|
|
1454
|
-
|
|
1523
|
+
Path under which the rights management service is mounted (single source
|
|
1524
|
+
of truth). The same value drives:
|
|
1525
|
+
- the server route mount (via engine config)
|
|
1526
|
+
- the PNP service's callback URL builder (`buildCallbackUrl`)
|
|
1527
|
+
- the PNP rest-client's pathPrefix (consumer side)
|
|
1528
|
+
Defaults to `rights-management`. Set when deploying behind a reverse proxy
|
|
1529
|
+
with path rewriting, K8s ingress with path-based routing, or any custom
|
|
1530
|
+
mount point.
|
|
1455
1531
|
|
|
1456
1532
|
#### Inherited from
|
|
1457
1533
|
|
|
1458
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1534
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementCallbackPath`](IEngineEnvironmentVariables.md#rightsmanagementcallbackpath)
|
|
1459
1535
|
|
|
1460
1536
|
***
|
|
1461
1537
|
|
|
1462
|
-
###
|
|
1538
|
+
### rightsManagementPolicyInformationSources? {#rightsmanagementpolicyinformationsources}
|
|
1463
1539
|
|
|
1464
|
-
> `optional` **
|
|
1540
|
+
> `optional` **rightsManagementPolicyInformationSources?**: `string`
|
|
1465
1541
|
|
|
1466
|
-
|
|
1542
|
+
The rights management policy information sources to add to the factory.
|
|
1467
1543
|
|
|
1468
1544
|
#### Inherited from
|
|
1469
1545
|
|
|
1470
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1546
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyInformationSources`](IEngineEnvironmentVariables.md#rightsmanagementpolicyinformationsources)
|
|
1471
1547
|
|
|
1472
1548
|
***
|
|
1473
1549
|
|
|
1474
|
-
###
|
|
1550
|
+
### rightsManagementPolicyNegotiators? {#rightsmanagementpolicynegotiators}
|
|
1475
1551
|
|
|
1476
|
-
> `optional` **
|
|
1552
|
+
> `optional` **rightsManagementPolicyNegotiators?**: `string`
|
|
1477
1553
|
|
|
1478
|
-
|
|
1554
|
+
The rights management policy negotiators sources to add to the factory.
|
|
1479
1555
|
|
|
1480
1556
|
#### Inherited from
|
|
1481
1557
|
|
|
1482
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1558
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyNegotiators`](IEngineEnvironmentVariables.md#rightsmanagementpolicynegotiators)
|
|
1483
1559
|
|
|
1484
1560
|
***
|
|
1485
1561
|
|
|
1486
|
-
###
|
|
1562
|
+
### rightsManagementPolicyRequesters? {#rightsmanagementpolicyrequesters}
|
|
1487
1563
|
|
|
1488
|
-
> `optional` **
|
|
1564
|
+
> `optional` **rightsManagementPolicyRequesters?**: `string`
|
|
1489
1565
|
|
|
1490
|
-
|
|
1566
|
+
The rights management policy requesters to add to the factory.
|
|
1491
1567
|
|
|
1492
1568
|
#### Inherited from
|
|
1493
1569
|
|
|
1494
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1570
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyRequesters`](IEngineEnvironmentVariables.md#rightsmanagementpolicyrequesters)
|
|
1495
1571
|
|
|
1496
1572
|
***
|
|
1497
1573
|
|
|
1498
|
-
###
|
|
1574
|
+
### rightsManagementPolicyExecutionActions? {#rightsmanagementpolicyexecutionactions}
|
|
1499
1575
|
|
|
1500
|
-
> `optional` **
|
|
1576
|
+
> `optional` **rightsManagementPolicyExecutionActions?**: `string`
|
|
1501
1577
|
|
|
1502
|
-
|
|
1578
|
+
The rights management policy execution actions to add to the factory.
|
|
1503
1579
|
|
|
1504
1580
|
#### Inherited from
|
|
1505
1581
|
|
|
1506
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1582
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyExecutionActions`](IEngineEnvironmentVariables.md#rightsmanagementpolicyexecutionactions)
|
|
1507
1583
|
|
|
1508
1584
|
***
|
|
1509
1585
|
|
|
1510
|
-
###
|
|
1586
|
+
### rightsManagementPolicyEnforcementProcessors? {#rightsmanagementpolicyenforcementprocessors}
|
|
1511
1587
|
|
|
1512
|
-
> `optional` **
|
|
1588
|
+
> `optional` **rightsManagementPolicyEnforcementProcessors?**: `string`
|
|
1513
1589
|
|
|
1514
|
-
The rights management
|
|
1515
|
-
Use the @json: prefix to specify the path to the JSON configuration file.
|
|
1590
|
+
The rights management policy enforcement processors to add to the factory.
|
|
1516
1591
|
|
|
1517
1592
|
#### Inherited from
|
|
1518
1593
|
|
|
1519
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1594
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyEnforcementProcessors`](IEngineEnvironmentVariables.md#rightsmanagementpolicyenforcementprocessors)
|
|
1520
1595
|
|
|
1521
1596
|
***
|
|
1522
1597
|
|
|
1523
|
-
###
|
|
1598
|
+
### rightsManagementPolicyArbiters? {#rightsmanagementpolicyarbiters}
|
|
1524
1599
|
|
|
1525
|
-
> `optional` **
|
|
1600
|
+
> `optional` **rightsManagementPolicyArbiters?**: `string`
|
|
1526
1601
|
|
|
1527
|
-
The rights management
|
|
1528
|
-
Use the @json: prefix to specify the path to the JSON configuration file.
|
|
1602
|
+
The rights management policy arbiters to add to the factory.
|
|
1529
1603
|
|
|
1530
1604
|
#### Inherited from
|
|
1531
1605
|
|
|
1532
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1606
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyArbiters`](IEngineEnvironmentVariables.md#rightsmanagementpolicyarbiters)
|
|
1533
1607
|
|
|
1534
1608
|
***
|
|
1535
1609
|
|
|
1536
|
-
###
|
|
1610
|
+
### rightsManagementPolicyObligationEnforcers? {#rightsmanagementpolicyobligationenforcers}
|
|
1537
1611
|
|
|
1538
|
-
> `optional` **
|
|
1612
|
+
> `optional` **rightsManagementPolicyObligationEnforcers?**: `string`
|
|
1539
1613
|
|
|
1540
|
-
The rights management
|
|
1541
|
-
Use the @json: prefix to specify the path to the JSON configuration file.
|
|
1614
|
+
The rights management policy obligation enforcers to add to the factory.
|
|
1542
1615
|
|
|
1543
1616
|
#### Inherited from
|
|
1544
1617
|
|
|
1545
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1618
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyObligationEnforcers`](IEngineEnvironmentVariables.md#rightsmanagementpolicyobligationenforcers)
|
|
1546
1619
|
|
|
1547
1620
|
***
|
|
1548
1621
|
|
|
1549
|
-
###
|
|
1622
|
+
### dataspaceEnabled? {#dataspaceenabled}
|
|
1550
1623
|
|
|
1551
|
-
> `optional` **
|
|
1624
|
+
> `optional` **dataspaceEnabled?**: `string`
|
|
1552
1625
|
|
|
1553
|
-
|
|
1554
|
-
Use the @json: prefix to specify the path to the JSON configuration file.
|
|
1626
|
+
Is the dataspace enabled, defaults to false.
|
|
1555
1627
|
|
|
1556
1628
|
#### Inherited from
|
|
1557
1629
|
|
|
1558
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1630
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataspaceEnabled`](IEngineEnvironmentVariables.md#dataspaceenabled)
|
|
1559
1631
|
|
|
1560
1632
|
***
|
|
1561
1633
|
|
|
1562
|
-
###
|
|
1563
|
-
|
|
1564
|
-
> `optional` **rightsManagementEnforcementProcessors**: `string`
|
|
1634
|
+
### dataspaceRetainActivityLogsFor? {#dataspaceretainactivitylogsfor}
|
|
1565
1635
|
|
|
1566
|
-
|
|
1567
|
-
Use the @json: prefix to specify the path to the JSON configuration file.
|
|
1636
|
+
> `optional` **dataspaceRetainActivityLogsFor?**: `string`
|
|
1568
1637
|
|
|
1569
|
-
|
|
1570
|
-
|
|
1571
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementEnforcementProcessors`](IEngineEnvironmentVariables.md#rightsmanagementenforcementprocessors)
|
|
1572
|
-
|
|
1573
|
-
***
|
|
1574
|
-
|
|
1575
|
-
### rightsManagementArbiters?
|
|
1638
|
+
The length of time to retain the activity logs for in minutes, set to -1 to keep forever.
|
|
1576
1639
|
|
|
1577
|
-
|
|
1640
|
+
#### Default
|
|
1578
1641
|
|
|
1579
|
-
|
|
1580
|
-
|
|
1642
|
+
```ts
|
|
1643
|
+
10
|
|
1644
|
+
```
|
|
1581
1645
|
|
|
1582
1646
|
#### Inherited from
|
|
1583
1647
|
|
|
1584
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1648
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataspaceRetainActivityLogsFor`](IEngineEnvironmentVariables.md#dataspaceretainactivitylogsfor)
|
|
1585
1649
|
|
|
1586
1650
|
***
|
|
1587
1651
|
|
|
1588
|
-
###
|
|
1652
|
+
### dataspaceActivityLogsCleanUpInterval? {#dataspaceactivitylogscleanupinterval}
|
|
1653
|
+
|
|
1654
|
+
> `optional` **dataspaceActivityLogsCleanUpInterval?**: `string`
|
|
1655
|
+
|
|
1656
|
+
The interval for cleaning up the activity logs.
|
|
1589
1657
|
|
|
1590
|
-
|
|
1658
|
+
#### Default
|
|
1591
1659
|
|
|
1592
|
-
|
|
1593
|
-
|
|
1660
|
+
```ts
|
|
1661
|
+
60
|
|
1662
|
+
```
|
|
1594
1663
|
|
|
1595
1664
|
#### Inherited from
|
|
1596
1665
|
|
|
1597
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1666
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataspaceActivityLogsCleanUpInterval`](IEngineEnvironmentVariables.md#dataspaceactivitylogscleanupinterval)
|
|
1598
1667
|
|
|
1599
1668
|
***
|
|
1600
1669
|
|
|
1601
|
-
###
|
|
1670
|
+
### dataspaceDataPlanePath? {#dataspacedataplanepath}
|
|
1602
1671
|
|
|
1603
|
-
> `optional` **
|
|
1672
|
+
> `optional` **dataspaceDataPlanePath?**: `string`
|
|
1604
1673
|
|
|
1605
|
-
|
|
1674
|
+
The data plane path for PULL transfers (path only, not full URL).
|
|
1675
|
+
Will be combined with public origin from hosting component.
|
|
1676
|
+
Required if PULL transfers should be supported.
|
|
1677
|
+
Example: "dataspace/entities"
|
|
1606
1678
|
|
|
1607
1679
|
#### Inherited from
|
|
1608
1680
|
|
|
1609
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1681
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataspaceDataPlanePath`](IEngineEnvironmentVariables.md#dataspacedataplanepath)
|
|
1610
1682
|
|
|
1611
1683
|
***
|
|
1612
1684
|
|
|
1613
|
-
###
|
|
1685
|
+
### healthEnabled? {#healthenabled}
|
|
1614
1686
|
|
|
1615
|
-
> `optional` **
|
|
1687
|
+
> `optional` **healthEnabled?**: `string`
|
|
1616
1688
|
|
|
1617
|
-
|
|
1689
|
+
Are the health components enabled, defaults to false.
|
|
1618
1690
|
|
|
1619
1691
|
#### Inherited from
|
|
1620
1692
|
|
|
1621
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1693
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`healthEnabled`](IEngineEnvironmentVariables.md#healthenabled)
|
|
1622
1694
|
|
|
1623
1695
|
***
|
|
1624
1696
|
|
|
1625
|
-
###
|
|
1697
|
+
### healthIntervalSeconds? {#healthintervalseconds}
|
|
1626
1698
|
|
|
1627
|
-
> `optional` **
|
|
1699
|
+
> `optional` **healthIntervalSeconds?**: `string`
|
|
1628
1700
|
|
|
1629
|
-
The
|
|
1630
|
-
|
|
1631
|
-
#### Default
|
|
1632
|
-
|
|
1633
|
-
```ts
|
|
1634
|
-
10
|
|
1635
|
-
```
|
|
1701
|
+
The interval in seconds for performing health checks, defaults to 60.
|
|
1636
1702
|
|
|
1637
1703
|
#### Inherited from
|
|
1638
1704
|
|
|
1639
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1705
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`healthIntervalSeconds`](IEngineEnvironmentVariables.md#healthintervalseconds)
|
|
1640
1706
|
|
|
1641
1707
|
***
|
|
1642
1708
|
|
|
1643
|
-
###
|
|
1709
|
+
### healthStartupIntervalSeconds? {#healthstartupintervalseconds}
|
|
1644
1710
|
|
|
1645
|
-
> `optional` **
|
|
1711
|
+
> `optional` **healthStartupIntervalSeconds?**: `string`
|
|
1646
1712
|
|
|
1647
|
-
The interval for
|
|
1648
|
-
|
|
1649
|
-
#### Default
|
|
1650
|
-
|
|
1651
|
-
```ts
|
|
1652
|
-
60
|
|
1653
|
-
```
|
|
1713
|
+
The interval in seconds for performing health checks at startup, defaults to 2.
|
|
1714
|
+
This allows components that take a long time to initialize to be healthy before the first health check is performed.
|
|
1654
1715
|
|
|
1655
1716
|
#### Inherited from
|
|
1656
1717
|
|
|
1657
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1718
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`healthStartupIntervalSeconds`](IEngineEnvironmentVariables.md#healthstartupintervalseconds)
|
|
1658
1719
|
|
|
1659
1720
|
***
|
|
1660
1721
|
|
|
1661
|
-
###
|
|
1722
|
+
### urlTransformerEncryptionKeyId? {#urltransformerencryptionkeyid}
|
|
1662
1723
|
|
|
1663
|
-
> `optional` **
|
|
1724
|
+
> `optional` **urlTransformerEncryptionKeyId?**: `string`
|
|
1664
1725
|
|
|
1665
|
-
|
|
1726
|
+
The id of the key in the vault to use for encrypting parameters in url transformer.
|
|
1666
1727
|
|
|
1667
1728
|
#### Inherited from
|
|
1668
1729
|
|
|
1669
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1730
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`urlTransformerEncryptionKeyId`](IEngineEnvironmentVariables.md#urltransformerencryptionkeyid)
|
|
1670
1731
|
|
|
1671
1732
|
***
|
|
1672
1733
|
|
|
1673
|
-
###
|
|
1734
|
+
### automationActionTypes? {#automationactiontypes}
|
|
1674
1735
|
|
|
1675
|
-
> `optional` **
|
|
1736
|
+
> `optional` **automationActionTypes?**: `string`
|
|
1676
1737
|
|
|
1677
|
-
|
|
1678
|
-
|
|
1738
|
+
The type of the automation action to create, comma separate for more than one connector.
|
|
1739
|
+
values: fetch
|
|
1679
1740
|
|
|
1680
1741
|
#### Inherited from
|
|
1681
1742
|
|
|
1682
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1743
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`automationActionTypes`](IEngineEnvironmentVariables.md#automationactiontypes)
|
|
1683
1744
|
|
|
1684
1745
|
***
|
|
1685
1746
|
|
|
1686
|
-
### extensions?
|
|
1747
|
+
### extensions? {#extensions}
|
|
1687
1748
|
|
|
1688
|
-
> `optional` **extensions
|
|
1749
|
+
> `optional` **extensions?**: `string`
|
|
1689
1750
|
|
|
1690
1751
|
A comma separated list of additional node extensions to load, the initialiseExtension method will be called for each extension.
|
|
1691
1752
|
|
|
@@ -1695,104 +1756,120 @@ A comma separated list of additional node extensions to load, the initialiseExte
|
|
|
1695
1756
|
|
|
1696
1757
|
***
|
|
1697
1758
|
|
|
1698
|
-
### port?
|
|
1759
|
+
### port? {#port}
|
|
1699
1760
|
|
|
1700
|
-
> `optional` **port
|
|
1761
|
+
> `optional` **port?**: `string`
|
|
1701
1762
|
|
|
1702
1763
|
The port to serve the API from.
|
|
1703
1764
|
|
|
1704
1765
|
***
|
|
1705
1766
|
|
|
1706
|
-
### host?
|
|
1767
|
+
### host? {#host}
|
|
1707
1768
|
|
|
1708
|
-
> `optional` **host
|
|
1769
|
+
> `optional` **host?**: `string`
|
|
1709
1770
|
|
|
1710
1771
|
The host to serve the API from.
|
|
1711
1772
|
|
|
1712
1773
|
***
|
|
1713
1774
|
|
|
1714
|
-
### corsOrigins?
|
|
1775
|
+
### corsOrigins? {#corsorigins}
|
|
1715
1776
|
|
|
1716
|
-
> `optional` **corsOrigins
|
|
1777
|
+
> `optional` **corsOrigins?**: `string`
|
|
1717
1778
|
|
|
1718
1779
|
The CORS origins to allow, defaults to *.
|
|
1719
1780
|
|
|
1720
1781
|
***
|
|
1721
1782
|
|
|
1722
|
-
### httpMethods?
|
|
1783
|
+
### httpMethods? {#httpmethods}
|
|
1723
1784
|
|
|
1724
|
-
> `optional` **httpMethods
|
|
1785
|
+
> `optional` **httpMethods?**: `string`
|
|
1725
1786
|
|
|
1726
1787
|
The CORS methods to allow, defaults to GET, POST, PUT, DELETE, OPTIONS.
|
|
1727
1788
|
|
|
1728
1789
|
***
|
|
1729
1790
|
|
|
1730
|
-
### httpAllowedHeaders?
|
|
1791
|
+
### httpAllowedHeaders? {#httpallowedheaders}
|
|
1731
1792
|
|
|
1732
|
-
> `optional` **httpAllowedHeaders
|
|
1793
|
+
> `optional` **httpAllowedHeaders?**: `string`
|
|
1733
1794
|
|
|
1734
1795
|
The CORS headers to allow.
|
|
1735
1796
|
|
|
1736
1797
|
***
|
|
1737
1798
|
|
|
1738
|
-
### httpExposedHeaders?
|
|
1799
|
+
### httpExposedHeaders? {#httpexposedheaders}
|
|
1739
1800
|
|
|
1740
|
-
> `optional` **httpExposedHeaders
|
|
1801
|
+
> `optional` **httpExposedHeaders?**: `string`
|
|
1741
1802
|
|
|
1742
1803
|
The CORS headers to expose.
|
|
1743
1804
|
|
|
1744
1805
|
***
|
|
1745
1806
|
|
|
1746
|
-
###
|
|
1807
|
+
### publicOrigin? {#publicorigin}
|
|
1808
|
+
|
|
1809
|
+
> `optional` **publicOrigin?**: `string`
|
|
1810
|
+
|
|
1811
|
+
The public origin URL for the API e.g. https://api.example.com:1234
|
|
1812
|
+
|
|
1813
|
+
***
|
|
1814
|
+
|
|
1815
|
+
### authAdminProcessorType? {#authadminprocessortype}
|
|
1747
1816
|
|
|
1748
|
-
> `optional` **authAdminProcessorType
|
|
1817
|
+
> `optional` **authAdminProcessorType?**: `string`
|
|
1749
1818
|
|
|
1750
1819
|
The type of auth admin processor to use on the API: entity-storage.
|
|
1751
1820
|
|
|
1752
1821
|
***
|
|
1753
1822
|
|
|
1754
|
-
### authProcessorType?
|
|
1823
|
+
### authProcessorType? {#authprocessortype}
|
|
1755
1824
|
|
|
1756
|
-
> `optional` **authProcessorType
|
|
1825
|
+
> `optional` **authProcessorType?**: `string`
|
|
1757
1826
|
|
|
1758
1827
|
The type of auth processor to use on the API: entity-storage.
|
|
1759
1828
|
|
|
1760
1829
|
***
|
|
1761
1830
|
|
|
1762
|
-
### authSigningKeyId?
|
|
1831
|
+
### authSigningKeyId? {#authsigningkeyid}
|
|
1763
1832
|
|
|
1764
|
-
> `optional` **authSigningKeyId
|
|
1833
|
+
> `optional` **authSigningKeyId?**: `string`
|
|
1765
1834
|
|
|
1766
1835
|
The id of the key in the vault to use for signing in auth operations.
|
|
1767
1836
|
|
|
1768
1837
|
***
|
|
1769
1838
|
|
|
1770
|
-
###
|
|
1839
|
+
### hostingParamEncryptionKeyId? {#hostingparamencryptionkeyid}
|
|
1840
|
+
|
|
1841
|
+
> `optional` **hostingParamEncryptionKeyId?**: `string`
|
|
1842
|
+
|
|
1843
|
+
The id of the key in the vault to use for encrypting hosting parameters in auth operations.
|
|
1844
|
+
|
|
1845
|
+
***
|
|
1846
|
+
|
|
1847
|
+
### mimeTypeProcessors? {#mimetypeprocessors}
|
|
1771
1848
|
|
|
1772
|
-
> `optional` **mimeTypeProcessors
|
|
1849
|
+
> `optional` **mimeTypeProcessors?**: `string`
|
|
1773
1850
|
|
|
1774
1851
|
Additional MIME type processors to include, comma separated.
|
|
1775
1852
|
|
|
1776
1853
|
***
|
|
1777
1854
|
|
|
1778
|
-
### routeLoggingIncludeBody?
|
|
1855
|
+
### routeLoggingIncludeBody? {#routeloggingincludebody}
|
|
1779
1856
|
|
|
1780
|
-
> `optional` **routeLoggingIncludeBody
|
|
1857
|
+
> `optional` **routeLoggingIncludeBody?**: `string`
|
|
1781
1858
|
|
|
1782
1859
|
Include the body in the REST logging output, useful for debugging.
|
|
1783
1860
|
|
|
1784
1861
|
***
|
|
1785
1862
|
|
|
1786
|
-
### routeLoggingFullBase64?
|
|
1863
|
+
### routeLoggingFullBase64? {#routeloggingfullbase64}
|
|
1787
1864
|
|
|
1788
|
-
> `optional` **routeLoggingFullBase64
|
|
1865
|
+
> `optional` **routeLoggingFullBase64?**: `string`
|
|
1789
1866
|
|
|
1790
1867
|
Include the full base 64 output in the REST logging output, useful for debugging.
|
|
1791
1868
|
|
|
1792
1869
|
***
|
|
1793
1870
|
|
|
1794
|
-
### routeLoggingObfuscateProperties?
|
|
1871
|
+
### routeLoggingObfuscateProperties? {#routeloggingobfuscateproperties}
|
|
1795
1872
|
|
|
1796
|
-
> `optional` **routeLoggingObfuscateProperties
|
|
1873
|
+
> `optional` **routeLoggingObfuscateProperties?**: `string`
|
|
1797
1874
|
|
|
1798
1875
|
List of properties to obfuscate in the REST logging output, comma separated.
|