| CloudConnector Class |
Connector for Apptus eSales when hosted in the cloud.
All requests to the eSales service are initiated by method calls to a
CloudConnector object, or an object obtained via the CloudConnector.
Use the GetOrCreate(String) or Get(String) method to obtain a CloudConnector object.
Inheritance HierarchyNamespace: Apptus.ESales.Connector
Assembly: Apptus.Esales.ConnectorApi (in Apptus.Esales.ConnectorApi.dll) Version: 4.5.0
SyntaxC#
public class CloudConnector : Connector
The CloudConnector type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AvailableMarkets |
Returns a list of available markets from the eSales cluster. Never returns null.
(Inherited from Connector.) |
| CheckCustomerDataJobStatus |
Check the status of a GDPR customer data job.
(Inherited from Connector.) |
| CreateExportCustomerDataJob |
Start a GDPR job on the cluster to export all data related to the given customer key.
"Linked" customer keys will also be exported(i.e.customer keys that have been notified in the same session).
Status of the job can be checked with {@link #checkCustomerDataJobStatus(String)} and when the status is
, the resulting zip file can be downloaded using
(Inherited from Connector.) |
| CreateRemoveCustomerDataJob |
Start a GDPR job on the cluster to remove all data related to the given customer key.
Data will be removed both from memory and disk.
"Linked" customer keys will also be removed(i.e.customer keys that have been notified in the same session).
(Inherited from Connector.) |
| DownloadExportCustomerDataJobResult(String) |
Download the result of a GDPR export customer data job.
(Inherited from Connector.) |
| DownloadExportCustomerDataJobResult(String, String) |
Download the result of a GDPR export customer data job.
(Inherited from Connector.) |
| Equals | (Inherited from Object.) |
| ExportAds |
Exports ad data from the eSales cluster by returning a stream to the caller.
(Inherited from Connector.) |
| ExportAds(String) |
Exports ad data from the eSales cluster to the specified destinationFile.
(Inherited from Connector.) |
| ExportConfiguration |
Exports esales configuration from the eSales cluster by returning a stream to the caller.
(Inherited from Connector.) |
| ExportConfiguration(String) |
Exports esales configuration from the eSales cluster to the specified destinationFile.
(Inherited from Connector.) |
| ExportPanels |
Exports panel configuration from the eSales cluster by returning a stream to the caller.
(Inherited from Connector.) |
| ExportPanels(String) |
Exports panel configuration from the eSales cluster to the specified destinationFile.
(Inherited from Connector.) |
| ExportProducts |
Exports product data from the eSales cluster by returning a stream to the caller.
(Inherited from Connector.) |
| ExportProducts(String) |
Exports product data from the eSales cluster to the specified destinationFile.
(Inherited from Connector.) |
| ExportProducts(String, String) | Returns an IEnumerable ProductStreamer that allows you to do filtered product exports, conveniently parsed into ResultProduct items. Every new iteration on this class will result in a new request to eSales. Note that the IEnumerator returned by its GetEnumerator method must be disposed when done, but this is done automatically when using foreach iteration. Note that while iterating, imports will be blocked from completing on a selected eSales server. Imports will not fail but will wait for the iteration to finish. This means that if you fail to close the ProductStreamer you might block imports indefinitely! |
| ExportSynonyms |
Exports synonym data from the eSales cluster by returning a stream to the caller.
(Inherited from Connector.) |
| ExportSynonyms(String) |
Exports synonym data from the eSales cluster to the specified destinationFile.
(Inherited from Connector.) |
 | Finalize | (Inherited from Object.) |
 | Get(String) | Gets a connector with enabled asynchronous health checks and cluster lookup requests, provided a URL specifying the controller of an eSales cluster. The URL should be on the format esales://<username>:<password>, e.g. esales://username:password. Valid query parameters are: connection_timeout - The connection timeout in milliseconds, default 2000. query_timeout - The query timeout in milliseconds, default 3000. export_timeout - The export timeout in milliseconds, default 60000. import_timeout - The import timeout in milliseconds, default 600000. notification_timeout - The notification timeout in milliseconds, default 3000. report_timeout - The report timeout in milliseconds, default 120000 (2 minutes). health_check_timeout - The health check timeout in milliseconds, default is 500 compression_mode - what compression should be used when sending imports. Available settings: none - No compression. gzip - Compress with GZIP. This is the default. pre_compressed_gzip - Send headers to indicate the import is compressed with GZIP, but don't do any compression. Use this if the file or InputStream you supply is already compressed. Note that files with names that end with ".gz" or ".gzip" will behave as if compression_mode= pre_compressed_gzip, regardless of what compression_mode is actually set to. |
| Get(String, Boolean) | Gets a connector, provided a URL specifying the controller of an eSales cluster. The URL should be on the format esales://<username>:<password>, e.g. esales://username:password. Valid query parameters are: connection_timeout - The connection timeout in milliseconds, default 2000. query_timeout - The query timeout in milliseconds, default 3000. export_timeout - The export timeout in milliseconds, default 60000. import_timeout - The import timeout in milliseconds, default 600000. notification_timeout - The notification timeout in milliseconds, default 3000. report_timeout - The report timeout in milliseconds, default 120000 (2 minutes). health_check_timeout - The health check timeout in milliseconds, default is 500 compression_mode - what compression should be used when sending imports. Available settings: none - No compression. gzip - Compress with GZIP. This is the default. pre_compressed_gzip - Send headers to indicate the import is compressed with GZIP, but don't do any compression. Use this if the file or InputStream you supply is already compressed. Note that files with names that end with ".gz" or ".gzip" will behave as if compression_mode= pre_compressed_gzip, regardless of what compression_mode is actually set to. |
| GetHashCode | (Inherited from Object.) |
| GetOrCreate(String) | Gets a connector, provided a URL specifying the controller of an eSales cluster. A new connector will be created if a connector for the URI already exists but created by calling GetOrCreate(url, false). Connector created by this method will use System.Threading.ThreadPool for health checks of unavailable servers in the cluster and cluster lookup requests. The URL should be on the format esales://<username>:<password>, e.g. esales://username:password. Valid query parameters are: connection_timeout - The connection timeout in milliseconds, default 2000. query_timeout - The query timeout in milliseconds, default 3000. export_timeout - The export timeout in milliseconds, default 60000. import_timeout - The import timeout in milliseconds, default 600000. notification_timeout - The notification timeout in milliseconds, default 3000. report_timeout - The report timeout in milliseconds, default 120000 (2 minutes). compression_mode - what compression should be used when sending imports. Available settings: none - No compression. gzip - Compress with GZIP. This is the default. pre_compressed_gzip - Send headers to indicate the import is compressed with GZIP, but don't do any compression. Use this if the file or InputStream you supply is already compressed. Note that files with names that end with ".gz" or ".gzip" will behave as if compression_mode= pre_compressed_gzip, regardless of what compression_mode is actually set to. |
| GetOrCreate(String, Boolean) | Gets a connector, provided a URL specifying the controller of an eSales cluster. A new connector will be created if a connector for the URI already exists but created with a different asyncHealthCheck flag value. System.Threading.ThreadPool will be used if asyncHealthCheck flag is true. The URL should be on the format esales://<username>:<password>, e.g. esales://username:password. Valid query parameters are: connection_timeout - The connection timeout in milliseconds, default 2000. query_timeout - The query timeout in milliseconds, default 3000. export_timeout - The export timeout in milliseconds, default 60000. import_timeout - The import timeout in milliseconds, default 600000. notification_timeout - The notification timeout in milliseconds, default 3000. report_timeout - The report timeout in milliseconds, default 120000 (2 minutes). compression_mode - what compression should be used when sending imports. Available settings: none - No compression. gzip - Compress with GZIP. This is the default. pre_compressed_gzip - Send headers to indicate the import is compressed with GZIP, but don't do any compression. Use this if the file or InputStream you supply is already compressed. Note that files with names that end with ".gz" or ".gzip" will behave as if compression_mode= pre_compressed_gzip, regardless of what compression_mode is actually set to. |
| GetType | (Inherited from Object.) |
| Import(IInputSource, String, String, CompressionMode) | (Inherited from Connector.) |
| Import(IInputSource, String, String, CompressionMode, NullableBoolean) | (Inherited from Connector.) |
| ImportAds(Stream, String) |
Imports ads from the specified stream to the eSales cluster.
(Inherited from Connector.) |
| ImportAds(String, String) |
Imports ads from the specified importFile to the eSales cluster.
(Inherited from Connector.) |
| ImportConfiguration(Stream, String) |
Imports configuration from the specified stream to the eSales cluster.
(Inherited from Connector.) |
| ImportConfiguration(String, String) |
Imports configuration from the specified importFile to the eSales cluster.
(Inherited from Connector.) |
| ImportPanels(Stream, String) |
Imports panels from the specified stream to the eSales cluster.
(Inherited from Connector.) |
| ImportPanels(String, String) |
Imports panels from the specified importFile to the eSales cluster.
(Inherited from Connector.) |
| ImportProducts(Stream, String) |
Imports products from the specified stream to the eSales cluster.
(Inherited from Connector.) |
| ImportProducts(String, String) |
Imports products from the specified importFile to the eSales cluster.
(Inherited from Connector.) |
| ImportProducts(Stream, String, NullableBoolean) |
Imports products from the specified stream to the eSales cluster.
(Inherited from Connector.) |
| ImportProducts(String, String, NullableBoolean) |
Imports products from the specified importFile to the eSales cluster.
(Inherited from Connector.) |
| ImportStream(Stream, String, String, String) | (Inherited from Connector.) |
| ImportStream(Stream, String, String, String, NullableBoolean) | (Inherited from Connector.) |
| ImportSynonyms(Stream, String) |
Imports synonyms from the specified stream to the eSales cluster.
(Inherited from Connector.) |
| ImportSynonyms(String, String) |
Imports synonyms from the specified importFile to the eSales cluster.
(Inherited from Connector.) |
| LatestNotifications |
Returns the last 100 notifications received by the eSales cluster.
(Inherited from Connector.) |
| LatestNotifications(String) |
Returns the last 100 notifications received by the eSales cluster.
(Inherited from Connector.) |
| MemberwiseClone | (Inherited from Object.) |
| Reporter |
Creates a reporter for a market during a specified time interval.
The reporter can be used to fetch reports from the eSales cluster.
(Inherited from Connector.) |
| ReporterForUnknownMarket |
Creates a reporter for the unknown market (sessions without a market property),
during a specified time interval.
The reporter can be used to fetch reports from the eSales cluster.
(Inherited from Connector.) |
| ServerLog |
Gets a log from a server. Server index should be an index in the range [0, number_of_servers - 1]. The servers are indexed in
the same order as they appear in the cluster string. The server indexes can also be retrieved from the status command.
Name is the name of a log. Available log names can be retrieved from ServerLogNames.
(Inherited from Connector.) |
| ServerLogNames |
Gets a list of available log names.
(Inherited from Connector.) |
| Session(String) | Obsolete.
Gets a session for the specified sessionKey.
(Inherited from Connector.) |
| Session(String, String, String) |
Creates a session for the specified session key with the specified customer key and market.
Calling this method does not affect the session in the eSales server.
A notification or panel query, on the object created by this method,
is necessary for the properties to stick to the session.
When calling this method with null in place of customerKey and/or market,
the server will keep the current values of these properties for this session.
(Inherited from Connector.) |
| Status |
Returns a status report from the eSales cluster as an XML document.
(Inherited from Connector.) |
| ToString | (Inherited from Object.) |
See Also