SourceProfile class | QSYS API Reference Guide

Estimated reading time: 8 minutes

The SourceProfile class represents a profile in the source system.

Namespace: ASNA.DataGate.Providers Assembly: ASNA.QSys.DataGate.Client.dll

Inheritance: Object

Remarks

This class is used to map the profile data from the source system to the target system.

Constructors

Name	Description
SourceProfile()	Initializes a new instance of the class with default values.
SourceProfile(SourceProfile)	Initializes a new instance of the class with the specified source profile.

SourceProfile()

Initializes a new instance of the class with default values.

SourceProfile()

SourceProfile(SourceProfile)

Initializes a new instance of the class with the specified source profile.

SourceProfile(SourceProfile)

Parameters

Type	Parameter name	Description
SourceProfile	sp	The source profile to initialize the new instance with.

Properties

Type	Name	Description
ITransformProperties	AltDecoderProps	Gets or sets the alternative decoder properties for the source profile.
ITransformProperties	AltEncoderProps	Gets or sets the alternative encoder properties for the source profile.
String	AltEncodingName	Alternative character encoding string identifiers must becase-insensitive in the invariant culture.
IDataGateCredential	Credential	Gets or sets the credentials for the source profile.
String	DGPLATFORM	Constant for the DataLink platform attribute.
IEnumerable<String>	InitialLibraryList	Get or Set initial library list
Boolean	IsSqlClientPlatform	Gets a value indicating whether the platform attribute of the source profile is SQL Client-based.
Boolean	IsSqlPlatform	Gets a value indicating whether the platform attribute of the source profile is SQL-based.
String	Label	Get or Set label name
String	PlatformAttribute	Gets or sets the platform attribute for the source profile.
Byte	PoolingTimeout	Gets or sets the pooling timeout for the source profile.
Int32	Port	Gets or sets the port for the source profile.
String	Server	Get or Set server name
String	ServicePrincipalName	Gets or sets the Service Principal Name (SPN) for the source profile.
String	SQLCLIENTPLATFORM	Constant for the SQL Client platform attribute.
String	SQLOLEDBPLATFORM	Constant for the SQL OLE DB platform attribute.
String	SslCertificateName	Gets or sets the SSL certificate name for the source profile.
SslOptions	SslOptions	Gets or sets the SSL options for the source profile.
String	Text	Gets or sets the text associated with the source profile.

Methods

Signature	Description
Clone()	Creates a new object that is a copy of the current instance.
Equals(SourceProfile)	Determines whether the current instance of is equal to the specified instance.
Equals(Object)	Determines whether the current instance of is equal to the specified instance.
Equals(Object, Boolean)	Determines whether the current instance of is equal to the specified object.
GetHashCode()	Serves as the default hash function.
IsKnownPlatformAttribute(String)	Determines whether the provided platform attribute is a known platform attribute.
op_Equality(SourceProfile, SourceProfile)	Determines whether two instances of are equal.
op_Inequality(SourceProfile, SourceProfile)	Determines whether two instances of are not equal.
ToString()	Returns a string that represents the current SourceProfile.

object Clone()

Creates a new object that is a copy of the current instance.

Remarks

This method is used to create a copy of the current instance of the SourceProfile class. The copy is made by calling the Copy method with a new instance of the SourceProfile class and the current instance as parameters.

object Clone()

bool Equals(SourceProfile other)

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

Remarks

This method is used to compare the current instance with another instance of the SourceProfile class. The comparison is based on the properties of the instances.

bool Equals(SourceProfile other)

Parameters

Type	Parameter name	Description
SourceProfile	other	The instance to compare with the current instance.

Returns

Type	Description
Boolean	True if the current instance is equal to the specified instance; otherwise, false.

bool Equals(object other)

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

bool Equals(object other)

Parameters

Type	Parameter name	Description
Object	other	The instance to compare with the current instance.

Returns

Type	Description
Boolean	True if the current instance is equal to the specified instance; otherwise, false.

bool Equals(object obj, bool bIgnoreDatabaseName)

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

Remarks

This method is used to compare the current instance with another object of the same type. If the bIgnoreDatabaseName parameter is set to true, the comparison will ignore the database name.

bool Equals(object obj, bool bIgnoreDatabaseName)

Parameters

Type	Parameter name	Description
Object	obj	The object to compare with the current instance.
Boolean	bIgnoreDatabaseName	A boolean value that indicates whether to ignore the database name in the comparison.

Returns

Type	Description
Boolean	True if the current instance is equal to the specified object; otherwise, false.

int GetHashCode()

Serves as the default hash function.

Remarks

This method is used to generate a hash code for the current instance of the SourceProfile class. It takes into account all the properties of the class to generate a unique hash code.

int GetHashCode()

bool IsKnownPlatformAttribute(string platformAttr)

Determines whether the provided platform attribute is a known platform attribute.

Remarks

This method is used to validate that the platform attribute provided is one that the system recognizes and can handle.

bool IsKnownPlatformAttribute(string platformAttr)

Parameters

Type	Parameter name	Description
String	platformAttr	The platform attribute to check.

Returns

Type	Description
Boolean	True if the provided platform attribute is a known platform attribute; otherwise, false.

bool op_Equality(SourceProfile x, SourceProfile y)

Determines whether two instances of are equal.

bool op_Equality(SourceProfile x, SourceProfile y)

Parameters

Type	Parameter name	Description
SourceProfile	x	The first instance to compare.
SourceProfile	y	The second instance to compare.

Returns

Type	Description
Boolean	True if the instances are equal; otherwise, false.

bool op_Inequality(SourceProfile x, SourceProfile y)

Determines whether two instances of are not equal.

bool op_Inequality(SourceProfile x, SourceProfile y)

Parameters

Type	Parameter name	Description
SourceProfile	x	The first instance to compare.
SourceProfile	y	The second instance to compare.

Returns

Type	Description
Boolean	True if the instances are not equal; otherwise, false.

string ToString()

Returns a string that represents the current SourceProfile.

Remarks

This method overrides the base ToString method and provides a string representation of the SourceProfile, typically including key properties of the SourceProfile for debugging or logging purposes.

string ToString()

Examples

Example: Using a Constructor

  SourceProfile newDbProfile = new SourceProfile();
  newDbProfile.Server = "valid ip address";
  newDbProfile.User = "User1";
  newDbProfile.Password = "password"; /* Note- not very secure. */
  newDbProfile.Port = 5047;
  newDbProfile.PoolingTimeout = 0;
  newDbProfile.PlatformAttribute = "*DATALINK";
  newDbProfile.Text = "New database at valid ip address, on port 5047.";

Example : Using a Constructor with an existing Source Profile.

  /* This creates a brand new database name using the
   * old source profile.*/
  SourceProfile newDbProfile2 = new SourceProfile(sp);