Represents the source location and transport medium for a subscription More...

Inheritance diagram for QuantConnect.Data.SubscriptionDataSource:

Public Member Functions
	SubscriptionDataSource (string source)
	Initializes a new instance of the SubscriptionDataSource class. More...

	SubscriptionDataSource (string source, SubscriptionTransportMedium transportMedium)
	Initializes a new instance of the SubscriptionDataSource class. More...

	SubscriptionDataSource (string source, SubscriptionTransportMedium transportMedium, FileFormat format)
	Initializes a new instance of the SubscriptionDataSource class. More...

	SubscriptionDataSource (string source, SubscriptionTransportMedium transportMedium, FileFormat format, IEnumerable< KeyValuePair< string, string >> headers)
	Initializes a new instance of the SubscriptionDataSource class with SubscriptionTransportMedium.Rest including the specified header values More...

bool	Equals (SubscriptionDataSource other)
	Indicates whether the current object is equal to another object of the same type. More...

override bool	Equals (object obj)
	Determines whether the specified instance is equal to the current instance. More...

override int	GetHashCode ()
	Serves as a hash function for a particular type. More...

override string	ToString ()
	Returns a string that represents the current object. More...

Static Public Member Functions
static bool	operator== (SubscriptionDataSource left, SubscriptionDataSource right)
	Indicates whether the current object is equal to another object of the same type. More...

static bool	operator!= (SubscriptionDataSource left, SubscriptionDataSource right)
	Indicates whether the current object is not equal to another object of the same type. More...

Properties
bool	Sort `[get, set]`
	Specifies whether the data source should be sorted. `If False`, data will be returned in the original order, `else` it will be ordered by time. More...

string	Source `[get]`
	Identifies where to get the subscription's data from More...

FileFormat	Format `[get]`
	Identifies the format of the data within the source More...

SubscriptionTransportMedium	TransportMedium `[get]`
	Identifies the transport medium used to access the data, such as a local or remote file, or a polling rest API More...

IReadOnlyList< KeyValuePair< string, string > >	Headers `[get]`
	Gets the header values to be used in the web request. More...

Detailed Description

Represents the source location and transport medium for a subscription

Definition at line 26 of file SubscriptionDataSource.cs.

Constructor & Destructor Documentation

◆ SubscriptionDataSource() [1/4]

QuantConnect.Data.SubscriptionDataSource.SubscriptionDataSource ( string source )

Initializes a new instance of the SubscriptionDataSource class.

Parameters

source The subscription's data source location

Definition at line 60 of file SubscriptionDataSource.cs.

◆ SubscriptionDataSource() [2/4]

QuantConnect.Data.SubscriptionDataSource.SubscriptionDataSource	(	string	source,
		SubscriptionTransportMedium	transportMedium
	)

Initializes a new instance of the SubscriptionDataSource class.

Parameters

source	The subscription's data source location
transportMedium	The transport medium to be used to retrieve the subscription's data from the source

Definition at line 70 of file SubscriptionDataSource.cs.

◆ SubscriptionDataSource() [3/4]

QuantConnect.Data.SubscriptionDataSource.SubscriptionDataSource	(	string	source,
		SubscriptionTransportMedium	transportMedium,
		FileFormat	format
	)

Initializes a new instance of the SubscriptionDataSource class.

Parameters

source	The subscription's data source location
transportMedium	The transport medium to be used to retrieve the subscription's data from the source
format	The format of the data within the source

Definition at line 81 of file SubscriptionDataSource.cs.

◆ SubscriptionDataSource() [4/4]

QuantConnect.Data.SubscriptionDataSource.SubscriptionDataSource	(	string	source,
		SubscriptionTransportMedium	transportMedium,
		FileFormat	format,
		IEnumerable< KeyValuePair< string, string >>	headers
	)

Initializes a new instance of the SubscriptionDataSource class with SubscriptionTransportMedium.Rest including the specified header values

Parameters

source	The subscription's data source location
transportMedium	The transport medium to be used to retrieve the subscription's data from the source
format	The format of the data within the source
headers	The headers to be used for this source

Definition at line 94 of file SubscriptionDataSource.cs.

Member Function Documentation

◆ Equals() [1/2]

bool QuantConnect.Data.SubscriptionDataSource.Equals ( SubscriptionDataSource other )

Indicates whether the current object is equal to another object of the same type.

Returns: true if the current object is equal to the other parameter; otherwise, false.

Parameters

other An object to compare with this object.

Definition at line 109 of file SubscriptionDataSource.cs.

Here is the caller graph for this function:

◆ Equals() [2/2]

override bool QuantConnect.Data.SubscriptionDataSource.Equals ( object obj )

Determines whether the specified instance is equal to the current instance.

Returns: true if the specified object is equal to the current object; otherwise, false.

Parameters

obj	The object to compare with the current object.

Definition at line 125 of file SubscriptionDataSource.cs.

Here is the call graph for this function:

◆ GetHashCode()

override int QuantConnect.Data.SubscriptionDataSource.GetHashCode ( )

Serves as a hash function for a particular type.

Returns: A hash code for the current T:System.Object.

Definition at line 140 of file SubscriptionDataSource.cs.

◆ operator==()

static bool QuantConnect.Data.SubscriptionDataSource.operator==	(	SubscriptionDataSource	left,
		SubscriptionDataSource	right
	)

static

Indicates whether the current object is equal to another object of the same type.

Parameters

left	The SubscriptionDataSource instance on the left of the operator
right	The SubscriptionDataSource instance on the right of the operator

Returns: True if the two instances are considered equal, false otherwise

Definition at line 154 of file SubscriptionDataSource.cs.

Here is the call graph for this function:

◆ operator!=()

static bool QuantConnect.Data.SubscriptionDataSource.operator!=	(	SubscriptionDataSource	left,
		SubscriptionDataSource	right
	)

static

Indicates whether the current object is not equal to another object of the same type.

Parameters

left	The SubscriptionDataSource instance on the left of the operator
right	The SubscriptionDataSource instance on the right of the operator

Returns: True if the two instances are not considered equal, false otherwise

Definition at line 165 of file SubscriptionDataSource.cs.

Here is the call graph for this function:

◆ ToString()

override string QuantConnect.Data.SubscriptionDataSource.ToString ( )

Returns a string that represents the current object.

Returns: A string that represents the current object.

Definition at line 177 of file SubscriptionDataSource.cs.

Property Documentation

◆ Sort

bool QuantConnect.Data.SubscriptionDataSource.Sort

getset

Specifies whether the data source should be sorted. If False, data will be returned in the original order, else it will be ordered by time.

Definition at line 34 of file SubscriptionDataSource.cs.

◆ Source

string QuantConnect.Data.SubscriptionDataSource.Source

get

Identifies where to get the subscription's data from

Definition at line 39 of file SubscriptionDataSource.cs.

◆ Format

FileFormat QuantConnect.Data.SubscriptionDataSource.Format

get

Identifies the format of the data within the source

Definition at line 44 of file SubscriptionDataSource.cs.

◆ TransportMedium

SubscriptionTransportMedium QuantConnect.Data.SubscriptionDataSource.TransportMedium

get

Identifies the transport medium used to access the data, such as a local or remote file, or a polling rest API

Definition at line 49 of file SubscriptionDataSource.cs.

◆ Headers

IReadOnlyList<KeyValuePair<string, string> > QuantConnect.Data.SubscriptionDataSource.Headers

get

Gets the header values to be used in the web request.

Definition at line 54 of file SubscriptionDataSource.cs.

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

Common/Data/SubscriptionDataSource.cs

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ SubscriptionDataSource() [1/4]

◆ SubscriptionDataSource() [2/4]

◆ SubscriptionDataSource() [3/4]

◆ SubscriptionDataSource() [4/4]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ operator==()

◆ operator!=()

◆ ToString()

Property Documentation

◆ Sort

◆ Source

◆ Format

◆ TransportMedium

◆ Headers