Class XpingConfigurationBuilder

Namespace

Xping.Sdk.Core.Configuration

Assembly

Xping.Sdk.Core.dll

Provides a fluent API for building XpingConfiguration instances.

public sealed class XpingConfigurationBuilder

Inheritance

object

XpingConfigurationBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Build()

Builds the configuration instance.

public XpingConfiguration Build()

Returns

XpingConfiguration

The configured XpingConfiguration instance.

Exceptions

InvalidOperationException

Thrown when the configuration is invalid.

TryBuild(out XpingConfiguration?, out string[])

Attempts to build the configuration instance without throwing exceptions.

public bool TryBuild(out XpingConfiguration? configuration, out string[] errors)

Parameters

configuration XpingConfiguration

The built configuration if successful.

errors string[]

The validation errors if unsuccessful.

Returns

bool

true if the configuration is valid; otherwise, false.

WithApiEndpoint(string)

Sets the API endpoint URL.

public XpingConfigurationBuilder WithApiEndpoint(string apiEndpoint)

Parameters

apiEndpoint string

The API endpoint URL.

Returns

XpingConfigurationBuilder

The builder instance for method chaining.

WithApiKey(string)

Sets the API key for authentication.

public XpingConfigurationBuilder WithApiKey(string apiKey)

Parameters

apiKey string

The API key.

Returns

XpingConfigurationBuilder

The builder instance for method chaining.

WithAutoDetectCIEnvironment(bool)

Sets whether to automatically detect CI/CD environments.

public XpingConfigurationBuilder WithAutoDetectCIEnvironment(bool autoDetect)

Parameters

autoDetect bool

Whether to auto-detect CI environments.

Returns

XpingConfigurationBuilder

The builder instance for method chaining.

WithBatchSize(int)

Sets the batch size for uploading test executions.

public XpingConfigurationBuilder WithBatchSize(int batchSize)

Parameters

batchSize int

The batch size.

Returns

XpingConfigurationBuilder

The builder instance for method chaining.

WithCaptureStackTraces(bool)

Sets whether to capture stack traces for failed tests.

public XpingConfigurationBuilder WithCaptureStackTraces(bool captureStackTraces)

Parameters

captureStackTraces bool

Whether to capture stack traces.

Returns

XpingConfigurationBuilder

The builder instance for method chaining.

WithCollectNetworkMetrics(bool)

Sets whether to collect network reliability metrics.

public XpingConfigurationBuilder WithCollectNetworkMetrics(bool collectNetworkMetrics)

Parameters

collectNetworkMetrics bool

Whether to collect network metrics.

Returns

XpingConfigurationBuilder

The builder instance for method chaining.

WithEnableCompression(bool)

Sets whether to enable compression for uploads.

public XpingConfigurationBuilder WithEnableCompression(bool enableCompression)

Parameters

enableCompression bool

Whether to enable compression.

Returns

XpingConfigurationBuilder

The builder instance for method chaining.

WithEnabled(bool)

Sets whether the SDK is enabled.

public XpingConfigurationBuilder WithEnabled(bool enabled)

Parameters

enabled bool

Whether the SDK is enabled.

Returns

XpingConfigurationBuilder

The builder instance for method chaining.

WithEnvironment(string)

Sets the environment name.

public XpingConfigurationBuilder WithEnvironment(string environment)

Parameters

environment string

The environment name.

Returns

XpingConfigurationBuilder

The builder instance for method chaining.

WithFlushInterval(TimeSpan)

Sets the flush interval for automatically uploading batches.

public XpingConfigurationBuilder WithFlushInterval(TimeSpan flushInterval)

Parameters

flushInterval TimeSpan

The flush interval.

Returns

XpingConfigurationBuilder

The builder instance for method chaining.

WithMaxRetries(int)

Sets the maximum number of retry attempts for failed uploads.

public XpingConfigurationBuilder WithMaxRetries(int maxRetries)

Parameters

maxRetries int

The maximum number of retries.

Returns

XpingConfigurationBuilder

The builder instance for method chaining.

WithProjectId(string)

Sets the project ID.

public XpingConfigurationBuilder WithProjectId(string projectId)

Parameters

projectId string

The project ID.

Returns

XpingConfigurationBuilder

The builder instance for method chaining.

WithRetryDelay(TimeSpan)

Sets the delay between retry attempts.

public XpingConfigurationBuilder WithRetryDelay(TimeSpan retryDelay)

Parameters

retryDelay TimeSpan

The retry delay.

Returns

XpingConfigurationBuilder

The builder instance for method chaining.

WithSamplingRate(double)

Sets the sampling rate.

public XpingConfigurationBuilder WithSamplingRate(double samplingRate)

Parameters

samplingRate double

The sampling rate (0.0 to 1.0).

Returns

XpingConfigurationBuilder

The builder instance for method chaining.

WithUploadTimeout(TimeSpan)

Sets the timeout for upload operations.

public XpingConfigurationBuilder WithUploadTimeout(TimeSpan uploadTimeout)

Parameters

uploadTimeout TimeSpan

The upload timeout.

Returns

XpingConfigurationBuilder

The builder instance for method chaining.