Class RelativityInstanceConfiguration

Represents the Relativity instance configuration.

Inheritance

System.Object

RelativityInstanceConfiguration

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Relativity.Testing.Framework.Configuration

Assembly: Relativity.Testing.Framework.dll

Syntax

public class RelativityInstanceConfiguration

Properties

AdminPassword

Gets or sets the password associated with AdminUsername.

Declaration

public string AdminPassword { get; set; }

Property Value

Type	Description
System.String

AdminUsername

Gets or sets the Realtivity admin (does not need to be an actual system admin) username that is used for API communication.

Declaration

public string AdminUsername { get; set; }

Property Value

Type	Description
System.String

RapDirectory

Gets or sets the directory to use for RAP installation.

Declaration

public string RapDirectory { get; set; }

Property Value

Type	Description
System.String

RelativityHostAddress

Gets or sets the Relativity host address. The fully-qualified host (hostname or hostname + port) of the machine hosting Relativity.

Declaration

public string RelativityHostAddress { get; set; }

Property Value

Type	Description
System.String

RestServicesHostAddress

Gets or sets the REST services host address. e.g. reg-a.r1.kcura.com If the value is not set, returns RelativityHostAddress.

Declaration

public string RestServicesHostAddress { get; set; }

Property Value

Type	Description
System.String

ResultsLocation

Gets or sets the location to save logs and screenshots to./>. Default is "Results".

Declaration

public string ResultsLocation { get; set; }

Property Value

Type	Description
System.String

RsapiServicesHostAddress

Gets or sets the RSAPI services host address. e.g. reg-a-services.r1.kcura.com If the value is not set, returns RelativityHostAddress.

Declaration

public string RsapiServicesHostAddress { get; set; }

Property Value

Type	Description
System.String

ServerBindingType

Gets or sets the type of the server binding. Is a protocol/schema used to connect with Relativity, e.g. HTTP or HTTPS.

Declaration

public string ServerBindingType { get; set; }

Property Value

Type	Description
System.String

SqlPassword

Gets or sets the password associated with SqlUsername.

Declaration

public string SqlPassword { get; set; }

Property Value

Type	Description
System.String

SqlServer

Gets or sets the locator for the instance of the SQL server to be used. e.g. RelativityInstanceName/EDDSINSTANCE001.

Declaration

public string SqlServer { get; set; }

Property Value

Type	Description
System.String

SqlUsername

Gets or sets the SQL username.

Declaration

public string SqlUsername { get; set; }

Property Value

Type	Description
System.String

WebApiHostAddress

Gets or sets the Web API host address. e.g. reg-a.r1.kcura.com If the value is not set, returns RelativityHostAddress.

Declaration

public string WebApiHostAddress { get; set; }

Property Value

Type	Description
System.String

Methods

MergeWithDefault(RelativityInstanceConfiguration)

Merges the default configuration settings into this instance. Each property of this instance having null will be set with the corresponding value of defaultConfiguration object.

Declaration

public RelativityInstanceConfiguration MergeWithDefault(RelativityInstanceConfiguration defaultConfiguration)

Parameters

Type	Name	Description
RelativityInstanceConfiguration	defaultConfiguration	The default configuration.

Returns

Type	Description
RelativityInstanceConfiguration	This instance.