descriptor

package
v0.0.0-...-addb04b Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 15, 2015 License: Apache-2.0, BSD-3-Clause Imports: 2 Imported by: 0

Documentation

Overview

Package google_protobuf is a generated protocol buffer package.

It is generated from these files:

google/protobuf/descriptor.proto

It has these top-level messages:

FileDescriptorSet
FileDescriptorProto
DescriptorProto
FieldDescriptorProto
EnumDescriptorProto
EnumValueDescriptorProto
ServiceDescriptorProto
MethodDescriptorProto
FileOptions
MessageOptions
FieldOptions
EnumOptions
EnumValueOptions
ServiceOptions
MethodOptions
UninterpretedOption
SourceCodeInfo

Index

Constants

View Source
const Default_EnumOptions_AllowAlias bool = true
View Source
const Default_FieldOptions_Deprecated bool = false
View Source
const Default_FieldOptions_Lazy bool = false
View Source
const Default_FieldOptions_Weak bool = false
View Source
const Default_FileOptions_CcGenericServices bool = false
View Source
const Default_FileOptions_JavaGenerateEqualsAndHash bool = false
View Source
const Default_FileOptions_JavaGenericServices bool = false
View Source
const Default_FileOptions_JavaMultipleFiles bool = false
View Source
const Default_FileOptions_PyGenericServices bool = false
View Source
const Default_MessageOptions_MessageSetWireFormat bool = false
View Source
const Default_MessageOptions_NoStandardDescriptorAccessor bool = false

Variables

View Source
var FieldDescriptorProto_Label_name = map[int32]string{
	1: "LABEL_OPTIONAL",
	2: "LABEL_REQUIRED",
	3: "LABEL_REPEATED",
}
View Source
var FieldDescriptorProto_Label_value = map[string]int32{
	"LABEL_OPTIONAL": 1,
	"LABEL_REQUIRED": 2,
	"LABEL_REPEATED": 3,
}
View Source
var FieldDescriptorProto_Type_name = map[int32]string{
	1:  "TYPE_DOUBLE",
	2:  "TYPE_FLOAT",
	3:  "TYPE_INT64",
	4:  "TYPE_UINT64",
	5:  "TYPE_INT32",
	6:  "TYPE_FIXED64",
	7:  "TYPE_FIXED32",
	8:  "TYPE_BOOL",
	9:  "TYPE_STRING",
	10: "TYPE_GROUP",
	11: "TYPE_MESSAGE",
	12: "TYPE_BYTES",
	13: "TYPE_UINT32",
	14: "TYPE_ENUM",
	15: "TYPE_SFIXED32",
	16: "TYPE_SFIXED64",
	17: "TYPE_SINT32",
	18: "TYPE_SINT64",
}
View Source
var FieldDescriptorProto_Type_value = map[string]int32{
	"TYPE_DOUBLE":   1,
	"TYPE_FLOAT":    2,
	"TYPE_INT64":    3,
	"TYPE_UINT64":   4,
	"TYPE_INT32":    5,
	"TYPE_FIXED64":  6,
	"TYPE_FIXED32":  7,
	"TYPE_BOOL":     8,
	"TYPE_STRING":   9,
	"TYPE_GROUP":    10,
	"TYPE_MESSAGE":  11,
	"TYPE_BYTES":    12,
	"TYPE_UINT32":   13,
	"TYPE_ENUM":     14,
	"TYPE_SFIXED32": 15,
	"TYPE_SFIXED64": 16,
	"TYPE_SINT32":   17,
	"TYPE_SINT64":   18,
}
View Source
var FieldOptions_CType_name = map[int32]string{
	0: "STRING",
	1: "CORD",
	2: "STRING_PIECE",
}
View Source
var FieldOptions_CType_value = map[string]int32{
	"STRING":       0,
	"CORD":         1,
	"STRING_PIECE": 2,
}
View Source
var FileOptions_OptimizeMode_name = map[int32]string{
	1: "SPEED",
	2: "CODE_SIZE",
	3: "LITE_RUNTIME",
}
View Source
var FileOptions_OptimizeMode_value = map[string]int32{
	"SPEED":        1,
	"CODE_SIZE":    2,
	"LITE_RUNTIME": 3,
}

Functions

This section is empty.

Types

type DescriptorProto

type DescriptorProto struct {
	Name             *string                           `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Field            []*FieldDescriptorProto           `protobuf:"bytes,2,rep,name=field" json:"field,omitempty"`
	Extension        []*FieldDescriptorProto           `protobuf:"bytes,6,rep,name=extension" json:"extension,omitempty"`
	NestedType       []*DescriptorProto                `protobuf:"bytes,3,rep,name=nested_type" json:"nested_type,omitempty"`
	EnumType         []*EnumDescriptorProto            `protobuf:"bytes,4,rep,name=enum_type" json:"enum_type,omitempty"`
	ExtensionRange   []*DescriptorProto_ExtensionRange `protobuf:"bytes,5,rep,name=extension_range" json:"extension_range,omitempty"`
	Options          *MessageOptions                   `protobuf:"bytes,7,opt,name=options" json:"options,omitempty"`
	XXX_unrecognized []byte                            `json:"-"`
}

Describes a message type.

func (*DescriptorProto) GetEnumType

func (m *DescriptorProto) GetEnumType() []*EnumDescriptorProto

func (*DescriptorProto) GetExtension

func (m *DescriptorProto) GetExtension() []*FieldDescriptorProto

func (*DescriptorProto) GetExtensionRange

func (m *DescriptorProto) GetExtensionRange() []*DescriptorProto_ExtensionRange

func (*DescriptorProto) GetField

func (m *DescriptorProto) GetField() []*FieldDescriptorProto

func (*DescriptorProto) GetName

func (m *DescriptorProto) GetName() string

func (*DescriptorProto) GetNestedType

func (m *DescriptorProto) GetNestedType() []*DescriptorProto

func (*DescriptorProto) GetOptions

func (m *DescriptorProto) GetOptions() *MessageOptions

func (*DescriptorProto) ProtoMessage

func (*DescriptorProto) ProtoMessage()

func (*DescriptorProto) Reset

func (m *DescriptorProto) Reset()

func (*DescriptorProto) String

func (m *DescriptorProto) String() string

type DescriptorProto_ExtensionRange

type DescriptorProto_ExtensionRange struct {
	Start            *int32 `protobuf:"varint,1,opt,name=start" json:"start,omitempty"`
	End              *int32 `protobuf:"varint,2,opt,name=end" json:"end,omitempty"`
	XXX_unrecognized []byte `json:"-"`
}

func (*DescriptorProto_ExtensionRange) GetEnd

func (*DescriptorProto_ExtensionRange) GetStart

func (m *DescriptorProto_ExtensionRange) GetStart() int32

func (*DescriptorProto_ExtensionRange) ProtoMessage

func (*DescriptorProto_ExtensionRange) ProtoMessage()

func (*DescriptorProto_ExtensionRange) Reset

func (m *DescriptorProto_ExtensionRange) Reset()

func (*DescriptorProto_ExtensionRange) String

type EnumDescriptorProto

type EnumDescriptorProto struct {
	Name             *string                     `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Value            []*EnumValueDescriptorProto `protobuf:"bytes,2,rep,name=value" json:"value,omitempty"`
	Options          *EnumOptions                `protobuf:"bytes,3,opt,name=options" json:"options,omitempty"`
	XXX_unrecognized []byte                      `json:"-"`
}

