class documentation
class RegionRouting(pb_classes.Message): (source)
Constructor: RegionRouting(initial_message, nid, disabled, strict)
Undocumented
Method | __dir__ |
Undocumented |
Method | __init__ |
Undocumented |
Method | disabled |
Undocumented |
Method | nid |
Undocumented |
Method | strict |
Undocumented |
Constant | __PB2 |
Undocumented |
Constant | __PY |
Undocumented |
Class Variable | __mask |
Undocumented |
Property | disabled |
If true, region routing is disabled for the method. When this is set, requests will not be forwarded to a different region, even if an NID is present. |
Property | nid |
A list of fields to extract the NID from, in order of priority. The API Gateway will check each field in sequence and use the first valid NID it finds. This overrides the default NID lookup order: `id`, `parent_id`, `metadata... |
Property | strict |
In strict mode, the API Gateway returns an INVALID_ARGUMENT error to the user when a routing error occurs, rather than forwarding the request to the local region. |
Inherited from Message
:
Class Method | get |
Undocumented |
Class Method | is |
Undocumented |
Class Method | is |
Undocumented |
Method | __repr__ |
Undocumented |
Method | check |
Undocumented |
Method | get |
Undocumented |
Method | get |
Undocumented |
Method | is |
Undocumented |
Method | set |
Undocumented |
Method | which |
Undocumented |
Class Variable | __PB2 |
Undocumented |
Instance Variable | __pb2 |
Undocumented |
Method | _clear |
Undocumented |
Method | _get |
Undocumented |
Method | _set |
Undocumented |
Class Variable | __credentials |
Undocumented |
Class Variable | __default |
Undocumented |
Class Variable | __sensitive |
Undocumented |
Instance Variable | __recorded |
Undocumented |
def __init__(self, initial_message:
message.Message | None
= None, *, nid: abc.Iterable[ builtins.str] | None | unset.UnsetType
= unset.Unset, disabled: builtins.bool | None | unset.UnsetType
= unset.Unset, strict: builtins.bool | None | unset.UnsetType
= unset.Unset):
(source)
¶
Undocumented
Undocumented
Value |
|
If true, region routing is disabled for the method. When this is set, requests will not be forwarded to a different region, even if an NID is present.
A list of fields to extract the NID from, in order of priority. The API Gateway will check each field in sequence and use the first valid NID it finds. This overrides the default NID lookup order: `id`, `parent_id`, `metadata.id`, `metadata.parent_id`. If the field contains a non-empty list of strings, all NIDs in the array must be valid and have the same routing code.