Server class abstract

An object representing a Server.

This class encapsulates the data for a server definition in an OpenAPI document, including its URL, description, and any variables.

Available extensions
Annotations
  • @Freezed(copyWith: true, fromJson: true, toJson: true, equal: true)

Constructors

Server.new({required String url, String? description, Map<String, dynamic>? variables})
Creates a Server object.
const
factory
Server.fromJson(Map<String, dynamic> json)
Creates a Server from a JSON object.
factory

Properties

copyWith → $ServerCopyWith<Server>
Create a copy of Server with the given fields replaced by the non-null parameter values.
no setterinherited
description → String?
A brief description of the server.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
url → String
A URL to the target host.
no setterinherited
variables → Map<String, dynamic>?
A map of server variables for URL templating.
no setterinherited

Methods

map<TResult extends Object?>(TResult $default(_Server value)) → TResult

Available on Server, provided by the ServerPatterns extension

A switch-like method, using callbacks.
mapOrNull<TResult extends Object?>(TResult? $default(_Server value)?) → TResult?

Available on Server, provided by the ServerPatterns extension

A variant of map that fallback to returning null.
maybeMap<TResult extends Object?>(TResult $default(_Server value)?, {required TResult orElse()}) → TResult

Available on Server, provided by the ServerPatterns extension

A variant of map that fallback to returning orElse.
maybeWhen<TResult extends Object?>(TResult $default(String url, String? description, Map<String, dynamic>? variables)?, {required TResult orElse()}) → TResult

Available on Server, provided by the ServerPatterns extension

A variant of when that fallback to an orElse callback.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Serializes this Server to a JSON map.
inherited
toString() → String
A string representation of this object.
inherited
when<TResult extends Object?>(TResult $default(String url, String? description, Map<String, dynamic>? variables)) → TResult

Available on Server, provided by the ServerPatterns extension

A switch-like method, using callbacks.
whenOrNull<TResult extends Object?>(TResult? $default(String url, String? description, Map<String, dynamic>? variables)?) → TResult?

Available on Server, provided by the ServerPatterns extension

A variant of when that fallback to returning null

Operators

operator ==(Object other) → bool
The equality operator.
inherited