package grpc.testing

Get desktop application:
View/edit binary Protocol Buffers messages

A service used to obtain stats for verifying LB behavior.

• rpc GetClientStats (LoadBalancerStatsRequest, LoadBalancerStatsResponse)

  test.proto:84

  Gets the backend distribution for RPCs sent by a test client.

  message LoadBalancerStatsRequest

  messages.proto:197

  • int32 num_rpcs = 1

    Request stats for the next num_rpcs sent by client.

  • int32 timeout_sec = 2

    If num_rpcs have not completed within timeout_sec, return partial results.

  message LoadBalancerStatsResponse

  messages.proto:204

  • map<string, int32> rpcs_by_peer = 1

    The number of completed RPCs for each peer.

  • int32 num_failures = 2

    The number of RPCs that failed to record a remote peer.

A service used to control reconnect server.

• rpc Start (ReconnectParams, Empty)

  test.proto:77

  message ReconnectParams

  messages.proto:185

  For reconnect interop test only. Client tells server what reconnection parameters it used.

  • int32 max_reconnect_backoff_ms = 1

• rpc Stop (Empty, ReconnectInfo)

  test.proto:78

  message ReconnectInfo

  messages.proto:192

  For reconnect interop test only. Server tells client whether its reconnects are following the spec and the reconnect backoffs it saw.

  • bool passed = 1

  • repeated int32 backoff_ms = 2

A simple service to test the various types of RPCs and experiment with performance with various types of payload.

• rpc EmptyCall (Empty, Empty)

  test.proto:30

  One empty request followed by one empty response.

• rpc UnaryCall (SimpleRequest, SimpleResponse)

  test.proto:33

  One request followed by one response.

• rpc CacheableUnaryCall (SimpleRequest, SimpleResponse)

  test.proto:38

  One request followed by one response. Response has cache control headers set such that a caching HTTP proxy (such as GFE) can satisfy subsequent requests.

• rpc StreamingOutputCall (StreamingOutputCallRequest, stream StreamingOutputCallResponse)

  test.proto:42

  One request followed by a sequence of responses (streamed download). The server returns the payload with client desired type and sizes.

• rpc StreamingInputCall (stream StreamingInputCallRequest, StreamingInputCallResponse)

  test.proto:47

  A sequence of requests followed by one response (streamed upload). The server returns the aggregated size of client payload as the result.

  message StreamingInputCallRequest

  messages.proto:124

  Client-streaming request.

  • optional Payload payload = 1

    Optional input payload sent along with the request.

  • optional BoolValue expect_compressed = 2

    Whether the server should expect this request to be compressed. This field is "nullable" in order to interoperate seamlessly with servers not able to implement the full compression tests by introspecting the call to verify the request's compression status.

  message StreamingInputCallResponse

  messages.proto:138

  Client-streaming response.

  • int32 aggregated_payload_size = 1

    Aggregated size of payloads received from the client.

• rpc FullDuplexCall (stream StreamingOutputCallRequest, stream StreamingOutputCallResponse)

  test.proto:53

  A sequence of requests with each request served by the server immediately. As one request could lead to multiple responses, this interface demonstrates the idea of full duplexing.

• rpc HalfDuplexCall (stream StreamingOutputCallRequest, stream StreamingOutputCallResponse)

  test.proto:60

  A sequence of requests followed by a sequence of responses. The server buffers all the client requests and then serves them in order. A stream of responses are returned to the client when the server starts with first request.

• rpc UnimplementedCall (Empty, Empty)

  test.proto:65

  The test server will not implement this method. It will be used to test the behavior when clients call unimplemented methods.

A simple service NOT implemented at servers so clients can test for that case.

• rpc UnimplementedCall (Empty, Empty)

  test.proto:72

  A call that no server should implement

TODO(dgq): Go back to using well-known types once https://github.com/grpc/grpc/issues/6980 has been fixed. import "google/protobuf/wrappers.proto";

Used in: ResponseParameters, SimpleRequest, StreamingInputCallRequest

• bool value = 1

  The bool value.

A protobuf representation for grpc status. This is used by test clients to specify a status that the server should attempt to return.

Used in: SimpleRequest, StreamingOutputCallRequest

• int32 code = 1

• string message = 2

An empty message that you can re-use to avoid defining duplicated empty messages in your project. A typical example is to use it as argument or the return value of a service API. For instance: service Foo { rpc Bar (grpc.testing.Empty) returns (grpc.testing.Empty) { }; };

