# NominalClientBuilder

## pub struct NominalClientBuilder

Builds a [`NominalClient`](https://dev.nominal.io/rust-client/ref/rust/nominal/struct.NominalClient.md "nominal::NominalClient") when callers need to customize optional client settings.

The default base URL is `https://api.gov.nominal.io/api`, and the default
user agent is `nominal-rust/<crate version>`.

## Implementations

### impl NominalClientBuilder

#### pub fn from_profile_config(profile: &Profile) -> Self

#### pub fn base_url(self, base_url: impl Into<String>) -> Self

Override the default base URL.

#### pub fn workspace_rid(self, workspace_rid: Option<String>) -> Self

#### pub fn user_agent(self, name: &str, version: &str) -> Self

Override the default `User-Agent` value.

The generated header starts with `name/version`. [`Self::build`](https://dev.nominal.io/rust-client/ref/rust/nominal/struct.NominalClientBuilder.md#method.build "nominal::NominalClientBuilder::build") returns
[`Error::InvalidUserAgent`](https://dev.nominal.io/rust-client/ref/rust/nominal/error/enum.Error.md#variant.InvalidUserAgent "nominal::error::Error::InvalidUserAgent") unless the name and version satisfy `ProductAgent::new`.

#### pub fn build(self) -> Result<NominalClient>

## Trait implementations

**Auto traits**: [`Send`](https://doc.rust-lang.org/1.98.1/core/marker/trait.Send.html), [`Sync`](https://doc.rust-lang.org/1.98.1/core/marker/trait.Sync.html), [`Unpin`](https://doc.rust-lang.org/1.98.1/core/marker/trait.Unpin.html), [`UnwindSafe`](https://doc.rust-lang.org/1.98.1/core/panic/unwind_safe/trait.UnwindSafe.html), [`RefUnwindSafe`](https://doc.rust-lang.org/1.98.1/core/panic/unwind_safe/trait.RefUnwindSafe.html)
