Class: MethodOptions

Represents a MethodOptions.

Properties

.google.api.http?

optional .google.api.http?: $Properties | null

MethodOptions .google.api.http

---

.grpc.gateway.protoc_gen_openapiv2.options.openapiv2Operation?

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

MethodOptions .grpc.gateway.protoc_gen_openapiv2.options.openapiv2Operation

---

.nexusannotations.v1.operation?

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

MethodOptions .nexusannotations.v1.operation

---

.temporal.api.protometa.v1.requestHeader

.temporal.api.protometa.v1.requestHeader: $Properties[]

MethodOptions .temporal.api.protometa.v1.requestHeader

---

deprecated

deprecated: boolean

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

---

features?

optional features?: $Properties | null

Any features defined in the specific edition.

---

idempotencyLevel

idempotencyLevel: IdempotencyLevel

MethodOptions idempotencyLevel.

---

uninterpretedOption

uninterpretedOption: $Properties[]

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

Methods

toJSON()

toJSON(): object

Converts this MethodOptions to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): MethodOptions & $Shape

Creates a new MethodOptions instance using the specified properties.

Parameters

properties?

$Shape

Properties to set

Returns

MethodOptions & $Shape

MethodOptions instance

Call Signature

static create(properties?): MethodOptions

Creates a new MethodOptions instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

MethodOptions

MethodOptions instance

---

decode()

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

Decodes a MethodOptions 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

MethodOptions & $Shape

MethodOptions

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): MethodOptions & $Shape

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

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

MethodOptions & $Shape

MethodOptions

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

Parameters

message

$Properties

MethodOptions message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

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

Parameters

message

$Properties

MethodOptions message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): MethodOptions

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

Parameters

object

{[k: string]: any; }

Plain object

Returns

MethodOptions

MethodOptions

---

toObject()

static toObject(message, options?): object

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

Parameters

message

MethodOptions

MethodOptions

options?

IConversionOptions

Conversion options

Returns

object

Plain object