SecurityScheme class abstract

Text

Available extensions

• SecuritySchemePatterns

Annotations

• @Freezed.new(unionKey: 'type')

Constructors

SecurityScheme.apiKey({required String name, String? description, @JsonKey.new(name: 'in') required ApiKeyLocation location})

const

factory

SecurityScheme.fromJson(Map<String, dynamic> json)

factory

SecurityScheme.http({required HttpSecurityScheme scheme, String? bearerFormat, String? description})

const

factory

SecurityScheme.mutualTLS({String? description})

const

factory

SecurityScheme.oauth2({String? description, required OAuthFlows flows})

const

factory

SecurityScheme.openIdConnect({String? description, @JsonKey.new(name: 'openIdConnectUrl') required String url})

const

factory

Properties

copyWith → $SecuritySchemeCopyWith<SecurityScheme>

Create a copy of SecurityScheme with the given fields replaced by the non-null parameter values.

no setter, inherited

description → String?

A description for security scheme.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

map<TResult extends Object?>({required TResult apiKey(SecuritySchemeApiKey value), required TResult http(SecuritySchemeHttp value), required TResult mutualTLS(SecuritySchemeMutualTLS value), required TResult oauth2(SecuritySchemeOauth2 value), required TResult openIdConnect(SecuritySchemeOpenIdConnect value)}) → TResult

Available on SecurityScheme, provided by the SecuritySchemePatterns extension

A switch-like method, using callbacks.

mapOrNull<TResult extends Object?>({TResult? apiKey(SecuritySchemeApiKey value)?, TResult? http(SecuritySchemeHttp value)?, TResult? mutualTLS(SecuritySchemeMutualTLS value)?, TResult? oauth2(SecuritySchemeOauth2 value)?, TResult? openIdConnect(SecuritySchemeOpenIdConnect value)?}) → TResult?

Available on SecurityScheme, provided by the SecuritySchemePatterns extension

A variant of map that fallback to returning null.

maybeMap<TResult extends Object?>({TResult apiKey(SecuritySchemeApiKey value)?, TResult http(SecuritySchemeHttp value)?, TResult mutualTLS(SecuritySchemeMutualTLS value)?, TResult oauth2(SecuritySchemeOauth2 value)?, TResult openIdConnect(SecuritySchemeOpenIdConnect value)?, required TResult orElse()}) → TResult

Available on SecurityScheme, provided by the SecuritySchemePatterns extension

A variant of map that fallback to returning orElse.

maybeWhen<TResult extends Object?>({TResult apiKey(String name, String? description, ApiKeyLocation location)?, TResult http(HttpSecurityScheme scheme, String? bearerFormat, String? description)?, TResult mutualTLS(String? description)?, TResult oauth2(String? description, OAuthFlows flows)?, TResult openIdConnect(String? description, String url)?, required TResult orElse()}) → TResult

Available on SecurityScheme, provided by the SecuritySchemePatterns 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 SecurityScheme to a JSON map.

inherited

toString() → String

A string representation of this object.

inherited

when<TResult extends Object?>({required TResult apiKey(String name, String? description, ApiKeyLocation location), required TResult http(HttpSecurityScheme scheme, String? bearerFormat, String? description), required TResult mutualTLS(String? description), required TResult oauth2(String? description, OAuthFlows flows), required TResult openIdConnect(String? description, String url)}) → TResult

Available on SecurityScheme, provided by the SecuritySchemePatterns extension

A switch-like method, using callbacks.

whenOrNull<TResult extends Object?>({TResult? apiKey(String name, String? description, ApiKeyLocation location)?, TResult? http(HttpSecurityScheme scheme, String? bearerFormat, String? description)?, TResult? mutualTLS(String? description)?, TResult? oauth2(String? description, OAuthFlows flows)?, TResult? openIdConnect(String? description, String url)?}) → TResult?

Available on SecurityScheme, provided by the SecuritySchemePatterns extension

A variant of when that fallback to returning null

Operators

operator ==(Object other) → bool

The equality operator.

inherited