Skip to main content

Class: ServiceOptions

Represents a ServiceOptions.

Properties​

.grpc.gateway.protoc_gen_openapiv2.options.openapiv2Tag?​

optional .grpc.gateway.protoc_gen_openapiv2.options.openapiv2Tag?: $Properties | null

ServiceOptions .grpc.gateway.protoc_gen_openapiv2.options.openapiv2Tag

.nexusannotations.v1.service?​

optional .nexusannotations.v1.service?: $Properties | null

ServiceOptions .nexusannotations.v1.service

deprecated​

deprecated: boolean

Is this service deprecated? Depending on the target platform, this can emit Deprecated annotations for the service, or it will be completely ignored; in the very least, this is a formalization for deprecating services.

features?​

optional features?: $Properties | null

Any features defined in the specific edition.

uninterpretedOption​

uninterpretedOption: $Properties[]

The parser stores options it doesn't recognize here. See above.

Methods​

toJSON()​

toJSON(): object

Converts this ServiceOptions to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ServiceOptions & $Shape

Creates a new ServiceOptions instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

ServiceOptions & $Shape

ServiceOptions instance

Call Signature​

static create(properties?): ServiceOptions

Creates a new ServiceOptions instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ServiceOptions

ServiceOptions instance

decode()​

static decode(reader, length?): ServiceOptions & $Shape

Decodes a ServiceOptions 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​

ServiceOptions & $Shape

ServiceOptions

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ServiceOptions & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ServiceOptions & $Shape

ServiceOptions

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 ServiceOptions message. Does not implicitly google.protobuf.ServiceOptions.verify|verify messages.

Parameters​

message​

$Properties

ServiceOptions message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified ServiceOptions message, length delimited. Does not implicitly google.protobuf.ServiceOptions.verify|verify messages.

Parameters​

message​

$Properties

ServiceOptions message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ServiceOptions

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

ServiceOptions

ServiceOptions

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ServiceOptions

ServiceOptions

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object