Class HttpStructuredStoreConfiguration

Configuration for an HttpStructuredStore.

Inheritance
object
HttpStructuredStoreConfiguration
Inherited Members
Namespace: Serenity.StructuredPersistence.Infrastructure.Http
Assembly: Serenity.StructuredPersistence.Http.dll
Syntax
public sealed class HttpStructuredStoreConfiguration

Constructors

HttpStructuredStoreConfiguration(string, string, int)

Creates a new HttpStructuredStoreConfiguration with the specified settings.

Declaration
public HttpStructuredStoreConfiguration(string baseUrl, string apiKey, int timeoutSeconds)
Parameters
Type Name Description
string baseUrl

Base URL of the remote structured-store service. Cannot be null or empty.
string apiKey

API key sent via the Authorization header, or null/empty for none.
int timeoutSeconds

Per-call timeout, in seconds. Zero or a negative value falls back to a 10-second default.
Exceptions
Type Condition
ArgumentException

Thrown when baseUrl is null, empty, or whitespace.

Properties

ApiKey

API key sent as an Authorization: Bearer {ApiKey} header on every request. Null or empty means no Authorization header is sent.

Declaration
public string ApiKey { get; }
Property Value
Type Description
string

BaseUrl

Base URL of the remote structured-store service (e.g. https://store.example.com/api), with any trailing slash removed.

Declaration
public string BaseUrl { get; }
Property Value
Type Description
string

TimeoutSeconds

Per-call timeout, in seconds. Always at least one second.

Declaration
public int TimeoutSeconds { get; }
Property Value
Type Description
int