Describes an enum type.

func (*EnumDescriptorProto) GetName

func (m *EnumDescriptorProto) GetName() string

func (*EnumDescriptorProto) GetOptions

func (m *EnumDescriptorProto) GetOptions() *EnumOptions

func (*EnumDescriptorProto) GetValue

func (*EnumDescriptorProto) ProtoMessage

func (*EnumDescriptorProto) ProtoMessage()

func (*EnumDescriptorProto) Reset

func (m *EnumDescriptorProto) Reset()

func (*EnumDescriptorProto) String

func (m *EnumDescriptorProto) String() string

type EnumOptions

type EnumOptions struct {
	// Set this option to false to disallow mapping different tag names to a same
	// value.
	AllowAlias *bool `protobuf:"varint,2,opt,name=allow_alias,def=1" json:"allow_alias,omitempty"`
	// The parser stores options it doesn't recognize here. See above.
	UninterpretedOption []*UninterpretedOption    `protobuf:"bytes,999,rep,name=uninterpreted_option" json:"uninterpreted_option,omitempty"`
	XXX_extensions      map[int32]proto.Extension `json:"-"`
	XXX_unrecognized    []byte                    `json:"-"`
}

func (*EnumOptions) ExtensionMap

func (m *EnumOptions) ExtensionMap() map[int32]proto.Extension

func (*EnumOptions) ExtensionRangeArray

func (*EnumOptions) ExtensionRangeArray() []proto.ExtensionRange

func (*EnumOptions) GetAllowAlias

func (m *EnumOptions) GetAllowAlias() bool

func (*EnumOptions) GetUninterpretedOption

func (m *EnumOptions) GetUninterpretedOption() []*UninterpretedOption

func (*EnumOptions) ProtoMessage

func (*EnumOptions) ProtoMessage()

func (*EnumOptions) Reset

func (m *EnumOptions) Reset()

func (*EnumOptions) String

func (m *EnumOptions) String() string

type EnumValueDescriptorProto

type EnumValueDescriptorProto struct {
	Name             *string           `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Number           *int32            `protobuf:"varint,2,opt,name=number" json:"number,omitempty"`
	Options          *EnumValueOptions `protobuf:"bytes,3,opt,name=options" json:"options,omitempty"`
	XXX_unrecognized []byte            `json:"-"`
}

Describes a value within an enum.

func (*EnumValueDescriptorProto) GetName

func (m *EnumValueDescriptorProto) GetName() string

func (*EnumValueDescriptorProto) GetNumber

func (m *EnumValueDescriptorProto) GetNumber() int32

func (*EnumValueDescriptorProto) GetOptions

func (m *EnumValueDescriptorProto) GetOptions() *EnumValueOptions

func (*EnumValueDescriptorProto) ProtoMessage

func (*EnumValueDescriptorProto) ProtoMessage()

func (*EnumValueDescriptorProto) Reset

func (m *EnumValueDescriptorProto) Reset()

func (*EnumValueDescriptorProto) String

func (m *EnumValueDescriptorProto) String() string

type EnumValueOptions

type EnumValueOptions struct {
	// The parser stores options it doesn't recognize here. See above.
	UninterpretedOption []*UninterpretedOption    `protobuf:"bytes,999,rep,name=uninterpreted_option" json:"uninterpreted_option,omitempty"`
	XXX_extensions      map[int32]proto.Extension `json:"-"`
	XXX_unrecognized    []byte                    `json:"-"`
}

func (*EnumValueOptions) ExtensionMap

func (m *EnumValueOptions) ExtensionMap() map[int32]proto.Extension

func (*EnumValueOptions) ExtensionRangeArray

func (*EnumValueOptions) ExtensionRangeArray() []proto.ExtensionRange

func (*EnumValueOptions) GetUninterpretedOption

func (m *EnumValueOptions) GetUninterpretedOption() []*UninterpretedOption

func (*EnumValueOptions) ProtoMessage

func (*EnumValueOptions) ProtoMessage()

func (*EnumValueOptions) Reset

func (m *EnumValueOptions) Reset()

func (*EnumValueOptions) String

func (m *EnumValueOptions) String() string

type FieldDescriptorProto

type FieldDescriptorProto struct {
	Name   *string                     `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Number *int32                      `protobuf:"varint,3,opt,name=number" json:"number,omitempty"`
	Label  *FieldDescriptorProto_Label `protobuf:"varint,4,opt,name=label,enum=google.protobuf.FieldDescriptorProto_Label" json:"label,omitempty"`
	// If type_name is set, this need not be set.  If both this and type_name
	// are set, this must be either TYPE_ENUM or TYPE_MESSAGE.
	Type *FieldDescriptorProto_Type `protobuf:"varint,5,opt,name=type,enum=google.protobuf.FieldDescriptorProto_Type" json:"type,omitempty"`
	// For message and enum types, this is the name of the type.  If the name
	// starts with a '.', it is fully-qualified.  Otherwise, C++-like scoping
	// rules are used to find the type (i.e. first the nested types within this
	// message are searched, then within the parent, on up to the root
	// namespace).
	TypeName *string `protobuf:"bytes,6,opt,name=type_name" json:"type_name,omitempty"`
	// For extensions, this is the name of the type being extended.  It is
	// resolved in the same manner as type_name.
	Extendee *string `protobuf:"bytes,2,opt,name=extendee" json:"extendee,omitempty"`
	// For numeric types, contains the original text representation of the value.
	// For booleans, "true" or "false".
	// For strings, contains the default text contents (not escaped in any way).
	// For bytes, contains the C escaped value.  All bytes >= 128 are escaped.
	// TODO(kenton):  Base-64 encode?
	DefaultValue     *string       `protobuf:"bytes,7,opt,name=default_value" json:"default_value,omitempty"`
	Options          *FieldOptions `protobuf:"bytes,8,opt,name=options" json:"options,omitempty"`
	XXX_unrecognized []byte        `json:"-"`
}

