Reference documentation and code samples for the proto library Client class MethodOptions.
Generated from protobuf message google.protobuf.MethodOptions
Namespace
Google \ Protobuf \ InternalMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ deprecated |
bool
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. |
↳ idempotency_level |
int
|
↳ features |
FeatureSet
Any features defined in the specific edition. WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language. |
↳ uninterpreted_option |
array<UninterpretedOption>
The parser stores options it doesn't recognize here. See above. |
getDeprecated
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.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasDeprecated
clearDeprecated
setDeprecated
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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIdempotencyLevel
Generated from protobuf field optional .google.protobuf.MethodOptions.IdempotencyLevel idempotency_level = 34 [default = IDEMPOTENCY_UNKNOWN];
| Returns | |
|---|---|
| Type | Description |
int |
one of the values in {@see \Google\Protobuf\Internal\MethodOptions\IdempotencyLevel} |
hasIdempotencyLevel
clearIdempotencyLevel
setIdempotencyLevel
Generated from protobuf field optional .google.protobuf.MethodOptions.IdempotencyLevel idempotency_level = 34 [default = IDEMPOTENCY_UNKNOWN];
| Parameter | |
|---|---|
| Name | Description |
var |
int
one of the values in MethodOptions\IdempotencyLevel |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFeatures
Any features defined in the specific edition.
WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language.
| Returns | |
|---|---|
| Type | Description |
FeatureSet|null |
|
hasFeatures
clearFeatures
setFeatures
Any features defined in the specific edition.
WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language.
| Parameter | |
|---|---|
| Name | Description |
var |
FeatureSet
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUninterpretedOption
The parser stores options it doesn't recognize here. See above.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<UninterpretedOption> |
|
setUninterpretedOption
The parser stores options it doesn't recognize here. See above.
| Parameter | |
|---|---|
| Name | Description |
var |
array<UninterpretedOption>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|