☰
Navigation :

Package : google.protobuf

Top

type.proto

Table of Contents

Enum

Field Type Label Description
name string Enum type name.
enumvalue []google.protobuf.EnumValue repeated Enum value definitions.
options []google.protobuf.Option repeated Protocol buffer options.
sourceContext google.protobuf.SourceContext The source context.
syntax google.protobuf.Syntax The source syntax.

EnumValue

Field Type Label Description
name string Enum value name.
number int32 Enum value number.
options []google.protobuf.Option repeated Protocol buffer options.

Field

Field Type Label Description
kind google.protobuf.Field.Kind The field type.
cardinality google.protobuf.Field.Cardinality The field cardinality.
number int32 The field number.
name string The field name.
typeUrl string The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".
oneofIndex int32 The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.
packed bool Whether to use alternative packed wire representation.
options []google.protobuf.Option repeated The protocol buffer options.
jsonName string The field JSON name.
defaultValue string The string value of the default value of this field. Proto2 syntax only.

Option

Field Type Label Description
name string The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, "map_entry". For custom options, it should be the fully-qualified name. For example, "google.api.http".
value google.protobuf.Any The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.

Type

Field Type Label Description
name string The fully qualified message name.
fields []google.protobuf.Field repeated The list of fields.
oneofs []string repeated The list of types appearing in oneof definitions in this type.
options []google.protobuf.Option repeated The protocol buffer options.
sourceContext google.protobuf.SourceContext The source context.
syntax google.protobuf.Syntax The source syntax.

Field.Cardinality

Name Number Description
CARDINALITY_UNKNOWN 0 For fields with unknown cardinality.
CARDINALITY_OPTIONAL 1 For optional fields.
CARDINALITY_REQUIRED 2 For required fields. Proto2 syntax only.
CARDINALITY_REPEATED 3 For repeated fields.

Field.Kind

Name Number Description
TYPE_UNKNOWN 0 Field type unknown.
TYPE_DOUBLE 1 Field type double.
TYPE_FLOAT 2 Field type float.
TYPE_INT64 3 Field type int64.
TYPE_UINT64 4 Field type uint64.
TYPE_INT32 5 Field type int32.
TYPE_FIXED64 6 Field type fixed64.
TYPE_FIXED32 7 Field type fixed32.
TYPE_BOOL 8 Field type bool.
TYPE_STRING 9 Field type string.
TYPE_GROUP 10 Field type group. Proto2 syntax only, and deprecated.
TYPE_MESSAGE 11 Field type message.
TYPE_BYTES 12 Field type bytes.
TYPE_UINT32 13 Field type uint32.
TYPE_ENUM 14 Field type enum.
TYPE_SFIXED32 15 Field type sfixed32.
TYPE_SFIXED64 16 Field type sfixed64.
TYPE_SINT32 17 Field type sint32.
TYPE_SINT64 18 Field type sint64.

Syntax

Name Number Description
SYNTAX_PROTO2 0 Syntax proto2.
SYNTAX_PROTO3 1 Syntax proto3.