Constructor
new BundleDescriptor(bundledField, requestDiscriminatorFields, subresponseField, byteLengthFunction)
Describes the structure of bundled call.
requestDiscriminatorFields may include '.' as a separator, which is used to indicate object traversal. This allows fields in nested objects to be used to determine what request to bundle.
Parameters:
| Name | Type | Description |
|---|---|---|
bundledField |
String |
the repeated field in the request message that will have its elements aggregated by bundling. |
requestDiscriminatorFields |
String |
a list of fields in the target request message class that are used to detemrine which request messages should be bundled together. |
subresponseField |
String |
an optional field, when present it indicates the field in the response message that should be used to demultiplex the response into multiple response messages. |
byteLengthFunction |
function |
a function to obtain the byte length to be consumed for the bundled field messages. Because Node.JS protobuf.js/gRPC uses builtin Objects for the user-visible data and internally they are encoded/decoded in protobuf manner, this function is actually necessary to calculate the byte length. |
Properties:
| Name | Type | Description |
|---|---|---|
bundledField |
String | |
requestDiscriminatorFields |
String | |
subresponseField |
String | |
byteLengthFunction |
function |