Class OnmsServerBuilder

A builder for OnmsServer. Create a new one with OnmsServer.newBuilder.

Hierarchy

OnmsServerBuilder

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new OnmsServerBuilder(url?: string): OnmsServerBuilder

- Defined in api/OnmsServer.ts:26
Construct a new builder from an existing options object, if provided.

Parameters
- Optional url: string
Returns OnmsServerBuilder

Accessors

auth

get auth(): OnmsAuthConfig

- Defined in api/OnmsServer.ts:92
Returns OnmsAuthConfig

metadata

get metadata(): ServerMetadata

- Defined in api/OnmsServer.ts:96
Returns ServerMetadata

name

get name(): string

- Defined in api/OnmsServer.ts:84
Returns string

url

get url(): string

- Defined in api/OnmsServer.ts:88
Returns string

Methods

build

build(): OnmsServer

- Defined in api/OnmsServer.ts:36
Build the OnmsServer object.

Returns OnmsServer

setAuth

setAuth(auth?: OnmsAuthConfig): this

- Defined in api/OnmsServer.ts:68
The authentication config to use when connecting.

If undefined is passed, the default authentication settings will be used.

Parameters
- Optional auth: OnmsAuthConfig
  
  the authentication config
Returns this

setMetadata

setMetadata(metadata?: ServerMetadata): this

- Defined in api/OnmsServer.ts:79
The server metadata to associate with the server.

If undefined is passed, no metadata will be used.

Parameters
- Optional metadata: ServerMetadata
  
  the metadata
Returns this

setName

setName(name?: string): this

- Defined in api/OnmsServer.ts:46
The display name of the server.

If undefined is passed, the name will be unset.

Parameters
- Optional name: string
  
  the server name
Returns this

setUrl

setUrl(url?: string): this

- Defined in api/OnmsServer.ts:57
The URL of the server.

If undefined is passed, the URL will be unset.

Parameters
- Optional url: string
  
  the server's URL
Returns this

Generated using TypeDoc