package test
Get desktop application:
View/edit binary Protocol Buffers messages
service KitchenSink
test.proto:17rpc Ping (, )
test.proto:20Ping is a no-op method, usable to test that a given channel works. No data is exchanged.
rpc Exchange (, )
test.proto:27The Exchange method can be useful for testing the UI. It's complicated request type exercises many of the feature in gRPC UI's request form building code. The server will echo back in response metadata all request metadata values it receives. If the metadata key ends with "-t", it is sent back as trailer metadata. Otherwise, it is sent back as header metadata. The response will be the same as the request.
rpc UploadMany (stream , )
test.proto:34The UploadMany method is like Exchange, except that it is for testing RPCs that accept a stream from the client. The server will reply with the last request message it received, but with the needed_num_a field set to the number of messages observed. If the client stream includes zero messages, the server will reply with an "Invalid Argument" error code.
rpc DownloadMany (, stream )
test.proto:40The DownloadMany method is like Exchange, except that it is for testing RPCs that have a stream from the server. The value in the request for the numbers.needed_num_1 field controls how many messages are included in the response stream. Each response sent is a copy of the request.
rpc DoManyThings (stream , stream )
test.proto:45The DoManyThings method is like Exchange, except that it is for testing RPCs that have bidirectional streams. The response stream will be a copy of the request stream, so each request is mirrored to the response stream as it is received.
rpc Fail (, stream )
test.proto:50Fail is useful for testing errors. The num_responses request field controls how many response messages are sent before returning an error. The other request fields are used to construct the error that will be returned.
message
test.proto:491optional int32 num_responses = 1
optional RpcStatusCode code = 2
basically a copy of Status from google/rpc/status.proto
optional string message = 3
repeated details = 4
rpc SendTimestamp (, )
test.proto:54SendTimestamp is for testing the UI web form, that it can construct a request form that has only the single scalar input for a timestamp.
rpc SendDuration (, )
test.proto:57SendDuration is for testing the UI web form, that it can construct a request form that has only the single scalar input for a duration.
rpc SendAny (, )
test.proto:60SendAny is for testing the UI web form, that it can construct a request form that has only the single Any message input.
rpc SendStruct (, )
test.proto:63SendStruct is for testing the UI web form, that it can construct a request form that has only the single, text area input for a JSON object.
rpc SendValue (, )
test.proto:66SendValue is for testing the UI web form, that it can construct a request form that has only the single, text area input for a JSON value.
rpc SendListValue (, )
test.proto:69SendListValue is for testing the UI web form, that it can construct a request form that has just the input(s) for a JSON array.
rpc SendBytes (, )
test.proto:72SendBytes is for testing the UI web form, that it can construct a request form that has only the single scalar input for a bytes value.
rpc SendString (, )
test.proto:75SendString is for testing the UI web form, that it can construct a request form that has only the single scalar input for a string value.
rpc SendBool (, )
test.proto:78SendBool is for testing the UI web form, that it can construct a request form that has only the single scalar input for a boolean value.
rpc SendDouble (, )
test.proto:81SendDouble is for testing the UI web form, that it can construct a request form that has only the single scalar input for a double value.
rpc SendFloat (, )
test.proto:84SendFloat is for testing the UI web form, that it can construct a request form that has only the single scalar input for a float value.
rpc SendInt32 (, )
test.proto:87SendInt32 is for testing the UI web form, that it can construct a request form that has only the single scalar input for a signed 32-bit int value.
rpc SendInt64 (, )
test.proto:90SendInt64 is for testing the UI web form, that it can construct a request form that has only the single scalar input for a signed 64-bit int value.
rpc SendUInt32 (, )
test.proto:93SendUInt32 is for testing the UI web form, that it can construct a request form that has only the single scalar input for an unsigned 32-bit int value.
rpc SendUInt64 (, )
test.proto:96SendUInt64 is for testing the UI web form, that it can construct a request form that has only the single scalar input for an unsigned 64-bit int value.
rpc SendMultipleTimestamp (stream , )
test.proto:101rpc SendMultipleDuration (stream , )
test.proto:102rpc SendMultipleAny (stream , )
test.proto:103rpc SendMultipleStruct (stream , )
test.proto:104rpc SendMultipleValue (stream , )
test.proto:105rpc SendMultipleListValue (stream , )
test.proto:106rpc SendMultipleBytes (stream , )
test.proto:107rpc SendMultipleString (stream , )
test.proto:108rpc SendMultipleBool (stream , )
test.proto:109rpc SendMultipleDouble (stream , )
test.proto:110rpc SendMultipleFloat (stream , )
test.proto:111rpc SendMultipleInt32 (stream , )
test.proto:112rpc SendMultipleInt64 (stream , )
test.proto:113rpc SendMultipleUInt32 (stream , )
test.proto:114rpc SendMultipleUInt64 (stream , )
test.proto:115
message
test.proto:156Used in:
required string line1 = 1
optional string line2 = 2
required string city = 3
required string state = 4
required uint32 zip = 5
message
test.proto:268Used in:
repeated string names = 1
repeated bytes data = 2
repeated relatives = 3
repeated State other_states = 14
message
test.proto:275Used in:
map<string, Void> string_set = 1
map<int32, Void> int32_set = 2
map<int64, Void> int64_set = 3
map<uint32, Void> uint32_set = 4
map<uint64, Void> uint64_set = 5
map<sint32, Void> sint32_set = 6
map<sint64, Void> sint64_set = 7
map<fixed32, > fixed32_set = 8
map<fixed64, > fixed64_set = 9
map<sfixed32, > sfixed32_set = 10
map<sfixed64, > sfixed64_set = 11
map<int32, > people_by_employee_num = 12
map<int32, State> states = 13
map<string, string> string_names = 14
map<string, bytes> bytes_names = 15
map<string, bool> bool_names = 16
map<string, double> double_names = 17
map<string, float> float_names = 18
message
test.proto:226Used in:
optional int32 usually_1 = 1
optional int32 some_num_1 = 2
required int32 needed_num_1 = 3
optional int64 usually_2 = 4
optional int64 some_num_2 = 5
required int64 needed_num_2 = 6
optional uint32 usually_3 = 7
optional uint32 some_num_3 = 8
required uint32 needed_num_3 = 9
optional uint64 usually_4 = 10
optional uint64 some_num_4 = 11
required uint64 needed_num_4 = 12
optional sint32 usually_5 = 13
optional sint32 some_num_5 = 14
required sint32 needed_num_5 = 15
optional sint64 usually_6 = 16
optional sint64 some_num_6 = 17
required sint64 needed_num_6 = 18
optional fixed32 usually_7 = 19
optional fixed32 some_num_7 = 20
required fixed32 needed_num_7 = 21
optional fixed64 usually_8 = 22
optional fixed64 some_num_8 = 23
required fixed64 needed_num_8 = 24
optional sfixed32 usually_9 = 25
optional sfixed32 some_num_9 = 26
required sfixed32 needed_num_9 = 27
optional sfixed64 usually_10 = 28
optional sfixed64 some_num_10 = 29
required sfixed64 needed_num_10 = 30
message
test.proto:135Used in: , ,
required uint64 id = 1
The unique ID of the person
required string name = 2
The person's full name
optional address = 3
The person's address
optional double xyz = 4
optional string title = 5
repeated string labels = 6
optional bool is_real = 7
optional bytes opaque = 8
oneof relative
parent = 9
sibling = 10
child = 11
Void none = 12
basically a copy of Code from google/rpc/code.proto
Used in:
OK = 0
Not an error; returned on success HTTP Mapping: 200 OK
CANCELED = 1
The operation was canceled, typically by the caller. HTTP Mapping: 499 Client Closed Request
UNKNOWN = 2
Unknown error. For example, this error may be returned when a `Status` value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. HTTP Mapping: 500 Internal Server Error
INVALID_ARGUMENT = 3
The client specified an invalid argument. Note that this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). HTTP Mapping: 400 Bad Request
DEADLINE_EXCEEDED = 4
The deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. HTTP Mapping: 504 Gateway Timeout
NOT_FOUND = 5
Some requested entity (e.g., file or directory) was not found. Note to server developers: if a request is denied for an entire class of users, such as gradual feature rollout or undocumented whitelist, `NOT_FOUND` may be used. If a request is denied for some users within a class of users, such as user-based access control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not Found
ALREADY_EXISTS = 6
The entity that a client attempted to create (e.g., file or directory) already exists. HTTP Mapping: 409 Conflict
PERMISSION_DENIED = 7
The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden
UNAUTHENTICATED = 16
The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized
RESOURCE_EXHAUSTED = 8
Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests
FAILED_PRECONDITION = 9
The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level (e.g., when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence). (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. E.g., if an "rmdir" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request
ABORTED = 10
The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict
OUT_OF_RANGE = 11
The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request
UNIMPLEMENTED = 12
The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented
INTERNAL = 13
Internal errors. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors. HTTP Mapping: 500 Internal Server Error
UNAVAILABLE = 14
The service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 503 Service Unavailable
DATA_LOSS = 15
Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal Server Error
enum State
test.proto:118Used in: , ,
INVALID = 0
INITIAL = 1
PENDING = 2
RUNNING = 3
PAUSED = 4
AWAITING_INPUT = 5
CANCELLING = 6
COMPLETE = 7
CANCELLED = 8
FAILED = 9
message
test.proto:298Used as request type in: KitchenSink.DoManyThings, KitchenSink.DownloadMany, KitchenSink.Exchange, KitchenSink.UploadMany
Used as response type in: KitchenSink.DoManyThings, KitchenSink.DownloadMany, KitchenSink.Exchange, KitchenSink.Fail, KitchenSink.UploadMany
optional recurse = 2
To recurse or not to recurse
repeated repeated_recurse = 3
It's even possible to do this repeatedly!
required person = 4
required State state = 5
optional numbers = 6
optional float usually_4242 = 7
optional float some_num_a = 8
required float needed_num_a = 9
optional double usually_9999 = 10
optional double some_num_b = 11
required double needed_num_b = 12
optional State next_state = 13
optional bytes base64_stuff = 14
required bytes opaque_id = 15
optional wk = 16
optional arrays = 17
optional maps = 18
optional group test.TestMessage.Misc = 19
message
test.proto:328Used in:
optional string foo = 1
optional int32 bar = 2
enum Void
test.proto:131Used in: ,
VOID = 0
message
test.proto:164Used in:
required now = 1
optional past = 2
repeated futures = 3
required period = 4
optional next_interval = 5
repeated history_intervals = 6
required neat = 7
optional extra = 8
repeated extensions = 9
required object = 10
optional optional_object = 11
repeated objects = 12
required value = 13
optional optional_value = 14
repeated values = 15
required list = 16
optional optional_list = 17
repeated lists = 18
required bytes = 19
optional optional_bytes = 20
repeated list_o_bytes = 21
required string = 22
optional optional_string = 23
repeated list_o_strings = 24
required bool = 25
optional optional_bool = 26
repeated list_o_bools = 27
required double = 28
optional optional_double = 29
repeated list_o_doubles = 30
required float = 31
optional optional_float = 32
repeated list_o_floats = 33
required small_int = 34
optional optional_small_int = 35
repeated list_o_small_ints = 36
required big_int = 37
optional optional_big_int = 38
repeated list_o_big_ints = 39
required small_id = 40
optional optional_small_id = 41
repeated list_o_small_ids = 42
required big_id = 43
optional optional_big_id = 44
repeated list_o_big_ids = 45