The smallest field number you can specify is 1, and the largest is 2 29 - 1, or 536,870,911. Remember to leave some room for frequently occurring elements that might be added in the future. So you should reserve the numbers 1 through 15 for very frequently occurring message elements. Field numbers in the range 16 through 2047 take two bytes. Note that field numbers in the range 1 through 15 take one byte to encode, including the field number and the field's type (you can find out more about this in Protocol Buffer Encoding). These field numbers are used to identify your fields in the message binary format, and should not be changed once your message type is in use. Assigning Field NumbersĪs you can see, each field in the message definition has a unique number. However, you can also specify composite types for your fields, including enumerations and other message types. In the above example, all the fields are scalar types: two integers ( page_number and result_per_page) and a string ( query).

The SearchRequest message definition specifies three fields (name/value pairs), one for each piece of data that you want to include in this type of message.

This must be the first non-empty, non-comment line of the file.

The first line of the file specifies that you're using proto3 syntax: if you don't do this the protocol buffer compiler will assume you are using proto2.

proto file you use to define the message type.

Let's say you want to define a search request message format, where each search request has a query string, the particular page of results you are interested in, and a number of results per page. Defining A Message Typeįirst let's look at a very simple example. This is a reference guide – for a step by step example that uses many of the features described in this document, see the tutorial for your chosen language (currently proto2 only more proto3 documentation is coming soon). It covers the proto3 version of the protocol buffers language: for information on the proto2 syntax, see the Proto2 Language Guide. proto file syntax and how to generate data access classes from your. This guide describes how to use the protocol buffer language to structure your protocol buffer data, including.

Zero play guide bars