Class: MethodOptions
Represents a MethodOptions.
Properties
.google.api.http
• Optional .google.api.http: null | $Properties
MethodOptions .google.api.http
.grpc.gateway.protoc_gen_openapiv2.options.openapiv2Operation
• Optional .grpc.gateway.protoc_gen_openapiv2.options.openapiv2Operation: null | $Properties
MethodOptions .grpc.gateway.protoc_gen_openapiv2.options.openapiv2Operation
.nexusannotations.v1.operation
• Optional .nexusannotations.v1.operation: null | $Properties
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: null | $Properties
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
▸ create(properties?): MethodOptions & $Shape
Creates a new MethodOptions instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
MethodOptions instance
▸ create(properties?): MethodOptions
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): MethodOptions & $Shape
Decodes a MethodOptions 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
MethodOptions
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): MethodOptions & $Shape
Decodes a MethodOptions message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
MethodOptions
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 MethodOptions message. Does not implicitly google.protobuf.MethodOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | MethodOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified MethodOptions message, length delimited. Does not implicitly google.protobuf.MethodOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | MethodOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): MethodOptions
Creates a MethodOptions message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
MethodOptions
toObject
▸ toObject(message, options?): Object
Creates a plain object from a MethodOptions message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | MethodOptions | MethodOptions |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object