Used as request type in: ReconnectService.Stop, TestService.EmptyCall, TestService.UnimplementedCall, UnimplementedService.UnimplementedCall

Used as response type in: ReconnectService.Start, TestService.EmptyCall, TestService.UnimplementedCall, UnimplementedService.UnimplementedCall

(message has no fields)

The type of route that a client took to reach a server w.r.t. gRPCLB. The server must fill in "fallback" if it detects that the RPC reached the server via the "gRPCLB fallback" path, and "backend" if it detects that the RPC reached the server via "gRPCLB backend" path (i.e. if it got the address of this server from the gRPCLB server BalanceLoad RPC). Exactly how this detection is done is context and server dependent.

Used in: SimpleResponse

• GRPCLB_ROUTE_TYPE_UNKNOWN = 0

  Server didn't detect the route that a client took to reach it.

• GRPCLB_ROUTE_TYPE_FALLBACK = 1

  Indicates that a client reached a server via gRPCLB fallback.

• GRPCLB_ROUTE_TYPE_BACKEND = 2

  Indicates that a client reached a server as a gRPCLB-given backend.

A block of data, to simply increase gRPC message size.

Used in: SimpleRequest, SimpleResponse, StreamingInputCallRequest, StreamingOutputCallRequest, StreamingOutputCallResponse

• PayloadType type = 1

  The type of data in body.

• bytes body = 2

  Primary contents of payload.

The type of payload that should be returned.

Used in: Payload, SimpleRequest, StreamingOutputCallRequest

• COMPRESSABLE = 0

  Compressable text format.

Configuration for a particular response.

Used in: StreamingOutputCallRequest

• int32 size = 1

  Desired payload sizes in responses from the server.

• int32 interval_us = 2

  Desired interval between consecutive responses in the response stream in microseconds.

• optional BoolValue compressed = 3

  Whether to request the server to compress the response. This field is "nullable" in order to interoperate seamlessly with clients not able to implement the full compression tests by introspecting the call to verify the response's compression status.

Unary request.

Used as request type in: TestService.CacheableUnaryCall, TestService.UnaryCall

• PayloadType response_type = 1

  Desired payload type in the response from the server. If response_type is RANDOM, server randomly chooses one from other formats.

• int32 response_size = 2

  Desired payload size in the response from the server.

• optional Payload payload = 3

  Optional input payload sent along with the request.

• bool fill_username = 4

  Whether SimpleResponse should include username.

• bool fill_oauth_scope = 5

  Whether SimpleResponse should include OAuth scope.

• optional BoolValue response_compressed = 6

  Whether to request the server to compress the response. This field is "nullable" in order to interoperate seamlessly with clients not able to implement the full compression tests by introspecting the call to verify the response's compression status.

• optional EchoStatus response_status = 7

  Whether server should return a given status

• optional BoolValue expect_compressed = 8

  Whether the server should expect this request to be compressed.

• bool fill_server_id = 9

  Whether SimpleResponse should include server_id.

• bool fill_grpclb_route_type = 10

  Whether SimpleResponse should include grpclb_route_type.

Unary response, as configured by the request.

Used as response type in: TestService.CacheableUnaryCall, TestService.UnaryCall

• optional Payload payload = 1

  Payload to increase message size.

• string username = 2

  The user the request came from, for verifying authentication was successful when the client expected it.

• string oauth_scope = 3

  OAuth scope.

• string server_id = 4

  Server ID. This must be unique among different server instances, but the same across all RPC's made to a particular server instance.

• GrpclbRouteType grpclb_route_type = 5

  gRPCLB Path.

• string hostname = 6

  Server hostname.

Server-streaming request.

Used as request type in: TestService.FullDuplexCall, TestService.HalfDuplexCall, TestService.StreamingOutputCall

• PayloadType response_type = 1

  Desired payload type in the response from the server. If response_type is RANDOM, the payload from each response in the stream might be of different types. This is to simulate a mixed type of payload stream.

• repeated ResponseParameters response_parameters = 2

  Configuration for each expected response message.

• optional Payload payload = 3

  Optional input payload sent along with the request.

• optional EchoStatus response_status = 7

  Whether server should return a given status

Server-streaming response, as configured by the request and parameters.

Used as response type in: TestService.FullDuplexCall, TestService.HalfDuplexCall, TestService.StreamingOutputCall

• optional Payload payload = 1

  Payload to increase response size.