SampleParameters Class

 Relativity Services API
Contains information about how the sampling is performed.
Inheritance Hierarchy
System.Object
  Relativity.Services.Objects.DataContracts.SampleParameters

Namespace:  Relativity.Services.Objects.DataContracts
Assembly:  Relativity.Services.Interfaces (in Relativity.Services.Interfaces.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax
Copy
public class SampleParameters

The SampleParameters type exposes the following members.

Constructors
  NameDescription
Public methodSampleParameters
Initializes a new instance of the SampleParameters class
Top
Properties
  NameDescription
Public propertyConfidenceLevel
Gets or sets a value for confidence level required for a sample set.
Public propertyExistingToken
Gets or sets the identifier for a sample set.
Public propertyFixedSampleSize
Gets or sets a value representing a specific number of items from a group used to create a randomized sample set.
Public propertyMarginOfError
Gets or sets a value for the margin of error allowable in sample results.
Public propertySamplingPercentage
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks
MarginOfError and ConfidenceLevel must both be provided for a statistical sample. If either is null, FixedSampleSize will be checked. If that is null, SamplingPercentage will then be checked. If none of those conditions are met, an exception will be thrown.
See Also

Reference

Relativity.Services.Objects.DataContracts Namespace