Class: SecurityRequirementValue
options.SecurityRequirement.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.
Implements
Constructors
constructor
• new SecurityRequirementValue(properties?): SecurityRequirementValue
Constructs a new SecurityRequirementValue.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ISecurityRequirementValue | Properties to set |
Returns
Properties
scope
• scope: string[]
SecurityRequirementValue scope.
Implementation of
ISecurityRequirementValue.scope
Methods
toJSON
▸ toJSON(): Object
Converts this SecurityRequirementValue to JSON.
Returns
Object
JSON object
create
▸ create(properties?): SecurityRequirementValue
Creates a new SecurityRequirementValue instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ISecurityRequirementValue | Properties to set |
Returns
SecurityRequirementValue instance
decode
▸ decode(reader, length?): SecurityRequirementValue
Decodes a SecurityRequirementValue message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
SecurityRequirementValue
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): SecurityRequirementValue
Decodes a SecurityRequirementValue message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
SecurityRequirementValue
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified SecurityRequirementValue message. Does not implicitly grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement.SecurityRequirementValue.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ISecurityRequirementValue | SecurityRequirementValue message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ 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
| Name | Type | Description |
|---|---|---|
message | ISecurityRequirementValue | SecurityRequirementValue message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): SecurityRequirementValue
Creates a SecurityRequirementValue message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
SecurityRequirementValue
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for SecurityRequirementValue
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a SecurityRequirementValue message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | SecurityRequirementValue | SecurityRequirementValue |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object