Describes a field within a message.

func (*FieldDescriptorProto) GetDefaultValue

func (m *FieldDescriptorProto) GetDefaultValue() string

func (*FieldDescriptorProto) GetExtendee

func (m *FieldDescriptorProto) GetExtendee() string

func (*FieldDescriptorProto) GetLabel

func (*FieldDescriptorProto) GetName

func (m *FieldDescriptorProto) GetName() string

func (*FieldDescriptorProto) GetNumber

func (m *FieldDescriptorProto) GetNumber() int32

func (*FieldDescriptorProto) GetOptions

func (m *FieldDescriptorProto) GetOptions() *FieldOptions

func (*FieldDescriptorProto) GetType

func (*FieldDescriptorProto) GetTypeName

func (m *FieldDescriptorProto) GetTypeName() string

func (*FieldDescriptorProto) ProtoMessage

func (*FieldDescriptorProto) ProtoMessage()

func (*FieldDescriptorProto) Reset

func (m *FieldDescriptorProto) Reset()

func (*FieldDescriptorProto) String

func (m *FieldDescriptorProto) String() string

type FieldDescriptorProto_Label

type FieldDescriptorProto_Label int32
const (
	// 0 is reserved for errors
	FieldDescriptorProto_LABEL_OPTIONAL FieldDescriptorProto_Label = 1
	FieldDescriptorProto_LABEL_REQUIRED FieldDescriptorProto_Label = 2
	FieldDescriptorProto_LABEL_REPEATED FieldDescriptorProto_Label = 3
)

func (FieldDescriptorProto_Label) Enum

func (FieldDescriptorProto_Label) String

func (*FieldDescriptorProto_Label) UnmarshalJSON

func (x *FieldDescriptorProto_Label) UnmarshalJSON(data []byte) error

type FieldDescriptorProto_Type

type FieldDescriptorProto_Type int32
const (
	// 0 is reserved for errors.
	// Order is weird for historical reasons.
	FieldDescriptorProto_TYPE_DOUBLE FieldDescriptorProto_Type = 1
	FieldDescriptorProto_TYPE_FLOAT  FieldDescriptorProto_Type = 2
	// Not ZigZag encoded.  Negative numbers take 10 bytes.  Use TYPE_SINT64 if
	// negative values are likely.
	FieldDescriptorProto_TYPE_INT64  FieldDescriptorProto_Type = 3
	FieldDescriptorProto_TYPE_UINT64 FieldDescriptorProto_Type = 4
	// Not ZigZag encoded.  Negative numbers take 10 bytes.  Use TYPE_SINT32 if
	// negative values are likely.
	FieldDescriptorProto_TYPE_INT32   FieldDescriptorProto_Type = 5
	FieldDescriptorProto_TYPE_FIXED64 FieldDescriptorProto_Type = 6
	FieldDescriptorProto_TYPE_FIXED32 FieldDescriptorProto_Type = 7
	FieldDescriptorProto_TYPE_BOOL    FieldDescriptorProto_Type = 8
	FieldDescriptorProto_TYPE_STRING  FieldDescriptorProto_Type = 9
	FieldDescriptorProto_TYPE_GROUP   FieldDescriptorProto_Type = 10
	FieldDescriptorProto_TYPE_MESSAGE FieldDescriptorProto_Type = 11
	// New in version 2.
	FieldDescriptorProto_TYPE_BYTES    FieldDescriptorProto_Type = 12
	FieldDescriptorProto_TYPE_UINT32   FieldDescriptorProto_Type = 13
	FieldDescriptorProto_TYPE_ENUM     FieldDescriptorProto_Type = 14
	FieldDescriptorProto_TYPE_SFIXED32 FieldDescriptorProto_Type = 15
	FieldDescriptorProto_TYPE_SFIXED64 FieldDescriptorProto_Type = 16
	FieldDescriptorProto_TYPE_SINT32   FieldDescriptorProto_Type = 17
	FieldDescriptorProto_TYPE_SINT64   FieldDescriptorProto_Type = 18
)

func (FieldDescriptorProto_Type) Enum

func (FieldDescriptorProto_Type) String

func (x FieldDescriptorProto_Type) String() string

func (*FieldDescriptorProto_Type) UnmarshalJSON

func (x *FieldDescriptorProto_Type) UnmarshalJSON(data []byte) error

type FieldOptions

