Class: Header
protoc_gen_openapiv2.options.Header
Header is a representation of OpenAPI v2 specification's Header object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#headerObject
Properties
default
• default: string
Default Declares the value of the header that the server will use if none is provided.
See: https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2.
Unlike JSON Schema this value MUST conform to the defined type for the header.
description
• description: string
Description is a short description of the header.
format
• format: string
Format The extending format for the previously mentioned type.
pattern
• pattern: string
'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.
type
• type: string
The type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.
Methods
toJSON
▸ toJSON(): Object
Converts this Header to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Header & $Properties
Creates a new Header instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
Header instance
▸ create(properties?): Header
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): Header & $Properties
Decodes a Header 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
Header
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Header & $Properties
Decodes a Header message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Header
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 Header message. Does not implicitly grpc.gateway.protoc_gen_openapiv2.options.Header.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | Header message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Header message, length delimited. Does not implicitly grpc.gateway.protoc_gen_openapiv2.options.Header.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | Header message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Header
Creates a Header message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Header
toObject
▸ toObject(message, options?): Object
Creates a plain object from a Header message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Header | Header |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object