Class: OperationOptions
nexusannotations.v1.OperationOptions
Represents an OperationOptions.
Implements
Constructors
constructor
• new OperationOptions(properties?): OperationOptions
Constructs a new OperationOptions.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IOperationOptions | Properties to set |
Returns
Properties
name
• name: string
Nexus operation name (defaults to proto method name).
Implementation of
tags
• tags: string[]
Tags to attach to the operation. Used by code generators to include and exclude operations.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this OperationOptions to JSON.
Returns
Object
JSON object
create
▸ create(properties?): OperationOptions
Creates a new OperationOptions instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IOperationOptions | Properties to set |
Returns
OperationOptions instance
decode
▸ decode(reader, length?): OperationOptions
Decodes an OperationOptions 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
OperationOptions
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): OperationOptions
Decodes an OperationOptions message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
OperationOptions
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 OperationOptions message. Does not implicitly nexusannotations.v1.OperationOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IOperationOptions | OperationOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified OperationOptions message, length delimited. Does not implicitly nexusannotations.v1.OperationOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IOperationOptions | OperationOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): OperationOptions
Creates an OperationOptions message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
OperationOptions
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for OperationOptions
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 an OperationOptions message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | OperationOptions | OperationOptions |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object