Syncthing¶
Table of Contents¶
1. Remote Procedure Calls
Name | Description |
---|---|
retrieveConfiguration |
No description |
resetConfiguration |
No description |
restart |
No description |
updateConfiguration |
No description |
2. Data Models
Name | Description |
---|---|
SyncthingConfig |
No description |
SyncthingConfig.Device |
No description |
SyncthingConfig.Folder |
No description |
SyncthingConfig.OrchestratorInfo |
No description |
IAppsResetConfigRequest |
No description |
IAppsRestartRequest |
No description |
IAppsRetrieveConfigRequest |
No description |
IAppsUpdateConfigRequest |
No description |
IAppsResetConfigResponse |
No description |
IAppsRestartResponse |
No description |
IAppsRetrieveConfigResponse |
No description |
IAppsUpdateConfigResponse |
No description |
Remote Procedure Calls¶
retrieveConfiguration
¶
Request | Response | Error |
---|---|---|
IAppsRetrieveConfigRequest<SyncthingConfig> |
IAppsRetrieveConfigResponse<SyncthingConfig> |
CommonErrorMessage |
resetConfiguration
¶
Request | Response | Error |
---|---|---|
IAppsResetConfigRequest<SyncthingConfig> |
IAppsResetConfigResponse<SyncthingConfig> |
CommonErrorMessage |
restart
¶
Request | Response | Error |
---|---|---|
IAppsRestartRequest<SyncthingConfig> |
IAppsRestartResponse<SyncthingConfig> |
CommonErrorMessage |
updateConfiguration
¶
Request | Response | Error |
---|---|---|
IAppsUpdateConfigRequest<SyncthingConfig> |
IAppsUpdateConfigResponse<SyncthingConfig> |
CommonErrorMessage |
Data Models¶
SyncthingConfig
¶
data class SyncthingConfig(
val folders: List<SyncthingConfig.Folder>,
val devices: List<SyncthingConfig.Device>,
val orchestratorInfo: SyncthingConfig.OrchestratorInfo?,
)
Properties
folders
: List<SyncthingConfig.Folder>
List<SyncthingConfig.Folder>
devices
: List<SyncthingConfig.Device>
List<SyncthingConfig.Device>
orchestratorInfo
: SyncthingConfig.OrchestratorInfo?
SyncthingConfig.OrchestratorInfo?
SyncthingConfig.Device
¶
data class Device(
val deviceId: String,
val label: String,
)
SyncthingConfig.Folder
¶
data class Folder(
val ucloudPath: String,
val path: String?,
val id: String?,
)
SyncthingConfig.OrchestratorInfo
¶
data class OrchestratorInfo(
val folderPathToPermission: JsonObject,
)
Properties
folderPathToPermission
: JsonObject
JsonObject
IAppsResetConfigRequest
¶
data class IAppsResetConfigRequest<ConfigType>(
val provider: String,
val productId: String,
val expectedETag: String?,
)
IAppsRestartRequest
¶
data class IAppsRestartRequest<ConfigType>(
val provider: String,
val productId: String,
)
IAppsRetrieveConfigRequest
¶
data class IAppsRetrieveConfigRequest<ConfigType>(
val provider: String,
val productId: String,
)
IAppsUpdateConfigRequest
¶
data class IAppsUpdateConfigRequest<ConfigType>(
val provider: String,
val productId: String,
val config: ConfigType,
val expectedETag: String?,
)
IAppsResetConfigResponse
¶
data class IAppsResetConfigResponse<ConfigType>(
)
Properties
IAppsRestartResponse
¶
data class IAppsRestartResponse<ConfigType>(
)
Properties
IAppsRetrieveConfigResponse
¶
data class IAppsRetrieveConfigResponse<ConfigType>(
val etag: String,
val config: ConfigType,
)
IAppsUpdateConfigResponse
¶
data class IAppsUpdateConfigResponse<ConfigType>(
)