package dozer.common

Get desktop application:
View/edit binary Protocol Buffers messages

* CommonGrpcService allows developers to query data from various endpoints. The service supports both Pull and Push queries. It provides methods to return metadata about the fields that can be used to construct the data types dynamically. This is preferred while working with libraries or in the case of dynamic scenarios and interpreted languages.

• rpc count (QueryRequest, CountResponse)

  common.proto:22

  * Counts the number of records satisfying the given query. See [Query](../query) for the query format. If no query is specified, total number of records will be returned.

  message CountResponse

  common.proto:50

  Response for `count`.

  • uint64 count = 1

    The number of records satisfying the query.

• rpc query (QueryRequest, QueryResponse)

  common.proto:28

  * Performs query on an endpoint. See [Query](../query) for the query format. If no query is specified, the first 50 records will be returned.

  message QueryResponse

  common.proto:76

  Response for `query`.

  • repeated types.FieldDefinition fields = 1

    The list of field definitions.

  • repeated types.Record records = 2

    The list of record data.

• rpc OnEvent (OnEventRequest, stream types.Operation)

  common.proto:34

  * Subscribes to the Dozer event stream, optionally applies a filter. See [Query](../query) for the filter format. This API is unstable and may change in the future.

  message OnEventRequest

  common.proto:56

  Request for `OnEvent`.

  • map<string, types.EventFilter> endpoints = 1

    The endpoints to subscribe to. Key is the endpoint name, value is the filter.

• rpc getEndpoints (GetEndpointsRequest, GetEndpointsResponse)

  common.proto:36

  Gets all the endpoints Dozer is currently serving.

  message GetEndpointsRequest

  common.proto:84

  Request for `getEndpoints`.

  (message has no fields)

  message GetEndpointsResponse

  common.proto:87

  Response for `getEndpoints`.

  • repeated string endpoints = 1

    List of endpoint names.

• rpc getFields (GetFieldsRequest, GetFieldsResponse)

  common.proto:38

  Gets the field description of an endpoint.

  message GetFieldsRequest

  common.proto:62

  Request for `getFields`.

  • string endpoint = 1

    The endpoint name.

  message GetFieldsResponse

  common.proto:68

  Response for `getFields`.

  • repeated int32 primary_index = 1

    The list of indexes of the keys that are used as the primary index.

  • repeated types.FieldDefinition fields = 2

    The list of field definitions.

Request for `count` and `query`.

Used as request type in: CommonGrpcService.count, CommonGrpcService.query

• string endpoint = 1

  The name of the endpoint to query.

• optional string query = 2

  JSON query string.