type FieldOptions struct {
	// The ctype option instructs the C++ code generator to use a different
	// representation of the field than it normally would.  See the specific
	// options below.  This option is not yet implemented in the open source
	// release -- sorry, we'll try to include it in a future version!
	Ctype *FieldOptions_CType `protobuf:"varint,1,opt,name=ctype,enum=google.protobuf.FieldOptions_CType,def=0" json:"ctype,omitempty"`
	// The packed option can be enabled for repeated primitive fields to enable
	// a more efficient representation on the wire. Rather than repeatedly
	// writing the tag and type for each element, the entire array is encoded as
	// a single length-delimited blob.
	Packed *bool `protobuf:"varint,2,opt,name=packed" json:"packed,omitempty"`
	// Should this field be parsed lazily?  Lazy applies only to message-type
	// fields.  It means that when the outer message is initially parsed, the
	// inner message's contents will not be parsed but instead stored in encoded
	// form.  The inner message will actually be parsed when it is first accessed.
	//
	// This is only a hint.  Implementations are free to choose whether to use
	// eager or lazy parsing regardless of the value of this option.  However,
	// setting this option true suggests that the protocol author believes that
	// using lazy parsing on this field is worth the additional bookkeeping
	// overhead typically needed to implement it.
	//
	// This option does not affect the public interface of any generated code;
	// all method signatures remain the same.  Furthermore, thread-safety of the
	// interface is not affected by this option; const methods remain safe to
	// call from multiple threads concurrently, while non-const methods continue
	// to require exclusive access.
	//
	//
	// Note that implementations may choose not to check required fields within
	// a lazy sub-message.  That is, calling IsInitialized() on the outher message
	// may return true even if the inner message has missing required fields.
	// This is necessary because otherwise the inner message would have to be
	// parsed in order to perform the check, defeating the purpose of lazy
	// parsing.  An implementation which chooses not to check required fields
	// must be consistent about it.  That is, for any particular sub-message, the
	// implementation must either *always* check its required fields, or *never*
	// check its required fields, regardless of whether or not the message has
	// been parsed.
	Lazy *bool `protobuf:"varint,5,opt,name=lazy,def=0" json:"lazy,omitempty"`
	// Is this field deprecated?
	// Depending on the target platform, this can emit Deprecated annotations
	// for accessors, or it will be completely ignored; in the very least, this
	// is a formalization for deprecating fields.
	Deprecated *bool `protobuf:"varint,3,opt,name=deprecated,def=0" json:"deprecated,omitempty"`
	// EXPERIMENTAL.  DO NOT USE.
	// For "map" fields, the name of the field in the enclosed type that
	// is the key for this map.  For example, suppose we have:
	//   message Item {
	//     required string name = 1;
	//     required string value = 2;
	//   }
	//   message Config {
	//     repeated Item items = 1 [experimental_map_key="name"];
	//   }
	// In this situation, the map key for Item will be set to "name".
	// TODO: Fully-implement this, then remove the "experimental_" prefix.
	ExperimentalMapKey *string `protobuf:"bytes,9,opt,name=experimental_map_key" json:"experimental_map_key,omitempty"`
	// For Google-internal migration only. Do not use.
	Weak *bool `protobuf:"varint,10,opt,name=weak,def=0" json:"weak,omitempty"`
	// The parser stores options it doesn't recognize here. See above.
	UninterpretedOption []*UninterpretedOption    `protobuf:"bytes,999,rep,name=uninterpreted_option" json:"uninterpreted_option,omitempty"`
	XXX_extensions      map[int32]proto.Extension `json:"-"`
	XXX_unrecognized    []byte                    `json:"-"`
}

func (*FieldOptions) ExtensionMap

func (m *FieldOptions) ExtensionMap() map[int32]proto.Extension

func (*FieldOptions) ExtensionRangeArray

func (*FieldOptions) ExtensionRangeArray() []proto.ExtensionRange

func (*FieldOptions) GetCtype

func (m *FieldOptions) GetCtype() FieldOptions_CType

func (*FieldOptions) GetDeprecated

func (m *FieldOptions) GetDeprecated() bool

func (*FieldOptions) GetExperimentalMapKey

func (m *FieldOptions) GetExperimentalMapKey() string

func (*FieldOptions) GetLazy

func (m *FieldOptions) GetLazy() bool

func (*FieldOptions) GetPacked

func (m *FieldOptions) GetPacked() bool

func (*FieldOptions) GetUninterpretedOption

func (m *FieldOptions) GetUninterpretedOption() []*UninterpretedOption

func (*FieldOptions) GetWeak

func (m *FieldOptions) GetWeak() bool

func (*FieldOptions) ProtoMessage

func (*FieldOptions) ProtoMessage()

func (*FieldOptions) Reset

func (m *FieldOptions) Reset()

func (*FieldOptions) String

func (m *FieldOptions) String() string

type FieldOptions_CType

type FieldOptions_CType int32
const (
	// Default mode.
	FieldOptions_STRING       FieldOptions_CType = 0
	FieldOptions_CORD         FieldOptions_CType = 1
	FieldOptions_STRING_PIECE FieldOptions_CType = 2
)
const Default_FieldOptions_Ctype FieldOptions_CType = FieldOptions_STRING

func (FieldOptions_CType) Enum

func (FieldOptions_CType) String

func (x FieldOptions_CType) String() string

func (*FieldOptions_CType) UnmarshalJSON

func (x *FieldOptions_CType) UnmarshalJSON(data []byte) error

type FileDescriptorProto

type FileDescriptorProto struct {
	Name    *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Package *string `protobuf:"bytes,2,opt,name=package" json:"package,omitempty"`
	// Names of files imported by this file.
	Dependency []string `protobuf:"bytes,3,rep,name=dependency" json:"dependency,omitempty"`
	// Indexes of the public imported files in the dependency list above.
	PublicDependency []int32 `protobuf:"varint,10,rep,name=public_dependency" json:"public_dependency,omitempty"`
	// Indexes of the weak imported files in the dependency list.
	// For Google-internal migration only. Do not use.
	WeakDependency []int32 `protobuf:"varint,11,rep,name=weak_dependency" json:"weak_dependency,omitempty"`
	// All top-level definitions in this file.
	MessageType []*DescriptorProto        `protobuf:"bytes,4,rep,name=message_type" json:"message_type,omitempty"`
	EnumType    []*EnumDescriptorProto    `protobuf:"bytes,5,rep,name=enum_type" json:"enum_type,omitempty"`
	Service     []*ServiceDescriptorProto `protobuf:"bytes,6,rep,name=service" json:"service,omitempty"`
	Extension   []*FieldDescriptorProto   `protobuf:"bytes,7,rep,name=extension" json:"extension,omitempty"`
	Options     *FileOptions              `protobuf:"bytes,8,opt,name=options" json:"options,omitempty"`
	// This field contains optional information about the original source code.
	// You may safely remove this entire field whithout harming runtime
	// functionality of the descriptors -- the information is needed only by
	// development tools.
	SourceCodeInfo   *SourceCodeInfo `protobuf:"bytes,9,opt,name=source_code_info" json:"source_code_info,omitempty"`
	XXX_unrecognized []byte          `json:"-"`
}

Describes a complete .proto file.

func (*FileDescriptorProto) GetDependency

func (m *FileDescriptorProto) GetDependency() []string

