Skip to main content

Class: SecurityRequirementValue

If the security scheme is of type "oauth2", then the value is a list of scope names required for the execution. For other security scheme types, the array MUST be empty.

Properties​

scope​

scope: string[]

SecurityRequirementValue scope.

Methods​

toJSON()​

toJSON(): object

Converts this SecurityRequirementValue to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): SecurityRequirementValue & $Properties

Creates a new SecurityRequirementValue instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

SecurityRequirementValue & $Properties

SecurityRequirementValue instance

Call Signature​

static create(properties?): SecurityRequirementValue

Creates a new SecurityRequirementValue instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

SecurityRequirementValue

SecurityRequirementValue instance

decode()​

static decode(reader, length?): SecurityRequirementValue & $Properties

Decodes a SecurityRequirementValue message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

SecurityRequirementValue & $Properties

SecurityRequirementValue

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): SecurityRequirementValue & $Properties

Decodes a SecurityRequirementValue message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

SecurityRequirementValue & $Properties

SecurityRequirementValue

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified SecurityRequirementValue message. Does not implicitly grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement.SecurityRequirementValue.verify|verify messages.

Parameters​

message​

$Properties

SecurityRequirementValue message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified SecurityRequirementValue message, length delimited. Does not implicitly grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement.SecurityRequirementValue.verify|verify messages.

Parameters​

message​

$Properties

SecurityRequirementValue message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): SecurityRequirementValue

Creates a SecurityRequirementValue message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

SecurityRequirementValue

SecurityRequirementValue

toObject()​

static toObject(message, options?): object

Creates a plain object from a SecurityRequirementValue message. Also converts values to other types if specified.

Parameters​

message​

SecurityRequirementValue

SecurityRequirementValue

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object