Header class abstract

Represents a response header definition.

This class defines a single header, which can include a description and a schema for its value.

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

Constructors

Header.new({String? description, String? type, String? format, Schema? schema, @JsonKey(name: r'$ref') String? ref})
Creates a Header object.
const
factory
Header.fromJson(Map<String, dynamic> json)
Creates a Header from a JSON object.
factory

Properties

copyWith → $HeaderCopyWith<Header>
Create a copy of Header with the given fields replaced by the non-null parameter values.
no setterinherited
description → String?
A brief description of the header.
no setterinherited
format → String?
The format of the header value (for OpenAPI 2.0).
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
ref → String?
The reference to the header value
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schema → Schema?
The schema for the header value.
no setterinherited
type → String?
The data type of the header value (for OpenAPI 2.0).
no setterinherited

Methods

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

Available on Header, provided by the HeaderPatterns extension

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

Available on Header, provided by the HeaderPatterns extension

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

Available on Header, provided by the HeaderPatterns extension

A variant of map that fallback to returning orElse.
maybeWhen<TResult extends Object?>(TResult $default(String? description, String? type, String? format, Schema? schema, String? ref)?, {required TResult orElse()}) → TResult

Available on Header, provided by the HeaderPatterns 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 Header to a JSON map.
inherited
toString() → String
A string representation of this object.
inherited
when<TResult extends Object?>(TResult $default(String? description, String? type, String? format, Schema? schema, String? ref)) → TResult

Available on Header, provided by the HeaderPatterns extension

A switch-like method, using callbacks.
whenOrNull<TResult extends Object?>(TResult? $default(String? description, String? type, String? format, Schema? schema, String? ref)?) → TResult?

Available on Header, provided by the HeaderPatterns extension

A variant of when that fallback to returning null

Operators

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