func (*FileDescriptorProto) GetEnumType

func (m *FileDescriptorProto) GetEnumType() []*EnumDescriptorProto

func (*FileDescriptorProto) GetExtension

func (m *FileDescriptorProto) GetExtension() []*FieldDescriptorProto

func (*FileDescriptorProto) GetMessageType

func (m *FileDescriptorProto) GetMessageType() []*DescriptorProto

func (*FileDescriptorProto) GetName

func (m *FileDescriptorProto) GetName() string

func (*FileDescriptorProto) GetOptions

func (m *FileDescriptorProto) GetOptions() *FileOptions

func (*FileDescriptorProto) GetPackage

func (m *FileDescriptorProto) GetPackage() string

func (*FileDescriptorProto) GetPublicDependency

func (m *FileDescriptorProto) GetPublicDependency() []int32

func (*FileDescriptorProto) GetService

func (m *FileDescriptorProto) GetService() []*ServiceDescriptorProto

func (*FileDescriptorProto) GetSourceCodeInfo

func (m *FileDescriptorProto) GetSourceCodeInfo() *SourceCodeInfo

func (*FileDescriptorProto) GetWeakDependency

func (m *FileDescriptorProto) GetWeakDependency() []int32

func (*FileDescriptorProto) ProtoMessage

func (*FileDescriptorProto) ProtoMessage()

func (*FileDescriptorProto) Reset

func (m *FileDescriptorProto) Reset()

func (*FileDescriptorProto) String

func (m *FileDescriptorProto) String() string

type FileDescriptorSet

type FileDescriptorSet struct {
	File             []*FileDescriptorProto `protobuf:"bytes,1,rep,name=file" json:"file,omitempty"`
	XXX_unrecognized []byte                 `json:"-"`
}

The protocol compiler can output a FileDescriptorSet containing the .proto files it parses.

func (*FileDescriptorSet) GetFile

func (m *FileDescriptorSet) GetFile() []*FileDescriptorProto

func (*FileDescriptorSet) ProtoMessage

func (*FileDescriptorSet) ProtoMessage()

func (*FileDescriptorSet) Reset

func (m *FileDescriptorSet) Reset()

func (*FileDescriptorSet) String

func (m *FileDescriptorSet) String() string

type FileOptions

type FileOptions struct {
	// Sets the Java package where classes generated from this .proto will be
	// placed.  By default, the proto package is used, but this is often
	// inappropriate because proto packages do not normally start with backwards
	// domain names.
	JavaPackage *string `protobuf:"bytes,1,opt,name=java_package" json:"java_package,omitempty"`
	// If set, all the classes from the .proto file are wrapped in a single
	// outer class with the given name.  This applies to both Proto1
	// (equivalent to the old "--one_java_file" option) and Proto2 (where
	// a .proto always translates to a single class, but you may want to
	// explicitly choose the class name).
	JavaOuterClassname *string `protobuf:"bytes,8,opt,name=java_outer_classname" json:"java_outer_classname,omitempty"`
	// If set true, then the Java code generator will generate a separate .java
	// file for each top-level message, enum, and service defined in the .proto
	// file.  Thus, these types will *not* be nested inside the outer class
	// named by java_outer_classname.  However, the outer class will still be
	// generated to contain the file's getDescriptor() method as well as any
	// top-level extensions defined in the file.
	JavaMultipleFiles *bool `protobuf:"varint,10,opt,name=java_multiple_files,def=0" json:"java_multiple_files,omitempty"`
	// If set true, then the Java code generator will generate equals() and
	// hashCode() methods for all messages defined in the .proto file. This is
	// purely a speed optimization, as the AbstractMessage base class includes
	// reflection-based implementations of these methods.
	JavaGenerateEqualsAndHash *bool                     `protobuf:"varint,20,opt,name=java_generate_equals_and_hash,def=0" json:"java_generate_equals_and_hash,omitempty"`
	OptimizeFor               *FileOptions_OptimizeMode `protobuf:"varint,9,opt,name=optimize_for,enum=google.protobuf.FileOptions_OptimizeMode,def=1" json:"optimize_for,omitempty"`
	// Sets the Go package where structs generated from this .proto will be
	// placed.  There is no default.
	GoPackage *string `protobuf:"bytes,11,opt,name=go_package" json:"go_package,omitempty"`
	// Should generic services be generated in each language?  "Generic" services
	// are not specific to any particular RPC system.  They are generated by the
	// main code generators in each language (without additional plugins).
	// Generic services were the only kind of service generation supported by
	// early versions of proto2.
	//
	// Generic services are now considered deprecated in favor of using plugins
	// that generate code specific to your particular RPC system.  Therefore,
	// these default to false.  Old code which depends on generic services should
	// explicitly set them to true.
	CcGenericServices   *bool `protobuf:"varint,16,opt,name=cc_generic_services,def=0" json:"cc_generic_services,omitempty"`
	JavaGenericServices *bool `protobuf:"varint,17,opt,name=java_generic_services,def=0" json:"java_generic_services,omitempty"`
	PyGenericServices   *bool `protobuf:"varint,18,opt,name=py_generic_services,def=0" json:"py_generic_services,omitempty"`
	// The parser stores options it doesn't recognize here. See above.
	UninterpretedOption []*UninterpretedOption    `protobuf:"bytes,999,rep,name=uninterpreted_option" json:"uninterpreted_option,omitempty"`
	XXX_extensions      map[int32]proto.Extension `json:"-"`
	XXX_unrecognized    []byte                    `json:"-"`
}

func (*FileOptions) ExtensionMap

func (m *FileOptions) ExtensionMap() map[int32]proto.Extension

func (*FileOptions) ExtensionRangeArray

func (*FileOptions) ExtensionRangeArray() []proto.ExtensionRange

func (*FileOptions) GetCcGenericServices

func (m *FileOptions) GetCcGenericServices() bool

func (*FileOptions) GetGoPackage

func (m *FileOptions) GetGoPackage() string

func (*FileOptions) GetJavaGenerateEqualsAndHash

func (m *FileOptions) GetJavaGenerateEqualsAndHash() bool

func (*FileOptions) GetJavaGenericServices

func (m *FileOptions) GetJavaGenericServices() bool

func (*FileOptions) GetJavaMultipleFiles

