Cloud Connector API  version 3.5.1001.64485
API for managing and configuring the Cloud Connector
IServiceConfiguration Interface Reference

Configuration that is common for all service types. More...

+ Inheritance diagram for IServiceConfiguration:

Properties

string Version [get]
 Gets the configuration version. This is updated every time the configuration is saved. More...
 
IOrganization Organization [get]
 Gets the organization that the configuration belongs to. More...
 
bool FullSyncEnabled [get, set]
 Gets or sets a value indicating whether full synchronization is enabled. More...
 
string FullSyncCronSchedule [get, set]
 Gets or sets the full synchronization schedule in cron like format. More...
 
uint IncrementalSyncInterval [get, set]
 Gets or sets the incremental synchronization interval specified in seconds. More...
 
uint FailoverInterval [get, set]
 Gets or sets the Cloud Connector fail-over interval specified in seconds. More...
 
LogLevel LogLevel [get, set]
 Gets or sets the log level to use for Cloud Connector logging. This is used by the Connector Service to decide which log messages to send back to the Cloud Connector. More...
 
Mode ServiceMode [get]
 Gets the service mode. More...
 
IList< IConnectorTypeConnectors [get]
 Gets a list of registered connectors. More...
 
int AttrExprMetaVersion [get]
 Attribute mapping expression version number More...
 

Detailed Description

Configuration that is common for all service types.

Property Documentation

int AttrExprMetaVersion
get

Attribute mapping expression version number

IList<IConnectorType> Connectors
get

Gets a list of registered connectors.

This collection is read-only, items cannot be added or removed. All connector fields except Name are read only.

uint FailoverInterval
getset

Gets or sets the Cloud Connector fail-over interval specified in seconds.

This specifies the amount of time that the Connector Service should wait before considering the Cloud Connector unavailable and give tasks to a different Cloud Connector.

string FullSyncCronSchedule
getset

Gets or sets the full synchronization schedule in cron like format.

See http://www.quartz-scheduler.org/docs/tutorials/crontrigger.html for Quartz format.

bool FullSyncEnabled
getset

Gets or sets a value indicating whether full synchronization is enabled.

uint IncrementalSyncInterval
getset

Gets or sets the incremental synchronization interval specified in seconds.

This specifies the time that elapses between automatic incremental synchronizations

Gets or sets the log level to use for Cloud Connector logging. This is used by the Connector Service to decide which log messages to send back to the Cloud Connector.

IOrganization Organization
get

Gets the organization that the configuration belongs to.

Mode ServiceMode
get

Gets the service mode.

This indicates whether the service is enabled, disabled or paused.

Changing the mode can be done using the SetServiceMode action, see IServiceContext.SetServiceMode. Mode is also returned in the service info (monitoring).

string Version
get

Gets the configuration version. This is updated every time the configuration is saved.

Used by the service to determine if another admin has made a concurrent modification to the configuration. If a client sends a configuration update with a version that is different than the currently stored version, the service will reject the configuration update. If the version is the same, the service stores the configuration with a new version number. Clients can also use this to detect if the configuration has changed.


The documentation for this interface was generated from the following file: