Lean  $LEAN_TAG$
QuantConnect.Data.SubscriptionDataSource Class Reference

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

Inheritance diagram for QuantConnect.Data.SubscriptionDataSource:
[legend]

Public Member Functions

 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...
 

Public Attributes

readonly string Source
 Identifies where to get the subscription's data from More...
 
readonly FileFormat Format
 Identifies the format of the data within the source More...
 
readonly SubscriptionTransportMedium TransportMedium
 Identifies the transport medium used to access the data, such as a local or remote file, or a polling rest API More...
 
readonly IReadOnlyList< KeyValuePair< string, string > > Headers
 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/3]

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

Initializes a new instance of the SubscriptionDataSource class.

Parameters
sourceThe subscription's data source location
transportMediumThe transport medium to be used to retrieve the subscription's data from the source

Definition at line 55 of file SubscriptionDataSource.cs.

◆ SubscriptionDataSource() [2/3]

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

Initializes a new instance of the SubscriptionDataSource class.

Parameters
sourceThe subscription's data source location
transportMediumThe transport medium to be used to retrieve the subscription's data from the source
formatThe format of the data within the source

Definition at line 66 of file SubscriptionDataSource.cs.

◆ SubscriptionDataSource() [3/3]

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
sourceThe subscription's data source location
transportMediumThe transport medium to be used to retrieve the subscription's data from the source
formatThe format of the data within the source
headersThe headers to be used for this source

Definition at line 79 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
otherAn object to compare with this object.

Definition at line 94 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
objThe object to compare with the current object.

<filterpriority>2</filterpriority>

Definition at line 110 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.

<filterpriority>2</filterpriority>

Definition at line 125 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
leftThe SubscriptionDataSource instance on the left of the operator
rightThe SubscriptionDataSource instance on the right of the operator
Returns
True if the two instances are considered equal, false otherwise

Definition at line 139 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
leftThe SubscriptionDataSource instance on the left of the operator
rightThe SubscriptionDataSource instance on the right of the operator
Returns
True if the two instances are not considered equal, false otherwise

Definition at line 150 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.

<filterpriority>2</filterpriority>

Definition at line 162 of file SubscriptionDataSource.cs.

Member Data Documentation

◆ Source

readonly string QuantConnect.Data.SubscriptionDataSource.Source

Identifies where to get the subscription's data from

Definition at line 33 of file SubscriptionDataSource.cs.

◆ Format

readonly FileFormat QuantConnect.Data.SubscriptionDataSource.Format

Identifies the format of the data within the source

Definition at line 38 of file SubscriptionDataSource.cs.

◆ TransportMedium

readonly SubscriptionTransportMedium QuantConnect.Data.SubscriptionDataSource.TransportMedium

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

Definition at line 43 of file SubscriptionDataSource.cs.

◆ Headers

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

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

Definition at line 48 of file SubscriptionDataSource.cs.


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