func (m *FileOptions) GetJavaMultipleFiles() bool

func (*FileOptions) GetJavaOuterClassname

func (m *FileOptions) GetJavaOuterClassname() string

func (*FileOptions) GetJavaPackage

func (m *FileOptions) GetJavaPackage() string

func (*FileOptions) GetOptimizeFor

func (m *FileOptions) GetOptimizeFor() FileOptions_OptimizeMode

func (*FileOptions) GetPyGenericServices

func (m *FileOptions) GetPyGenericServices() bool

func (*FileOptions) GetUninterpretedOption

func (m *FileOptions) GetUninterpretedOption() []*UninterpretedOption

func (*FileOptions) ProtoMessage

func (*FileOptions) ProtoMessage()

func (*FileOptions) Reset

func (m *FileOptions) Reset()

func (*FileOptions) String

func (m *FileOptions) String() string

type FileOptions_OptimizeMode

type FileOptions_OptimizeMode int32

Generated classes can be optimized for speed or code size.

const (
	FileOptions_SPEED FileOptions_OptimizeMode = 1
	// etc.
	FileOptions_CODE_SIZE    FileOptions_OptimizeMode = 2
	FileOptions_LITE_RUNTIME FileOptions_OptimizeMode = 3
)
const Default_FileOptions_OptimizeFor FileOptions_OptimizeMode = FileOptions_SPEED

func (FileOptions_OptimizeMode) Enum

func (FileOptions_OptimizeMode) String

func (x FileOptions_OptimizeMode) String() string

func (*FileOptions_OptimizeMode) UnmarshalJSON

func (x *FileOptions_OptimizeMode) UnmarshalJSON(data []byte) error

type MessageOptions

type MessageOptions struct {
	// Set true to use the old proto1 MessageSet wire format for extensions.
	// This is provided for backwards-compatibility with the MessageSet wire
	// format.  You should not use this for any other reason:  It's less
	// efficient, has fewer features, and is more complicated.
	//
	// The message must be defined exactly as follows:
	//   message Foo {
	//     option message_set_wire_format = true;
	//     extensions 4 to max;
	//   }
	// Note that the message cannot have any defined fields; MessageSets only
	// have extensions.
	//
	// All extensions of your type must be singular messages; e.g. they cannot
	// be int32s, enums, or repeated messages.
	//
	// Because this is an option, the above two restrictions are not enforced by
	// the protocol compiler.
	MessageSetWireFormat *bool `protobuf:"varint,1,opt,name=message_set_wire_format,def=0" json:"message_set_wire_format,omitempty"`
	// Disables the generation of the standard "descriptor()" accessor, which can
	// conflict with a field of the same name.  This is meant to make migration
	// from proto1 easier; new code should avoid fields named "descriptor".
	NoStandardDescriptorAccessor *bool `protobuf:"varint,2,opt,name=no_standard_descriptor_accessor,def=0" json:"no_standard_descriptor_accessor,omitempty"`
	// The parser stores options it doesn't recognize here. See above.
	UninterpretedOption []*UninterpretedOption    `protobuf:"bytes,999,rep,name=uninterpreted_option" json:"uninterpreted_option,omitempty"`
	XXX_extensions      map[int32]proto.Extension `json:"-"`
	XXX_unrecognized    []byte                    `json:"-"`
}

func (*MessageOptions) ExtensionMap

func (m *MessageOptions) ExtensionMap() map[int32]proto.Extension

func (*MessageOptions) ExtensionRangeArray

func (*MessageOptions) ExtensionRangeArray() []proto.ExtensionRange

func (*MessageOptions) GetMessageSetWireFormat

func (m *MessageOptions) GetMessageSetWireFormat() bool

func (*MessageOptions) GetNoStandardDescriptorAccessor

func (m *MessageOptions) GetNoStandardDescriptorAccessor() bool

func (*MessageOptions) GetUninterpretedOption

func (m *MessageOptions) GetUninterpretedOption() []*UninterpretedOption

func (*MessageOptions) ProtoMessage

func (*MessageOptions) ProtoMessage()

func (*MessageOptions) Reset

func (m *MessageOptions) Reset()

func (*MessageOptions) String

func (m *MessageOptions) String() string

type MethodDescriptorProto

type MethodDescriptorProto struct {
	Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// Input and output type names.  These are resolved in the same way as
	// FieldDescriptorProto.type_name, but must refer to a message type.
	InputType        *string        `protobuf:"bytes,2,opt,name=input_type" json:"input_type,omitempty"`
	OutputType       *string        `protobuf:"bytes,3,opt,name=output_type" json:"output_type,omitempty"`
	Options          *MethodOptions `protobuf:"bytes,4,opt,name=options" json:"options,omitempty"`
	XXX_unrecognized []byte         `json:"-"`
}

Describes a method of a service.

func (*MethodDescriptorProto) GetInputType

func (m *MethodDescriptorProto) GetInputType() string

func (*MethodDescriptorProto) GetName

func (m *MethodDescriptorProto) GetName() string

func (*MethodDescriptorProto) GetOptions

func (m *MethodDescriptorProto) GetOptions() *MethodOptions

func (*MethodDescriptorProto) GetOutputType

func (m *MethodDescriptorProto) GetOutputType() string

func (*MethodDescriptorProto) ProtoMessage

func (*MethodDescriptorProto) ProtoMessage()

func (*MethodDescriptorProto) Reset

func (m *MethodDescriptorProto) Reset()

func (*MethodDescriptorProto) String

func (m *MethodDescriptorProto) String() string

type MethodOptions

type MethodOptions struct {
	// The parser stores options it doesn't recognize here. See above.
	UninterpretedOption []*UninterpretedOption    `protobuf:"bytes,999,rep,name=uninterpreted_option" json:"uninterpreted_option,omitempty"`
	XXX_extensions      map[int32]proto.Extension `json:"-"`
	XXX_unrecognized    []byte                    `json:"-"`
}

func (*MethodOptions) ExtensionMap

func (m *MethodOptions) ExtensionMap() map[int32]proto.Extension

func (*MethodOptions) ExtensionRangeArray

func (*MethodOptions) ExtensionRangeArray() []proto.ExtensionRange

func (*MethodOptions) GetUninterpretedOption

func (m *MethodOptions) GetUninterpretedOption() []*UninterpretedOption

