Network Adapter

This is an abstract class that contains logic for adapters that deal with data across a network. See GithubAdapter, ADLSAdapter, or RemoteAdapter for usage of this class. When extending this class, a CdmHttpClient has to be defined with the specified endpoint and callback function in the constructor. Then the class helper methods can be used to set up HTTP requests and read data. If Timeout, MaxmimumTimeout, or NumberOfRetries aren't specified, the default values for those properties that are specified in this class will be used.

public abstract class NetworkAdapter extends StorageAdapterBase

Properties

Name	Type	Description
AvoidRetryCodes	Set<HttpStatusCode>	A set of HttpStatusCodes that will stop the retry logic if the HTTP response has one of these types.
MaximumTimeout	TimeSpan?	The maximum timeout for all retried HTTP requests. The default value is 10000 ms.
NumberOfRetries	int	The maximum number of retries for an HTTP request. The default value is 2.
Timeout	TimeSpan?	The timeout for an HTTP request. The default value is 2000 ms.
WaitTimeCallback	CdmHttpClient.Callback	The wait time callback that gets called after each request is executed.

Methods

Name	Description	Return Type
UpdateNetworkConfig(string) config: A JSON string representing the configuration for the network adapter.	Updates the network specific properties on the network adapter using the specified configuration.	void
FetchNetworkConfig()	Constructs the network adapter's configuration. Returns a list of JProperty objects containing the network specific properties.	List<JProperty>
ExecuteRequest(CdmHttpRequest) httpRequest: The HTTP request to execute. read(...) in Python.	Executes an HTTP request and returns the response of the request.	Task<CdmHttpResponse>
Dispose() Only in C#.	Disposes the HTTP client. Exists only in C#.	void