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