func (*MethodOptions) ProtoMessage

func (*MethodOptions) ProtoMessage()

func (*MethodOptions) Reset

func (m *MethodOptions) Reset()

func (*MethodOptions) String

func (m *MethodOptions) String() string

type ServiceDescriptorProto

type ServiceDescriptorProto struct {
	Name             *string                  `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Method           []*MethodDescriptorProto `protobuf:"bytes,2,rep,name=method" json:"method,omitempty"`
	Options          *ServiceOptions          `protobuf:"bytes,3,opt,name=options" json:"options,omitempty"`
	XXX_unrecognized []byte                   `json:"-"`
}

Describes a service.

func (*ServiceDescriptorProto) GetMethod

func (*ServiceDescriptorProto) GetName

func (m *ServiceDescriptorProto) GetName() string

func (*ServiceDescriptorProto) GetOptions

func (m *ServiceDescriptorProto) GetOptions() *ServiceOptions

func (*ServiceDescriptorProto) ProtoMessage

func (*ServiceDescriptorProto) ProtoMessage()

func (*ServiceDescriptorProto) Reset

func (m *ServiceDescriptorProto) Reset()

func (*ServiceDescriptorProto) String

func (m *ServiceDescriptorProto) String() string

type ServiceOptions

type ServiceOptions struct {
	// The parser stores options it doesn't recognize here. See above.
	UninterpretedOption []*UninterpretedOption    `protobuf:"bytes,999,rep,name=uninterpreted_option" json:"uninterpreted_option,omitempty"`
	XXX_extensions      map[int32]proto.Extension `json:"-"`
	XXX_unrecognized    []byte                    `json:"-"`
}

func (*ServiceOptions) ExtensionMap

func (m *ServiceOptions) ExtensionMap() map[int32]proto.Extension

func (*ServiceOptions) ExtensionRangeArray

func (*ServiceOptions) ExtensionRangeArray() []proto.ExtensionRange

func (*ServiceOptions) GetUninterpretedOption

func (m *ServiceOptions) GetUninterpretedOption() []*UninterpretedOption

func (*ServiceOptions) ProtoMessage

func (*ServiceOptions) ProtoMessage()

func (*ServiceOptions) Reset

func (m *ServiceOptions) Reset()

func (*ServiceOptions) String

func (m *ServiceOptions) String() string

type SourceCodeInfo

type SourceCodeInfo struct {
	// A Location identifies a piece of source code in a .proto file which
	// corresponds to a particular definition.  This information is intended
	// to be useful to IDEs, code indexers, documentation generators, and similar
	// tools.
	//
	// For example, say we have a file like:
	//   message Foo {
	//     optional string foo = 1;
	//   }
	// Let's look at just the field definition:
	//   optional string foo = 1;
	//   ^       ^^     ^^  ^  ^^^
	//   a       bc     de  f  ghi
	// We have the following locations:
	//   span   path               represents
	//   [a,i)  [ 4, 0, 2, 0 ]     The whole field definition.
	//   [a,b)  [ 4, 0, 2, 0, 4 ]  The label (optional).
	//   [c,d)  [ 4, 0, 2, 0, 5 ]  The type (string).
	//   [e,f)  [ 4, 0, 2, 0, 1 ]  The name (foo).
	//   [g,h)  [ 4, 0, 2, 0, 3 ]  The number (1).
	//
	// Notes:
	// - A location may refer to a repeated field itself (i.e. not to any
	//   particular index within it).  This is used whenever a set of elements are
	//   logically enclosed in a single code segment.  For example, an entire
	//   extend block (possibly containing multiple extension definitions) will
	//   have an outer location whose path refers to the "extensions" repeated
	//   field without an index.
	// - Multiple locations may have the same path.  This happens when a single
	//   logical declaration is spread out across multiple places.  The most
	//   obvious example is the "extend" block again -- there may be multiple
	//   extend blocks in the same scope, each of which will have the same path.
	// - A location's span is not always a subset of its parent's span.  For
	//   example, the "extendee" of an extension declaration appears at the
	//   beginning of the "extend" block and is shared by all extensions within
	//   the block.
	// - Just because a location's span is a subset of some other location's span
	//   does not mean that it is a descendent.  For example, a "group" defines
	//   both a type and a field in a single declaration.  Thus, the locations
	//   corresponding to the type and field and their components will overlap.
	// - Code which tries to interpret locations should probably be designed to
	//   ignore those that it doesn't understand, as more types of locations could
	//   be recorded in the future.
	Location         []*SourceCodeInfo_Location `protobuf:"bytes,1,rep,name=location" json:"location,omitempty"`
	XXX_unrecognized []byte                     `json:"-"`
}

Encapsulates information about the original source file from which a FileDescriptorProto was generated.

func (*SourceCodeInfo) GetLocation

func (m *SourceCodeInfo) GetLocation() []*SourceCodeInfo_Location

func (*SourceCodeInfo) ProtoMessage

func (*SourceCodeInfo) ProtoMessage()

func (*SourceCodeInfo) Reset

func (m *SourceCodeInfo) Reset()

func (*SourceCodeInfo) String

func (m *SourceCodeInfo) String() string

type SourceCodeInfo_Location

type SourceCodeInfo_Location struct {
	// Identifies which part of the FileDescriptorProto was defined at this
	// location.
	//
	// Each element is a field number or an index.  They form a path from
	// the root FileDescriptorProto to the place where the definition.  For
	// example, this path:
	//   [ 4, 3, 2, 7, 1 ]
	// refers to:
	//   file.message_type(3)  // 4, 3
	//       .field(7)         // 2, 7
	//       .name()           // 1
	// This is because FileDescriptorProto.message_type has field number 4:
	//   repeated DescriptorProto message_type = 4;
	// and DescriptorProto.field has field number 2:
	//   repeated FieldDescriptorProto field = 2;
	// and FieldDescriptorProto.name has field number 1:
	//   optional string name = 1;
	//
	// Thus, the above path gives the location of a field name.  If we removed
	// the last element:
	//   [ 4, 3, 2, 7 ]
	// this path refers to the whole field declaration (from the beginning
	// of the label to the terminating semicolon).
	Path []int32 `protobuf:"varint,1,rep,packed,name=path" json:"path,omitempty"`
	// Always has exactly three or four elements: start line, start column,
	// end line (optional, otherwise assumed same as start line), end column.
	// These are packed into a single field for efficiency.  Note that line
	// and column numbers are zero-based -- typically you will want to add
	// 1 to each before displaying to a user.
	Span []int32 `protobuf:"varint,2,rep,packed,name=span" json:"span,omitempty"`
	// If this SourceCodeInfo represents a complete declaration, these are any
	// comments appearing before and after the declaration which appear to be
	// attached to the declaration.
	//
	// A series of line comments appearing on consecutive lines, with no other
	// tokens appearing on those lines, will be treated as a single comment.
	//
	// Only the comment content is provided; comment markers (e.g. //) are
	// stripped out.  For block comments, leading whitespace and an asterisk
	// will be stripped from the beginning of each line other than the first.
	// Newlines are included in the output.
	//
	// Examples:
	//
	//   optional int32 foo = 1;  // Comment attached to foo.
	//   // Comment attached to bar.
	//   optional int32 bar = 2;
	//
	//   optional string baz = 3;
	//   // Comment attached to baz.
	//   // Another line attached to baz.
	//
	//   // Comment attached to qux.
	//   //
	//   // Another line attached to qux.
	//   optional double qux = 4;
	//
	//   optional string corge = 5;
	//   /* Block comment attached
	//    * to corge.  Leading asterisks
	//    * will be removed. */
	//   /* Block comment attached to
	//    * grault. */
	//   optional int32 grault = 6;
	LeadingComments  *string `protobuf:"bytes,3,opt,name=leading_comments" json:"leading_comments,omitempty"`
	TrailingComments *string `protobuf:"bytes,4,opt,name=trailing_comments" json:"trailing_comments,omitempty"`
	XXX_unrecognized []byte  `json:"-"`
}

func (*SourceCodeInfo_Location) GetLeadingComments

func (m *SourceCodeInfo_Location) GetLeadingComments() string

func (*SourceCodeInfo_Location) GetPath

func (m *SourceCodeInfo_Location) GetPath() []int32

func (*SourceCodeInfo_Location) GetSpan

func (m *SourceCodeInfo_Location) GetSpan() []int32

func (*SourceCodeInfo_Location) GetTrailingComments

func (m *SourceCodeInfo_Location) GetTrailingComments() string

func (*SourceCodeInfo_Location) ProtoMessage

func (*SourceCodeInfo_Location) ProtoMessage()

func (*SourceCodeInfo_Location) Reset

func (m *SourceCodeInfo_Location) Reset()

func (*SourceCodeInfo_Location) String

func (m *SourceCodeInfo_Location) String() string

type UninterpretedOption

type UninterpretedOption struct {
	Name []*UninterpretedOption_NamePart `protobuf:"bytes,2,rep,name=name" json:"name,omitempty"`
	// The value of the uninterpreted option, in whatever type the tokenizer
	// identified it as during parsing. Exactly one of these should be set.
	IdentifierValue  *string  `protobuf:"bytes,3,opt,name=identifier_value" json:"identifier_value,omitempty"`
	PositiveIntValue *uint64  `protobuf:"varint,4,opt,name=positive_int_value" json:"positive_int_value,omitempty"`
	NegativeIntValue *int64   `protobuf:"varint,5,opt,name=negative_int_value" json:"negative_int_value,omitempty"`
	DoubleValue      *float64 `protobuf:"fixed64,6,opt,name=double_value" json:"double_value,omitempty"`
	StringValue      []byte   `protobuf:"bytes,7,opt,name=string_value" json:"string_value,omitempty"`
	AggregateValue   *string  `protobuf:"bytes,8,opt,name=aggregate_value" json:"aggregate_value,omitempty"`
	XXX_unrecognized []byte   `json:"-"`
}

A message representing a option the parser does not recognize. This only appears in options protos created by the compiler::Parser class. DescriptorPool resolves these when building Descriptor objects. Therefore, options protos in descriptor objects (e.g. returned by Descriptor::options(), or produced by Descriptor::CopyTo()) will never have UninterpretedOptions in them.

func (*UninterpretedOption) GetAggregateValue

func (m *UninterpretedOption) GetAggregateValue() string

func (*UninterpretedOption) GetDoubleValue

func (m *UninterpretedOption) GetDoubleValue() float64

func (*UninterpretedOption) GetIdentifierValue

func (m *UninterpretedOption) GetIdentifierValue() string

func (*UninterpretedOption) GetName

func (*UninterpretedOption) GetNegativeIntValue

func (m *UninterpretedOption) GetNegativeIntValue() int64

func (*UninterpretedOption) GetPositiveIntValue

func (m *UninterpretedOption) GetPositiveIntValue() uint64

func (*UninterpretedOption) GetStringValue

func (m *UninterpretedOption) GetStringValue() []byte

func (*UninterpretedOption) ProtoMessage

func (*UninterpretedOption) ProtoMessage()

func (*UninterpretedOption) Reset

func (m *UninterpretedOption) Reset()

func (*UninterpretedOption) String

func (m *UninterpretedOption) String() string

type UninterpretedOption_NamePart

type UninterpretedOption_NamePart struct {
	NamePart         *string `protobuf:"bytes,1,req,name=name_part" json:"name_part,omitempty"`
	IsExtension      *bool   `protobuf:"varint,2,req,name=is_extension" json:"is_extension,omitempty"`
	XXX_unrecognized []byte  `json:"-"`
}

The name of the uninterpreted option. Each string represents a segment in a dot-separated name. is_extension is true iff a segment represents an extension (denoted with parentheses in options specs in .proto files). E.g.,{ ["foo", false], ["bar.baz", true], ["qux", false] } represents "foo.(bar.baz).qux".

func (*UninterpretedOption_NamePart) GetIsExtension

func (m *UninterpretedOption_NamePart) GetIsExtension() bool

func (*UninterpretedOption_NamePart) GetNamePart

func (m *UninterpretedOption_NamePart) GetNamePart() string

func (*UninterpretedOption_NamePart) ProtoMessage

func (*UninterpretedOption_NamePart) ProtoMessage()

func (*UninterpretedOption_NamePart) Reset

func (m *UninterpretedOption_NamePart) Reset()

func (*UninterpretedOption_NamePart) String

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL