package descriptorpb

Import Path
	google.golang.org/protobuf/types/descriptorpb (on go.dev)

Dependency Relation
	imports 5 packages, and imported by 3 packages

Involved Source Files descriptor.pb.go
Package-Level Type Names (total 54)
/* sort by: | */
Describes a message type. EnumType []*EnumDescriptorProto Extension []*FieldDescriptorProto ExtensionRange []*DescriptorProto_ExtensionRange Field []*FieldDescriptorProto Name *string NestedType []*DescriptorProto OneofDecl []*OneofDescriptorProto Options *MessageOptions Reserved field names, which may not be used by fields in the same message. A given name may only be reserved once. ReservedRange []*DescriptorProto_ReservedRange Support for `export` and `local` keywords on enums. Deprecated: Use DescriptorProto.ProtoReflect.Descriptor instead. (*DescriptorProto) GetEnumType() []*EnumDescriptorProto (*DescriptorProto) GetExtension() []*FieldDescriptorProto (*DescriptorProto) GetExtensionRange() []*DescriptorProto_ExtensionRange (*DescriptorProto) GetField() []*FieldDescriptorProto (*DescriptorProto) GetName() string (*DescriptorProto) GetNestedType() []*DescriptorProto (*DescriptorProto) GetOneofDecl() []*OneofDescriptorProto (*DescriptorProto) GetOptions() *MessageOptions (*DescriptorProto) GetReservedName() []string (*DescriptorProto) GetReservedRange() []*DescriptorProto_ReservedRange (*DescriptorProto) GetVisibility() SymbolVisibility (*DescriptorProto) ProtoMessage() (*DescriptorProto) ProtoReflect() protoreflect.Message (*DescriptorProto) Reset() (*DescriptorProto) String() string *DescriptorProto : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *DescriptorProto : google.golang.org/protobuf/runtime/protoiface.MessageV1 *DescriptorProto : expvar.Var *DescriptorProto : fmt.Stringer *DescriptorProto : github.com/gogo/protobuf/proto.Message func (*DescriptorProto).GetNestedType() []*DescriptorProto func (*FileDescriptorProto).GetMessageType() []*DescriptorProto func google.golang.org/protobuf/reflect/protodesc.ToDescriptorProto(message protoreflect.MessageDescriptor) *DescriptorProto
// Exclusive. Options *ExtensionRangeOptions // Inclusive. Deprecated: Use DescriptorProto_ExtensionRange.ProtoReflect.Descriptor instead. (*DescriptorProto_ExtensionRange) GetEnd() int32 (*DescriptorProto_ExtensionRange) GetOptions() *ExtensionRangeOptions (*DescriptorProto_ExtensionRange) GetStart() int32 (*DescriptorProto_ExtensionRange) ProtoMessage() (*DescriptorProto_ExtensionRange) ProtoReflect() protoreflect.Message (*DescriptorProto_ExtensionRange) Reset() (*DescriptorProto_ExtensionRange) String() string *DescriptorProto_ExtensionRange : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *DescriptorProto_ExtensionRange : google.golang.org/protobuf/runtime/protoiface.MessageV1 *DescriptorProto_ExtensionRange : expvar.Var *DescriptorProto_ExtensionRange : fmt.Stringer *DescriptorProto_ExtensionRange : github.com/gogo/protobuf/proto.Message func (*DescriptorProto).GetExtensionRange() []*DescriptorProto_ExtensionRange
Range of reserved tag numbers. Reserved tag numbers may not be used by fields or extension ranges in the same message. Reserved ranges may not overlap. // Exclusive. // Inclusive. Deprecated: Use DescriptorProto_ReservedRange.ProtoReflect.Descriptor instead. (*DescriptorProto_ReservedRange) GetEnd() int32 (*DescriptorProto_ReservedRange) GetStart() int32 (*DescriptorProto_ReservedRange) ProtoMessage() (*DescriptorProto_ReservedRange) ProtoReflect() protoreflect.Message (*DescriptorProto_ReservedRange) Reset() (*DescriptorProto_ReservedRange) String() string *DescriptorProto_ReservedRange : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *DescriptorProto_ReservedRange : google.golang.org/protobuf/runtime/protoiface.MessageV1 *DescriptorProto_ReservedRange : expvar.Var *DescriptorProto_ReservedRange : fmt.Stringer *DescriptorProto_ReservedRange : github.com/gogo/protobuf/proto.Message func (*DescriptorProto).GetReservedRange() []*DescriptorProto_ReservedRange
The full set of known editions. ( Edition) Descriptor() protoreflect.EnumDescriptor ( Edition) Enum() *Edition Deprecated: Use Edition.Descriptor instead. ( Edition) Number() protoreflect.EnumNumber ( Edition) String() string ( Edition) Type() protoreflect.EnumType Deprecated: Do not use. Edition : google.golang.org/protobuf/reflect/protoreflect.Enum *Edition : encoding/json.Unmarshaler Edition : expvar.Var Edition : fmt.Stringer *Edition : github.com/goccy/go-json.Unmarshaler func Edition.Enum() *Edition func (*FeatureSetDefaults).GetMaximumEdition() Edition func (*FeatureSetDefaults).GetMinimumEdition() Edition func (*FeatureSetDefaults_FeatureSetEditionDefault).GetEdition() Edition func (*FieldOptions_EditionDefault).GetEdition() Edition func (*FieldOptions_FeatureSupport).GetEditionDeprecated() Edition func (*FieldOptions_FeatureSupport).GetEditionIntroduced() Edition func (*FieldOptions_FeatureSupport).GetEditionRemoved() Edition func (*FileDescriptorProto).GetEdition() Edition const Edition_EDITION_1_TEST_ONLY const Edition_EDITION_2023 const Edition_EDITION_2024 const Edition_EDITION_2_TEST_ONLY const Edition_EDITION_99997_TEST_ONLY const Edition_EDITION_99998_TEST_ONLY const Edition_EDITION_99999_TEST_ONLY const Edition_EDITION_LEGACY const Edition_EDITION_MAX const Edition_EDITION_PROTO2 const Edition_EDITION_PROTO3 const Edition_EDITION_UNKNOWN const google.golang.org/protobuf/internal/editionssupport.Maximum const google.golang.org/protobuf/internal/editionssupport.MaximumKnown const google.golang.org/protobuf/internal/editionssupport.Minimum
Describes an enum type. Name *string Options *EnumOptions Reserved enum value names, which may not be reused. A given name may only be reserved once. Range of reserved numeric values. Reserved numeric values may not be used by enum values in the same enum declaration. Reserved ranges may not overlap. Value []*EnumValueDescriptorProto Support for `export` and `local` keywords on enums. Deprecated: Use EnumDescriptorProto.ProtoReflect.Descriptor instead. (*EnumDescriptorProto) GetName() string (*EnumDescriptorProto) GetOptions() *EnumOptions (*EnumDescriptorProto) GetReservedName() []string (*EnumDescriptorProto) GetReservedRange() []*EnumDescriptorProto_EnumReservedRange (*EnumDescriptorProto) GetValue() []*EnumValueDescriptorProto (*EnumDescriptorProto) GetVisibility() SymbolVisibility (*EnumDescriptorProto) ProtoMessage() (*EnumDescriptorProto) ProtoReflect() protoreflect.Message (*EnumDescriptorProto) Reset() (*EnumDescriptorProto) String() string *EnumDescriptorProto : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *EnumDescriptorProto : google.golang.org/protobuf/runtime/protoiface.MessageV1 *EnumDescriptorProto : expvar.Var *EnumDescriptorProto : fmt.Stringer *EnumDescriptorProto : github.com/gogo/protobuf/proto.Message func (*DescriptorProto).GetEnumType() []*EnumDescriptorProto func (*FileDescriptorProto).GetEnumType() []*EnumDescriptorProto func google.golang.org/protobuf/reflect/protodesc.ToEnumDescriptorProto(enum protoreflect.EnumDescriptor) *EnumDescriptorProto
Range of reserved numeric values. Reserved values may not be used by entries in the same enum. Reserved ranges may not overlap. Note that this is distinct from DescriptorProto.ReservedRange in that it is inclusive such that it can appropriately represent the entire int32 domain. // Exclusive. // Inclusive. Deprecated: Use EnumDescriptorProto_EnumReservedRange.ProtoReflect.Descriptor instead. (*EnumDescriptorProto_EnumReservedRange) GetEnd() int32 (*EnumDescriptorProto_EnumReservedRange) GetStart() int32 (*EnumDescriptorProto_EnumReservedRange) ProtoMessage() (*EnumDescriptorProto_EnumReservedRange) ProtoReflect() protoreflect.Message (*EnumDescriptorProto_EnumReservedRange) Reset() (*EnumDescriptorProto_EnumReservedRange) String() string *EnumDescriptorProto_EnumReservedRange : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *EnumDescriptorProto_EnumReservedRange : google.golang.org/protobuf/runtime/protoiface.MessageV1 *EnumDescriptorProto_EnumReservedRange : expvar.Var *EnumDescriptorProto_EnumReservedRange : fmt.Stringer *EnumDescriptorProto_EnumReservedRange : github.com/gogo/protobuf/proto.Message func (*EnumDescriptorProto).GetReservedRange() []*EnumDescriptorProto_EnumReservedRange
Set this option to true to allow mapping different tag names to the same value. Is this enum deprecated? Depending on the target platform, this can emit Deprecated annotations for the enum, or it will be completely ignored; in the very least, this is a formalization for deprecating enums. Enable the legacy handling of JSON field name conflicts. This lowercases and strips underscored from the fields before comparison in proto3 only. The new behavior takes `json_name` into account and applies to proto2 as well. TODO Remove this legacy behavior once downstream teams have had time to migrate. Deprecated: Marked as deprecated in google/protobuf/descriptor.proto. Any features defined in the specific edition. WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language. The parser stores options it doesn't recognize here. See above. Deprecated: Use EnumOptions.ProtoReflect.Descriptor instead. (*EnumOptions) GetAllowAlias() bool (*EnumOptions) GetDeprecated() bool Deprecated: Marked as deprecated in google/protobuf/descriptor.proto. (*EnumOptions) GetFeatures() *FeatureSet (*EnumOptions) GetUninterpretedOption() []*UninterpretedOption (*EnumOptions) ProtoMessage() (*EnumOptions) ProtoReflect() protoreflect.Message (*EnumOptions) Reset() (*EnumOptions) String() string *EnumOptions : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *EnumOptions : google.golang.org/protobuf/runtime/protoiface.MessageV1 *EnumOptions : expvar.Var *EnumOptions : fmt.Stringer *EnumOptions : github.com/gogo/protobuf/proto.Message func (*EnumDescriptorProto).GetOptions() *EnumOptions
Describes a value within an enum. Name *string Number *int32 Options *EnumValueOptions Deprecated: Use EnumValueDescriptorProto.ProtoReflect.Descriptor instead. (*EnumValueDescriptorProto) GetName() string (*EnumValueDescriptorProto) GetNumber() int32 (*EnumValueDescriptorProto) GetOptions() *EnumValueOptions (*EnumValueDescriptorProto) ProtoMessage() (*EnumValueDescriptorProto) ProtoReflect() protoreflect.Message (*EnumValueDescriptorProto) Reset() (*EnumValueDescriptorProto) String() string *EnumValueDescriptorProto : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *EnumValueDescriptorProto : google.golang.org/protobuf/runtime/protoiface.MessageV1 *EnumValueDescriptorProto : expvar.Var *EnumValueDescriptorProto : fmt.Stringer *EnumValueDescriptorProto : github.com/gogo/protobuf/proto.Message func (*EnumDescriptorProto).GetValue() []*EnumValueDescriptorProto func google.golang.org/protobuf/reflect/protodesc.ToEnumValueDescriptorProto(value protoreflect.EnumValueDescriptor) *EnumValueDescriptorProto
Indicate that fields annotated with this enum value should not be printed out when using debug formats, e.g. when the field contains sensitive credentials. Is this enum value deprecated? Depending on the target platform, this can emit Deprecated annotations for the enum value, or it will be completely ignored; in the very least, this is a formalization for deprecating enum values. Information about the support window of a feature value. Any features defined in the specific edition. WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language. The parser stores options it doesn't recognize here. See above. Deprecated: Use EnumValueOptions.ProtoReflect.Descriptor instead. (*EnumValueOptions) GetDebugRedact() bool (*EnumValueOptions) GetDeprecated() bool (*EnumValueOptions) GetFeatureSupport() *FieldOptions_FeatureSupport (*EnumValueOptions) GetFeatures() *FeatureSet (*EnumValueOptions) GetUninterpretedOption() []*UninterpretedOption (*EnumValueOptions) ProtoMessage() (*EnumValueOptions) ProtoReflect() protoreflect.Message (*EnumValueOptions) Reset() (*EnumValueOptions) String() string *EnumValueOptions : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *EnumValueOptions : google.golang.org/protobuf/runtime/protoiface.MessageV1 *EnumValueOptions : expvar.Var *EnumValueOptions : fmt.Stringer *EnumValueOptions : github.com/gogo/protobuf/proto.Message func (*EnumValueDescriptorProto).GetOptions() *EnumValueOptions
For external users: DO NOT USE. We are in the process of open sourcing extension declaration and executing internal cleanups before it can be used externally. Any features defined in the specific edition. The parser stores options it doesn't recognize here. See above. The verification state of the range. TODO: flip the default to DECLARATION once all empty ranges are marked as UNVERIFIED. Deprecated: Use ExtensionRangeOptions.ProtoReflect.Descriptor instead. (*ExtensionRangeOptions) GetDeclaration() []*ExtensionRangeOptions_Declaration (*ExtensionRangeOptions) GetFeatures() *FeatureSet (*ExtensionRangeOptions) GetUninterpretedOption() []*UninterpretedOption (*ExtensionRangeOptions) GetVerification() ExtensionRangeOptions_VerificationState (*ExtensionRangeOptions) ProtoMessage() (*ExtensionRangeOptions) ProtoReflect() protoreflect.Message (*ExtensionRangeOptions) Reset() (*ExtensionRangeOptions) String() string *ExtensionRangeOptions : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *ExtensionRangeOptions : google.golang.org/protobuf/runtime/protoiface.MessageV1 *ExtensionRangeOptions : expvar.Var *ExtensionRangeOptions : fmt.Stringer *ExtensionRangeOptions : github.com/gogo/protobuf/proto.Message func (*DescriptorProto_ExtensionRange).GetOptions() *ExtensionRangeOptions
The fully-qualified name of the extension field. There must be a leading dot in front of the full name. The extension number declared within the extension range. If true, indicates that the extension must be defined as repeated. Otherwise the extension must be defined as optional. If true, indicates that the number is reserved in the extension range, and any extension field with the number will fail to compile. Set this when a declared extension field is deleted. The fully-qualified type name of the extension field. Unlike Metadata.type, Declaration.type must have a leading dot for messages and enums. Deprecated: Use ExtensionRangeOptions_Declaration.ProtoReflect.Descriptor instead. (*ExtensionRangeOptions_Declaration) GetFullName() string (*ExtensionRangeOptions_Declaration) GetNumber() int32 (*ExtensionRangeOptions_Declaration) GetRepeated() bool (*ExtensionRangeOptions_Declaration) GetReserved() bool (*ExtensionRangeOptions_Declaration) GetType() string (*ExtensionRangeOptions_Declaration) ProtoMessage() (*ExtensionRangeOptions_Declaration) ProtoReflect() protoreflect.Message (*ExtensionRangeOptions_Declaration) Reset() (*ExtensionRangeOptions_Declaration) String() string *ExtensionRangeOptions_Declaration : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *ExtensionRangeOptions_Declaration : google.golang.org/protobuf/runtime/protoiface.MessageV1 *ExtensionRangeOptions_Declaration : expvar.Var *ExtensionRangeOptions_Declaration : fmt.Stringer *ExtensionRangeOptions_Declaration : github.com/gogo/protobuf/proto.Message func (*ExtensionRangeOptions).GetDeclaration() []*ExtensionRangeOptions_Declaration
The verification state of the extension range. ( ExtensionRangeOptions_VerificationState) Descriptor() protoreflect.EnumDescriptor ( ExtensionRangeOptions_VerificationState) Enum() *ExtensionRangeOptions_VerificationState Deprecated: Use ExtensionRangeOptions_VerificationState.Descriptor instead. ( ExtensionRangeOptions_VerificationState) Number() protoreflect.EnumNumber ( ExtensionRangeOptions_VerificationState) String() string ( ExtensionRangeOptions_VerificationState) Type() protoreflect.EnumType Deprecated: Do not use. ExtensionRangeOptions_VerificationState : google.golang.org/protobuf/reflect/protoreflect.Enum *ExtensionRangeOptions_VerificationState : encoding/json.Unmarshaler ExtensionRangeOptions_VerificationState : expvar.Var ExtensionRangeOptions_VerificationState : fmt.Stringer *ExtensionRangeOptions_VerificationState : github.com/goccy/go-json.Unmarshaler func (*ExtensionRangeOptions).GetVerification() ExtensionRangeOptions_VerificationState func ExtensionRangeOptions_VerificationState.Enum() *ExtensionRangeOptions_VerificationState const Default_ExtensionRangeOptions_Verification const ExtensionRangeOptions_DECLARATION const ExtensionRangeOptions_UNVERIFIED
TODO Enums in C++ gencode (and potentially other languages) are not well scoped. This means that each of the feature enums below can clash with each other. The short names we've chosen maximize call-site readability, but leave us very open to this scenario. A future feature will be designed and implemented to handle this, hopefully before we ever hit a conflict here. DefaultSymbolVisibility *FeatureSet_VisibilityFeature_DefaultSymbolVisibility EnforceNamingStyle *FeatureSet_EnforceNamingStyle EnumType *FeatureSet_EnumType FieldPresence *FeatureSet_FieldPresence JsonFormat *FeatureSet_JsonFormat MessageEncoding *FeatureSet_MessageEncoding RepeatedFieldEncoding *FeatureSet_RepeatedFieldEncoding Utf8Validation *FeatureSet_Utf8Validation Deprecated: Use FeatureSet.ProtoReflect.Descriptor instead. (*FeatureSet) GetDefaultSymbolVisibility() FeatureSet_VisibilityFeature_DefaultSymbolVisibility (*FeatureSet) GetEnforceNamingStyle() FeatureSet_EnforceNamingStyle (*FeatureSet) GetEnumType() FeatureSet_EnumType (*FeatureSet) GetFieldPresence() FeatureSet_FieldPresence (*FeatureSet) GetJsonFormat() FeatureSet_JsonFormat (*FeatureSet) GetMessageEncoding() FeatureSet_MessageEncoding (*FeatureSet) GetRepeatedFieldEncoding() FeatureSet_RepeatedFieldEncoding (*FeatureSet) GetUtf8Validation() FeatureSet_Utf8Validation (*FeatureSet) ProtoMessage() (*FeatureSet) ProtoReflect() protoreflect.Message (*FeatureSet) Reset() (*FeatureSet) String() string *FeatureSet : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *FeatureSet : google.golang.org/protobuf/runtime/protoiface.MessageV1 *FeatureSet : expvar.Var *FeatureSet : fmt.Stringer *FeatureSet : github.com/gogo/protobuf/proto.Message func (*EnumOptions).GetFeatures() *FeatureSet func (*EnumValueOptions).GetFeatures() *FeatureSet func (*ExtensionRangeOptions).GetFeatures() *FeatureSet func (*FeatureSetDefaults_FeatureSetEditionDefault).GetFixedFeatures() *FeatureSet func (*FeatureSetDefaults_FeatureSetEditionDefault).GetOverridableFeatures() *FeatureSet func (*FieldOptions).GetFeatures() *FeatureSet func (*FileOptions).GetFeatures() *FeatureSet func (*MessageOptions).GetFeatures() *FeatureSet func (*MethodOptions).GetFeatures() *FeatureSet func (*OneofOptions).GetFeatures() *FeatureSet func (*ServiceOptions).GetFeatures() *FeatureSet
( FeatureSet_EnforceNamingStyle) Descriptor() protoreflect.EnumDescriptor ( FeatureSet_EnforceNamingStyle) Enum() *FeatureSet_EnforceNamingStyle Deprecated: Use FeatureSet_EnforceNamingStyle.Descriptor instead. ( FeatureSet_EnforceNamingStyle) Number() protoreflect.EnumNumber ( FeatureSet_EnforceNamingStyle) String() string ( FeatureSet_EnforceNamingStyle) Type() protoreflect.EnumType Deprecated: Do not use. FeatureSet_EnforceNamingStyle : google.golang.org/protobuf/reflect/protoreflect.Enum *FeatureSet_EnforceNamingStyle : encoding/json.Unmarshaler FeatureSet_EnforceNamingStyle : expvar.Var FeatureSet_EnforceNamingStyle : fmt.Stringer *FeatureSet_EnforceNamingStyle : github.com/goccy/go-json.Unmarshaler func (*FeatureSet).GetEnforceNamingStyle() FeatureSet_EnforceNamingStyle func FeatureSet_EnforceNamingStyle.Enum() *FeatureSet_EnforceNamingStyle const FeatureSet_ENFORCE_NAMING_STYLE_UNKNOWN const FeatureSet_STYLE2024 const FeatureSet_STYLE_LEGACY
( FeatureSet_EnumType) Descriptor() protoreflect.EnumDescriptor ( FeatureSet_EnumType) Enum() *FeatureSet_EnumType Deprecated: Use FeatureSet_EnumType.Descriptor instead. ( FeatureSet_EnumType) Number() protoreflect.EnumNumber ( FeatureSet_EnumType) String() string ( FeatureSet_EnumType) Type() protoreflect.EnumType Deprecated: Do not use. FeatureSet_EnumType : google.golang.org/protobuf/reflect/protoreflect.Enum *FeatureSet_EnumType : encoding/json.Unmarshaler FeatureSet_EnumType : expvar.Var FeatureSet_EnumType : fmt.Stringer *FeatureSet_EnumType : github.com/goccy/go-json.Unmarshaler func (*FeatureSet).GetEnumType() FeatureSet_EnumType func FeatureSet_EnumType.Enum() *FeatureSet_EnumType const FeatureSet_CLOSED const FeatureSet_ENUM_TYPE_UNKNOWN const FeatureSet_OPEN
( FeatureSet_FieldPresence) Descriptor() protoreflect.EnumDescriptor ( FeatureSet_FieldPresence) Enum() *FeatureSet_FieldPresence Deprecated: Use FeatureSet_FieldPresence.Descriptor instead. ( FeatureSet_FieldPresence) Number() protoreflect.EnumNumber ( FeatureSet_FieldPresence) String() string ( FeatureSet_FieldPresence) Type() protoreflect.EnumType Deprecated: Do not use. FeatureSet_FieldPresence : google.golang.org/protobuf/reflect/protoreflect.Enum *FeatureSet_FieldPresence : encoding/json.Unmarshaler FeatureSet_FieldPresence : expvar.Var FeatureSet_FieldPresence : fmt.Stringer *FeatureSet_FieldPresence : github.com/goccy/go-json.Unmarshaler func (*FeatureSet).GetFieldPresence() FeatureSet_FieldPresence func FeatureSet_FieldPresence.Enum() *FeatureSet_FieldPresence const FeatureSet_EXPLICIT const FeatureSet_FIELD_PRESENCE_UNKNOWN const FeatureSet_IMPLICIT const FeatureSet_LEGACY_REQUIRED
( FeatureSet_JsonFormat) Descriptor() protoreflect.EnumDescriptor ( FeatureSet_JsonFormat) Enum() *FeatureSet_JsonFormat Deprecated: Use FeatureSet_JsonFormat.Descriptor instead. ( FeatureSet_JsonFormat) Number() protoreflect.EnumNumber ( FeatureSet_JsonFormat) String() string ( FeatureSet_JsonFormat) Type() protoreflect.EnumType Deprecated: Do not use. FeatureSet_JsonFormat : google.golang.org/protobuf/reflect/protoreflect.Enum *FeatureSet_JsonFormat : encoding/json.Unmarshaler FeatureSet_JsonFormat : expvar.Var FeatureSet_JsonFormat : fmt.Stringer *FeatureSet_JsonFormat : github.com/goccy/go-json.Unmarshaler func (*FeatureSet).GetJsonFormat() FeatureSet_JsonFormat func FeatureSet_JsonFormat.Enum() *FeatureSet_JsonFormat const FeatureSet_ALLOW const FeatureSet_JSON_FORMAT_UNKNOWN const FeatureSet_LEGACY_BEST_EFFORT
( FeatureSet_MessageEncoding) Descriptor() protoreflect.EnumDescriptor ( FeatureSet_MessageEncoding) Enum() *FeatureSet_MessageEncoding Deprecated: Use FeatureSet_MessageEncoding.Descriptor instead. ( FeatureSet_MessageEncoding) Number() protoreflect.EnumNumber ( FeatureSet_MessageEncoding) String() string ( FeatureSet_MessageEncoding) Type() protoreflect.EnumType Deprecated: Do not use. FeatureSet_MessageEncoding : google.golang.org/protobuf/reflect/protoreflect.Enum *FeatureSet_MessageEncoding : encoding/json.Unmarshaler FeatureSet_MessageEncoding : expvar.Var FeatureSet_MessageEncoding : fmt.Stringer *FeatureSet_MessageEncoding : github.com/goccy/go-json.Unmarshaler func (*FeatureSet).GetMessageEncoding() FeatureSet_MessageEncoding func FeatureSet_MessageEncoding.Enum() *FeatureSet_MessageEncoding const FeatureSet_DELIMITED const FeatureSet_LENGTH_PREFIXED const FeatureSet_MESSAGE_ENCODING_UNKNOWN
( FeatureSet_RepeatedFieldEncoding) Descriptor() protoreflect.EnumDescriptor ( FeatureSet_RepeatedFieldEncoding) Enum() *FeatureSet_RepeatedFieldEncoding Deprecated: Use FeatureSet_RepeatedFieldEncoding.Descriptor instead. ( FeatureSet_RepeatedFieldEncoding) Number() protoreflect.EnumNumber ( FeatureSet_RepeatedFieldEncoding) String() string ( FeatureSet_RepeatedFieldEncoding) Type() protoreflect.EnumType Deprecated: Do not use. FeatureSet_RepeatedFieldEncoding : google.golang.org/protobuf/reflect/protoreflect.Enum *FeatureSet_RepeatedFieldEncoding : encoding/json.Unmarshaler FeatureSet_RepeatedFieldEncoding : expvar.Var FeatureSet_RepeatedFieldEncoding : fmt.Stringer *FeatureSet_RepeatedFieldEncoding : github.com/goccy/go-json.Unmarshaler func (*FeatureSet).GetRepeatedFieldEncoding() FeatureSet_RepeatedFieldEncoding func FeatureSet_RepeatedFieldEncoding.Enum() *FeatureSet_RepeatedFieldEncoding const FeatureSet_EXPANDED const FeatureSet_PACKED const FeatureSet_REPEATED_FIELD_ENCODING_UNKNOWN
( FeatureSet_Utf8Validation) Descriptor() protoreflect.EnumDescriptor ( FeatureSet_Utf8Validation) Enum() *FeatureSet_Utf8Validation Deprecated: Use FeatureSet_Utf8Validation.Descriptor instead. ( FeatureSet_Utf8Validation) Number() protoreflect.EnumNumber ( FeatureSet_Utf8Validation) String() string ( FeatureSet_Utf8Validation) Type() protoreflect.EnumType Deprecated: Do not use. FeatureSet_Utf8Validation : google.golang.org/protobuf/reflect/protoreflect.Enum *FeatureSet_Utf8Validation : encoding/json.Unmarshaler FeatureSet_Utf8Validation : expvar.Var FeatureSet_Utf8Validation : fmt.Stringer *FeatureSet_Utf8Validation : github.com/goccy/go-json.Unmarshaler func (*FeatureSet).GetUtf8Validation() FeatureSet_Utf8Validation func FeatureSet_Utf8Validation.Enum() *FeatureSet_Utf8Validation const FeatureSet_NONE const FeatureSet_UTF8_VALIDATION_UNKNOWN const FeatureSet_VERIFY
Deprecated: Use FeatureSet_VisibilityFeature.ProtoReflect.Descriptor instead. (*FeatureSet_VisibilityFeature) ProtoMessage() (*FeatureSet_VisibilityFeature) ProtoReflect() protoreflect.Message (*FeatureSet_VisibilityFeature) Reset() (*FeatureSet_VisibilityFeature) String() string *FeatureSet_VisibilityFeature : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *FeatureSet_VisibilityFeature : google.golang.org/protobuf/runtime/protoiface.MessageV1 *FeatureSet_VisibilityFeature : expvar.Var *FeatureSet_VisibilityFeature : fmt.Stringer *FeatureSet_VisibilityFeature : github.com/gogo/protobuf/proto.Message
( FeatureSet_VisibilityFeature_DefaultSymbolVisibility) Descriptor() protoreflect.EnumDescriptor ( FeatureSet_VisibilityFeature_DefaultSymbolVisibility) Enum() *FeatureSet_VisibilityFeature_DefaultSymbolVisibility Deprecated: Use FeatureSet_VisibilityFeature_DefaultSymbolVisibility.Descriptor instead. ( FeatureSet_VisibilityFeature_DefaultSymbolVisibility) Number() protoreflect.EnumNumber ( FeatureSet_VisibilityFeature_DefaultSymbolVisibility) String() string ( FeatureSet_VisibilityFeature_DefaultSymbolVisibility) Type() protoreflect.EnumType Deprecated: Do not use. FeatureSet_VisibilityFeature_DefaultSymbolVisibility : google.golang.org/protobuf/reflect/protoreflect.Enum *FeatureSet_VisibilityFeature_DefaultSymbolVisibility : encoding/json.Unmarshaler FeatureSet_VisibilityFeature_DefaultSymbolVisibility : expvar.Var FeatureSet_VisibilityFeature_DefaultSymbolVisibility : fmt.Stringer *FeatureSet_VisibilityFeature_DefaultSymbolVisibility : github.com/goccy/go-json.Unmarshaler func (*FeatureSet).GetDefaultSymbolVisibility() FeatureSet_VisibilityFeature_DefaultSymbolVisibility func FeatureSet_VisibilityFeature_DefaultSymbolVisibility.Enum() *FeatureSet_VisibilityFeature_DefaultSymbolVisibility const FeatureSet_VisibilityFeature_DEFAULT_SYMBOL_VISIBILITY_UNKNOWN const FeatureSet_VisibilityFeature_EXPORT_ALL const FeatureSet_VisibilityFeature_EXPORT_TOP_LEVEL const FeatureSet_VisibilityFeature_LOCAL_ALL const FeatureSet_VisibilityFeature_STRICT
A compiled specification for the defaults of a set of features. These messages are generated from FeatureSet extensions and can be used to seed feature resolution. The resolution with this object becomes a simple search for the closest matching edition, followed by proto merges. Defaults []*FeatureSetDefaults_FeatureSetEditionDefault The maximum known edition (inclusive) when this was constructed. Editions after this will not have reliable defaults. The minimum supported edition (inclusive) when this was constructed. Editions before this will not have defaults. Deprecated: Use FeatureSetDefaults.ProtoReflect.Descriptor instead. (*FeatureSetDefaults) GetDefaults() []*FeatureSetDefaults_FeatureSetEditionDefault (*FeatureSetDefaults) GetMaximumEdition() Edition (*FeatureSetDefaults) GetMinimumEdition() Edition (*FeatureSetDefaults) ProtoMessage() (*FeatureSetDefaults) ProtoReflect() protoreflect.Message (*FeatureSetDefaults) Reset() (*FeatureSetDefaults) String() string *FeatureSetDefaults : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *FeatureSetDefaults : google.golang.org/protobuf/runtime/protoiface.MessageV1 *FeatureSetDefaults : expvar.Var *FeatureSetDefaults : fmt.Stringer *FeatureSetDefaults : github.com/gogo/protobuf/proto.Message
A map from every known edition with a unique set of defaults to its defaults. Not all editions may be contained here. For a given edition, the defaults at the closest matching edition ordered at or before it should be used. This field must be in strict ascending order by edition. Edition *Edition Defaults of features that can't be overridden in this edition. Defaults of features that can be overridden in this edition. Deprecated: Use FeatureSetDefaults_FeatureSetEditionDefault.ProtoReflect.Descriptor instead. (*FeatureSetDefaults_FeatureSetEditionDefault) GetEdition() Edition (*FeatureSetDefaults_FeatureSetEditionDefault) GetFixedFeatures() *FeatureSet (*FeatureSetDefaults_FeatureSetEditionDefault) GetOverridableFeatures() *FeatureSet (*FeatureSetDefaults_FeatureSetEditionDefault) ProtoMessage() (*FeatureSetDefaults_FeatureSetEditionDefault) ProtoReflect() protoreflect.Message (*FeatureSetDefaults_FeatureSetEditionDefault) Reset() (*FeatureSetDefaults_FeatureSetEditionDefault) String() string *FeatureSetDefaults_FeatureSetEditionDefault : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *FeatureSetDefaults_FeatureSetEditionDefault : google.golang.org/protobuf/runtime/protoiface.MessageV1 *FeatureSetDefaults_FeatureSetEditionDefault : expvar.Var *FeatureSetDefaults_FeatureSetEditionDefault : fmt.Stringer *FeatureSetDefaults_FeatureSetEditionDefault : github.com/gogo/protobuf/proto.Message func (*FeatureSetDefaults).GetDefaults() []*FeatureSetDefaults_FeatureSetEditionDefault
Describes a field within a message. 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. For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name. JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase. Label *FieldDescriptorProto_Label Name *string Number *int32 If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof. Options *FieldOptions If true, this is a proto3 "optional". When a proto3 field is optional, it tracks presence regardless of field type. When proto3_optional is true, this field must belong to a oneof to signal to old proto3 clients that presence is tracked for this field. This oneof is known as a "synthetic" oneof, and this field must be its sole member (each proto3 optional field gets its own synthetic oneof). Synthetic oneofs exist in the descriptor only, and do not generate any API. Synthetic oneofs must be ordered after all "real" oneofs. For message fields, proto3_optional doesn't create any semantic change, since non-repeated message fields always track presence. However it still indicates the semantic detail of whether the user wrote "optional" or not. This can be useful for round-tripping the .proto file. For consistency we give message fields a synthetic oneof also, even though it is not required to track presence. This is especially important because the parser can't tell if a field is a message or an enum, so it must always create a synthetic oneof. Proto2 optional fields do not set this flag, because they already indicate optional with `LABEL_OPTIONAL`. If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP. 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). Deprecated: Use FieldDescriptorProto.ProtoReflect.Descriptor instead. (*FieldDescriptorProto) GetDefaultValue() string (*FieldDescriptorProto) GetExtendee() string (*FieldDescriptorProto) GetJsonName() string (*FieldDescriptorProto) GetLabel() FieldDescriptorProto_Label (*FieldDescriptorProto) GetName() string (*FieldDescriptorProto) GetNumber() int32 (*FieldDescriptorProto) GetOneofIndex() int32 (*FieldDescriptorProto) GetOptions() *FieldOptions (*FieldDescriptorProto) GetProto3Optional() bool (*FieldDescriptorProto) GetType() FieldDescriptorProto_Type (*FieldDescriptorProto) GetTypeName() string (*FieldDescriptorProto) ProtoMessage() (*FieldDescriptorProto) ProtoReflect() protoreflect.Message (*FieldDescriptorProto) Reset() (*FieldDescriptorProto) String() string *FieldDescriptorProto : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *FieldDescriptorProto : google.golang.org/protobuf/runtime/protoiface.MessageV1 *FieldDescriptorProto : expvar.Var *FieldDescriptorProto : fmt.Stringer *FieldDescriptorProto : github.com/gogo/protobuf/proto.Message func (*DescriptorProto).GetExtension() []*FieldDescriptorProto func (*DescriptorProto).GetField() []*FieldDescriptorProto func (*FileDescriptorProto).GetExtension() []*FieldDescriptorProto func google.golang.org/protobuf/reflect/protodesc.ToFieldDescriptorProto(field protoreflect.FieldDescriptor) *FieldDescriptorProto
( FieldDescriptorProto_Label) Descriptor() protoreflect.EnumDescriptor ( FieldDescriptorProto_Label) Enum() *FieldDescriptorProto_Label Deprecated: Use FieldDescriptorProto_Label.Descriptor instead. ( FieldDescriptorProto_Label) Number() protoreflect.EnumNumber ( FieldDescriptorProto_Label) String() string ( FieldDescriptorProto_Label) Type() protoreflect.EnumType Deprecated: Do not use. FieldDescriptorProto_Label : google.golang.org/protobuf/reflect/protoreflect.Enum *FieldDescriptorProto_Label : encoding/json.Unmarshaler FieldDescriptorProto_Label : expvar.Var FieldDescriptorProto_Label : fmt.Stringer *FieldDescriptorProto_Label : github.com/goccy/go-json.Unmarshaler func (*FieldDescriptorProto).GetLabel() FieldDescriptorProto_Label func FieldDescriptorProto_Label.Enum() *FieldDescriptorProto_Label const FieldDescriptorProto_LABEL_OPTIONAL const FieldDescriptorProto_LABEL_REPEATED const FieldDescriptorProto_LABEL_REQUIRED
( FieldDescriptorProto_Type) Descriptor() protoreflect.EnumDescriptor ( FieldDescriptorProto_Type) Enum() *FieldDescriptorProto_Type Deprecated: Use FieldDescriptorProto_Type.Descriptor instead. ( FieldDescriptorProto_Type) Number() protoreflect.EnumNumber ( FieldDescriptorProto_Type) String() string ( FieldDescriptorProto_Type) Type() protoreflect.EnumType Deprecated: Do not use. FieldDescriptorProto_Type : google.golang.org/protobuf/reflect/protoreflect.Enum *FieldDescriptorProto_Type : encoding/json.Unmarshaler FieldDescriptorProto_Type : expvar.Var FieldDescriptorProto_Type : fmt.Stringer *FieldDescriptorProto_Type : github.com/goccy/go-json.Unmarshaler func (*FieldDescriptorProto).GetType() FieldDescriptorProto_Type func FieldDescriptorProto_Type.Enum() *FieldDescriptorProto_Type const FieldDescriptorProto_TYPE_BOOL const FieldDescriptorProto_TYPE_BYTES const FieldDescriptorProto_TYPE_DOUBLE const FieldDescriptorProto_TYPE_ENUM const FieldDescriptorProto_TYPE_FIXED32 const FieldDescriptorProto_TYPE_FIXED64 const FieldDescriptorProto_TYPE_FLOAT const FieldDescriptorProto_TYPE_GROUP const FieldDescriptorProto_TYPE_INT32 const FieldDescriptorProto_TYPE_INT64 const FieldDescriptorProto_TYPE_MESSAGE const FieldDescriptorProto_TYPE_SFIXED32 const FieldDescriptorProto_TYPE_SFIXED64 const FieldDescriptorProto_TYPE_SINT32 const FieldDescriptorProto_TYPE_SINT64 const FieldDescriptorProto_TYPE_STRING const FieldDescriptorProto_TYPE_UINT32 const FieldDescriptorProto_TYPE_UINT64
NOTE: ctype is deprecated. Use `features.(pb.cpp).string_type` instead. 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 only implemented to support use of [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of type "bytes" in the open source release. TODO: make ctype actually deprecated. Indicate that the field value should not be printed out when using debug formats, e.g. when the field contains sensitive credentials. 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. EditionDefaults []*FieldOptions_EditionDefault FeatureSupport *FieldOptions_FeatureSupport Any features defined in the specific edition. WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language. The jstype option determines the JavaScript type used for values of the field. The option is permitted only for 64 bit integral and fixed types (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING is represented as JavaScript string, which avoids loss of precision that can happen when a large value is converted to a floating point JavaScript. Specifying JS_NUMBER for the jstype causes the generated JavaScript code to use the JavaScript "number" type. The behavior of the default option JS_NORMAL is implementation dependent. This option is an enum to permit additional types to be added, e.g. goog.math.Integer. 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 lazy message fields are still eagerly verified to check ill-formed wireformat or missing required fields. Calling IsInitialized() on the outer message would fail if the inner message has missing required fields. Failed verification would result in parsing failure (except when uninitialized messages are acceptable). 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. In proto3, only explicit setting it to false will avoid using packed encoding. This option is prohibited in Editions, but the `repeated_field_encoding` feature can be used to control the behavior. Retention *FieldOptions_OptionRetention Targets []FieldOptions_OptionTargetType The parser stores options it doesn't recognize here. See above. unverified_lazy does no correctness checks on the byte stream. This should only be used where lazy with verification is prohibitive for performance reasons. DEPRECATED. DO NOT USE! For Google-internal migration only. Do not use. Deprecated: Marked as deprecated in google/protobuf/descriptor.proto. Deprecated: Use FieldOptions.ProtoReflect.Descriptor instead. (*FieldOptions) GetCtype() FieldOptions_CType (*FieldOptions) GetDebugRedact() bool (*FieldOptions) GetDeprecated() bool (*FieldOptions) GetEditionDefaults() []*FieldOptions_EditionDefault (*FieldOptions) GetFeatureSupport() *FieldOptions_FeatureSupport (*FieldOptions) GetFeatures() *FeatureSet (*FieldOptions) GetJstype() FieldOptions_JSType (*FieldOptions) GetLazy() bool (*FieldOptions) GetPacked() bool (*FieldOptions) GetRetention() FieldOptions_OptionRetention (*FieldOptions) GetTargets() []FieldOptions_OptionTargetType (*FieldOptions) GetUninterpretedOption() []*UninterpretedOption (*FieldOptions) GetUnverifiedLazy() bool Deprecated: Marked as deprecated in google/protobuf/descriptor.proto. (*FieldOptions) ProtoMessage() (*FieldOptions) ProtoReflect() protoreflect.Message (*FieldOptions) Reset() (*FieldOptions) String() string *FieldOptions : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *FieldOptions : google.golang.org/protobuf/runtime/protoiface.MessageV1 *FieldOptions : expvar.Var *FieldOptions : fmt.Stringer *FieldOptions : github.com/gogo/protobuf/proto.Message func (*FieldDescriptorProto).GetOptions() *FieldOptions
( FieldOptions_CType) Descriptor() protoreflect.EnumDescriptor ( FieldOptions_CType) Enum() *FieldOptions_CType Deprecated: Use FieldOptions_CType.Descriptor instead. ( FieldOptions_CType) Number() protoreflect.EnumNumber ( FieldOptions_CType) String() string ( FieldOptions_CType) Type() protoreflect.EnumType Deprecated: Do not use. FieldOptions_CType : google.golang.org/protobuf/reflect/protoreflect.Enum *FieldOptions_CType : encoding/json.Unmarshaler FieldOptions_CType : expvar.Var FieldOptions_CType : fmt.Stringer *FieldOptions_CType : github.com/goccy/go-json.Unmarshaler func (*FieldOptions).GetCtype() FieldOptions_CType func FieldOptions_CType.Enum() *FieldOptions_CType const Default_FieldOptions_Ctype const FieldOptions_CORD const FieldOptions_STRING const FieldOptions_STRING_PIECE
Edition *Edition // Textproto value. Deprecated: Use FieldOptions_EditionDefault.ProtoReflect.Descriptor instead. (*FieldOptions_EditionDefault) GetEdition() Edition (*FieldOptions_EditionDefault) GetValue() string (*FieldOptions_EditionDefault) ProtoMessage() (*FieldOptions_EditionDefault) ProtoReflect() protoreflect.Message (*FieldOptions_EditionDefault) Reset() (*FieldOptions_EditionDefault) String() string *FieldOptions_EditionDefault : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *FieldOptions_EditionDefault : google.golang.org/protobuf/runtime/protoiface.MessageV1 *FieldOptions_EditionDefault : expvar.Var *FieldOptions_EditionDefault : fmt.Stringer *FieldOptions_EditionDefault : github.com/gogo/protobuf/proto.Message func (*FieldOptions).GetEditionDefaults() []*FieldOptions_EditionDefault
Information about the support window of a feature. The deprecation warning text if this feature is used after the edition it was marked deprecated in. The edition this feature becomes deprecated in. Using this after this edition may trigger warnings. The edition that this feature was first available in. In editions earlier than this one, the default assigned to EDITION_LEGACY will be used, and proto files will not be able to override it. The edition this feature is no longer available in. In editions after this one, the last default assigned will be used, and proto files will not be able to override it. Deprecated: Use FieldOptions_FeatureSupport.ProtoReflect.Descriptor instead. (*FieldOptions_FeatureSupport) GetDeprecationWarning() string (*FieldOptions_FeatureSupport) GetEditionDeprecated() Edition (*FieldOptions_FeatureSupport) GetEditionIntroduced() Edition (*FieldOptions_FeatureSupport) GetEditionRemoved() Edition (*FieldOptions_FeatureSupport) ProtoMessage() (*FieldOptions_FeatureSupport) ProtoReflect() protoreflect.Message (*FieldOptions_FeatureSupport) Reset() (*FieldOptions_FeatureSupport) String() string *FieldOptions_FeatureSupport : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *FieldOptions_FeatureSupport : google.golang.org/protobuf/runtime/protoiface.MessageV1 *FieldOptions_FeatureSupport : expvar.Var *FieldOptions_FeatureSupport : fmt.Stringer *FieldOptions_FeatureSupport : github.com/gogo/protobuf/proto.Message func (*EnumValueOptions).GetFeatureSupport() *FieldOptions_FeatureSupport func (*FieldOptions).GetFeatureSupport() *FieldOptions_FeatureSupport
( FieldOptions_JSType) Descriptor() protoreflect.EnumDescriptor ( FieldOptions_JSType) Enum() *FieldOptions_JSType Deprecated: Use FieldOptions_JSType.Descriptor instead. ( FieldOptions_JSType) Number() protoreflect.EnumNumber ( FieldOptions_JSType) String() string ( FieldOptions_JSType) Type() protoreflect.EnumType Deprecated: Do not use. FieldOptions_JSType : google.golang.org/protobuf/reflect/protoreflect.Enum *FieldOptions_JSType : encoding/json.Unmarshaler FieldOptions_JSType : expvar.Var FieldOptions_JSType : fmt.Stringer *FieldOptions_JSType : github.com/goccy/go-json.Unmarshaler func (*FieldOptions).GetJstype() FieldOptions_JSType func FieldOptions_JSType.Enum() *FieldOptions_JSType const Default_FieldOptions_Jstype const FieldOptions_JS_NORMAL const FieldOptions_JS_NUMBER const FieldOptions_JS_STRING
If set to RETENTION_SOURCE, the option will be omitted from the binary. ( FieldOptions_OptionRetention) Descriptor() protoreflect.EnumDescriptor ( FieldOptions_OptionRetention) Enum() *FieldOptions_OptionRetention Deprecated: Use FieldOptions_OptionRetention.Descriptor instead. ( FieldOptions_OptionRetention) Number() protoreflect.EnumNumber ( FieldOptions_OptionRetention) String() string ( FieldOptions_OptionRetention) Type() protoreflect.EnumType Deprecated: Do not use. FieldOptions_OptionRetention : google.golang.org/protobuf/reflect/protoreflect.Enum *FieldOptions_OptionRetention : encoding/json.Unmarshaler FieldOptions_OptionRetention : expvar.Var FieldOptions_OptionRetention : fmt.Stringer *FieldOptions_OptionRetention : github.com/goccy/go-json.Unmarshaler func (*FieldOptions).GetRetention() FieldOptions_OptionRetention func FieldOptions_OptionRetention.Enum() *FieldOptions_OptionRetention const FieldOptions_RETENTION_RUNTIME const FieldOptions_RETENTION_SOURCE const FieldOptions_RETENTION_UNKNOWN
This indicates the types of entities that the field may apply to when used as an option. If it is unset, then the field may be freely used as an option on any kind of entity. ( FieldOptions_OptionTargetType) Descriptor() protoreflect.EnumDescriptor ( FieldOptions_OptionTargetType) Enum() *FieldOptions_OptionTargetType Deprecated: Use FieldOptions_OptionTargetType.Descriptor instead. ( FieldOptions_OptionTargetType) Number() protoreflect.EnumNumber ( FieldOptions_OptionTargetType) String() string ( FieldOptions_OptionTargetType) Type() protoreflect.EnumType Deprecated: Do not use. FieldOptions_OptionTargetType : google.golang.org/protobuf/reflect/protoreflect.Enum *FieldOptions_OptionTargetType : encoding/json.Unmarshaler FieldOptions_OptionTargetType : expvar.Var FieldOptions_OptionTargetType : fmt.Stringer *FieldOptions_OptionTargetType : github.com/goccy/go-json.Unmarshaler func (*FieldOptions).GetTargets() []FieldOptions_OptionTargetType func FieldOptions_OptionTargetType.Enum() *FieldOptions_OptionTargetType const FieldOptions_TARGET_TYPE_ENUM const FieldOptions_TARGET_TYPE_ENUM_ENTRY const FieldOptions_TARGET_TYPE_EXTENSION_RANGE const FieldOptions_TARGET_TYPE_FIELD const FieldOptions_TARGET_TYPE_FILE const FieldOptions_TARGET_TYPE_MESSAGE const FieldOptions_TARGET_TYPE_METHOD const FieldOptions_TARGET_TYPE_ONEOF const FieldOptions_TARGET_TYPE_SERVICE const FieldOptions_TARGET_TYPE_UNKNOWN
Describes a complete .proto file. Names of files imported by this file. The edition of the proto file. WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language. EnumType []*EnumDescriptorProto Extension []*FieldDescriptorProto All top-level definitions in this file. // file name, relative to root of source tree Names of files imported by this file purely for the purpose of providing option extensions. These are excluded from the dependency list above. Options *FileOptions // e.g. "foo", "foo.bar", etc. Indexes of the public imported files in the dependency list above. Service []*ServiceDescriptorProto This field contains optional information about the original source code. You may safely remove this entire field without harming runtime functionality of the descriptors -- the information is needed only by development tools. The syntax of the proto file. The supported values are "proto2", "proto3", and "editions". If `edition` is present, this value must be "editions". WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language. Indexes of the weak imported files in the dependency list. For Google-internal migration only. Do not use. Deprecated: Use FileDescriptorProto.ProtoReflect.Descriptor instead. (*FileDescriptorProto) GetDependency() []string (*FileDescriptorProto) GetEdition() Edition (*FileDescriptorProto) GetEnumType() []*EnumDescriptorProto (*FileDescriptorProto) GetExtension() []*FieldDescriptorProto (*FileDescriptorProto) GetMessageType() []*DescriptorProto (*FileDescriptorProto) GetName() string (*FileDescriptorProto) GetOptionDependency() []string (*FileDescriptorProto) GetOptions() *FileOptions (*FileDescriptorProto) GetPackage() string (*FileDescriptorProto) GetPublicDependency() []int32 (*FileDescriptorProto) GetService() []*ServiceDescriptorProto (*FileDescriptorProto) GetSourceCodeInfo() *SourceCodeInfo (*FileDescriptorProto) GetSyntax() string (*FileDescriptorProto) GetWeakDependency() []int32 (*FileDescriptorProto) ProtoMessage() (*FileDescriptorProto) ProtoReflect() protoreflect.Message (*FileDescriptorProto) Reset() (*FileDescriptorProto) String() string *FileDescriptorProto : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *FileDescriptorProto : google.golang.org/protobuf/runtime/protoiface.MessageV1 *FileDescriptorProto : expvar.Var *FileDescriptorProto : fmt.Stringer *FileDescriptorProto : github.com/gogo/protobuf/proto.Message func (*FileDescriptorSet).GetFile() []*FileDescriptorProto func google.golang.org/protobuf/reflect/protodesc.ToFileDescriptorProto(file protoreflect.FileDescriptor) *FileDescriptorProto func google.golang.org/protobuf/reflect/protodesc.NewFile(fd *FileDescriptorProto, r protodesc.Resolver) (protoreflect.FileDescriptor, error) func google.golang.org/protobuf/reflect/protodesc.FileOptions.New(fd *FileDescriptorProto, r protodesc.Resolver) (protoreflect.FileDescriptor, error)
The protocol compiler can output a FileDescriptorSet containing the .proto files it parses. File []*FileDescriptorProto Deprecated: Use FileDescriptorSet.ProtoReflect.Descriptor instead. (*FileDescriptorSet) GetFile() []*FileDescriptorProto (*FileDescriptorSet) ProtoMessage() (*FileDescriptorSet) ProtoReflect() protoreflect.Message (*FileDescriptorSet) Reset() (*FileDescriptorSet) String() string *FileDescriptorSet : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *FileDescriptorSet : google.golang.org/protobuf/runtime/protoiface.MessageV1 *FileDescriptorSet : expvar.Var *FileDescriptorSet : fmt.Stringer *FileDescriptorSet : github.com/gogo/protobuf/proto.Message func google.golang.org/protobuf/reflect/protodesc.NewFiles(fd *FileDescriptorSet) (*protoregistry.Files, error) func google.golang.org/protobuf/reflect/protodesc.FileOptions.NewFiles(fds *FileDescriptorSet) (*protoregistry.Files, error)
Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++. 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 google.protobuf. 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. Namespace for generated classes; defaults to the package. Is this file deprecated? Depending on the target platform, this can emit Deprecated annotations for everything in the file, or it will be completely ignored; in the very least, this is a formalization for deprecating files. Any features defined in the specific edition. WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language. Sets the Go package where structs generated from this .proto will be placed. If omitted, the Go package will be derived from the following: - The basename of the package import path, if provided. - Otherwise, the package statement in the .proto file, if present. - Otherwise, the basename of the .proto file, without extension. This option does nothing. Deprecated: Marked as deprecated in google/protobuf/descriptor.proto. JavaGenericServices *bool If enabled, 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 wrapper class named by java_outer_classname. However, the wrapper class will still be generated to contain the file's getDescriptor() method as well as any top-level extensions defined in the file. Controls the name of the wrapper Java class generated for the .proto file. That class will always contain the .proto file's getDescriptor() method as well as any top-level extensions defined in the .proto file. If java_multiple_files is disabled, then all the other classes from the .proto file will be nested inside the single wrapper outer class. 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. A proto2 file can set this to true to opt in to UTF-8 checking for Java, which will throw an exception if invalid UTF-8 is parsed from the wire or assigned to a string field. TODO: clarify exactly what kinds of field types this option applies to, and update these docs accordingly. Proto3 files already perform these checks. Setting the option explicitly to false has no effect: it cannot be used to opt proto3 files out of UTF-8 checks. Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. There is no default. OptimizeFor *FileOptions_OptimizeMode Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty. Use this option to change the namespace of php generated metadata classes. Default is empty. When this option is empty, the proto file name will be used for determining the namespace. Use this option to change the namespace of php generated classes. Default is empty. When this option is empty, the package name will be used for determining the namespace. PyGenericServices *bool Use this option to change the package of ruby generated classes. Default is empty. When this option is not set, the package name will be used for determining the ruby package. By default Swift generators will take the proto package and CamelCase it replacing '.' with underscore and use that to prefix the types/symbols defined. When this options is provided, they will use this value instead to prefix the types/symbols defined. The parser stores options it doesn't recognize here. See the documentation for the "Options" section above. Deprecated: Use FileOptions.ProtoReflect.Descriptor instead. (*FileOptions) GetCcEnableArenas() bool (*FileOptions) GetCcGenericServices() bool (*FileOptions) GetCsharpNamespace() string (*FileOptions) GetDeprecated() bool (*FileOptions) GetFeatures() *FeatureSet (*FileOptions) GetGoPackage() string Deprecated: Marked as deprecated in google/protobuf/descriptor.proto. (*FileOptions) GetJavaGenericServices() bool (*FileOptions) GetJavaMultipleFiles() bool (*FileOptions) GetJavaOuterClassname() string (*FileOptions) GetJavaPackage() string (*FileOptions) GetJavaStringCheckUtf8() bool (*FileOptions) GetObjcClassPrefix() string (*FileOptions) GetOptimizeFor() FileOptions_OptimizeMode (*FileOptions) GetPhpClassPrefix() string (*FileOptions) GetPhpMetadataNamespace() string (*FileOptions) GetPhpNamespace() string (*FileOptions) GetPyGenericServices() bool (*FileOptions) GetRubyPackage() string (*FileOptions) GetSwiftPrefix() string (*FileOptions) GetUninterpretedOption() []*UninterpretedOption (*FileOptions) ProtoMessage() (*FileOptions) ProtoReflect() protoreflect.Message (*FileOptions) Reset() (*FileOptions) String() string *FileOptions : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *FileOptions : google.golang.org/protobuf/runtime/protoiface.MessageV1 *FileOptions : expvar.Var *FileOptions : fmt.Stringer *FileOptions : github.com/gogo/protobuf/proto.Message func (*FileDescriptorProto).GetOptions() *FileOptions
Generated classes can be optimized for speed or code size. ( FileOptions_OptimizeMode) Descriptor() protoreflect.EnumDescriptor ( FileOptions_OptimizeMode) Enum() *FileOptions_OptimizeMode Deprecated: Use FileOptions_OptimizeMode.Descriptor instead. ( FileOptions_OptimizeMode) Number() protoreflect.EnumNumber ( FileOptions_OptimizeMode) String() string ( FileOptions_OptimizeMode) Type() protoreflect.EnumType Deprecated: Do not use. FileOptions_OptimizeMode : google.golang.org/protobuf/reflect/protoreflect.Enum *FileOptions_OptimizeMode : encoding/json.Unmarshaler FileOptions_OptimizeMode : expvar.Var FileOptions_OptimizeMode : fmt.Stringer *FileOptions_OptimizeMode : github.com/goccy/go-json.Unmarshaler func (*FileOptions).GetOptimizeFor() FileOptions_OptimizeMode func FileOptions_OptimizeMode.Enum() *FileOptions_OptimizeMode const Default_FileOptions_OptimizeFor const FileOptions_CODE_SIZE const FileOptions_LITE_RUNTIME const FileOptions_SPEED
Describes the relationship between generated code and its original source file. A GeneratedCodeInfo message is associated with only one generated source file, but may contain references to different source .proto files. An Annotation connects some span of text in generated code to an element of its generating .proto file. Deprecated: Use GeneratedCodeInfo.ProtoReflect.Descriptor instead. (*GeneratedCodeInfo) GetAnnotation() []*GeneratedCodeInfo_Annotation (*GeneratedCodeInfo) ProtoMessage() (*GeneratedCodeInfo) ProtoReflect() protoreflect.Message (*GeneratedCodeInfo) Reset() (*GeneratedCodeInfo) String() string *GeneratedCodeInfo : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *GeneratedCodeInfo : google.golang.org/protobuf/runtime/protoiface.MessageV1 *GeneratedCodeInfo : expvar.Var *GeneratedCodeInfo : fmt.Stringer *GeneratedCodeInfo : github.com/gogo/protobuf/proto.Message
Identifies the starting offset in bytes in the generated code that relates to the identified object. Identifies the ending offset in bytes in the generated code that relates to the identified object. The end offset should be one past the last relevant byte (so the length of the text = end - begin). Identifies the element in the original source .proto file. This field is formatted the same as SourceCodeInfo.Location.path. Semantic *GeneratedCodeInfo_Annotation_Semantic Identifies the filesystem path to the original source .proto. Deprecated: Use GeneratedCodeInfo_Annotation.ProtoReflect.Descriptor instead. (*GeneratedCodeInfo_Annotation) GetBegin() int32 (*GeneratedCodeInfo_Annotation) GetEnd() int32 (*GeneratedCodeInfo_Annotation) GetPath() []int32 (*GeneratedCodeInfo_Annotation) GetSemantic() GeneratedCodeInfo_Annotation_Semantic (*GeneratedCodeInfo_Annotation) GetSourceFile() string (*GeneratedCodeInfo_Annotation) ProtoMessage() (*GeneratedCodeInfo_Annotation) ProtoReflect() protoreflect.Message (*GeneratedCodeInfo_Annotation) Reset() (*GeneratedCodeInfo_Annotation) String() string *GeneratedCodeInfo_Annotation : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *GeneratedCodeInfo_Annotation : google.golang.org/protobuf/runtime/protoiface.MessageV1 *GeneratedCodeInfo_Annotation : expvar.Var *GeneratedCodeInfo_Annotation : fmt.Stringer *GeneratedCodeInfo_Annotation : github.com/gogo/protobuf/proto.Message func (*GeneratedCodeInfo).GetAnnotation() []*GeneratedCodeInfo_Annotation
Represents the identified object's effect on the element in the original .proto file. ( GeneratedCodeInfo_Annotation_Semantic) Descriptor() protoreflect.EnumDescriptor ( GeneratedCodeInfo_Annotation_Semantic) Enum() *GeneratedCodeInfo_Annotation_Semantic Deprecated: Use GeneratedCodeInfo_Annotation_Semantic.Descriptor instead. ( GeneratedCodeInfo_Annotation_Semantic) Number() protoreflect.EnumNumber ( GeneratedCodeInfo_Annotation_Semantic) String() string ( GeneratedCodeInfo_Annotation_Semantic) Type() protoreflect.EnumType Deprecated: Do not use. GeneratedCodeInfo_Annotation_Semantic : google.golang.org/protobuf/reflect/protoreflect.Enum *GeneratedCodeInfo_Annotation_Semantic : encoding/json.Unmarshaler GeneratedCodeInfo_Annotation_Semantic : expvar.Var GeneratedCodeInfo_Annotation_Semantic : fmt.Stringer *GeneratedCodeInfo_Annotation_Semantic : github.com/goccy/go-json.Unmarshaler func (*GeneratedCodeInfo_Annotation).GetSemantic() GeneratedCodeInfo_Annotation_Semantic func GeneratedCodeInfo_Annotation_Semantic.Enum() *GeneratedCodeInfo_Annotation_Semantic const GeneratedCodeInfo_Annotation_ALIAS const GeneratedCodeInfo_Annotation_NONE const GeneratedCodeInfo_Annotation_SET
Is this message deprecated? Depending on the target platform, this can emit Deprecated annotations for the message, or it will be completely ignored; in the very least, this is a formalization for deprecating messages. Enable the legacy handling of JSON field name conflicts. This lowercases and strips underscored from the fields before comparison in proto3 only. The new behavior takes `json_name` into account and applies to proto2 as well. This should only be used as a temporary measure against broken builds due to the change in behavior for JSON field name conflicts. TODO This is legacy behavior we plan to remove once downstream teams have had time to migrate. Deprecated: Marked as deprecated in google/protobuf/descriptor.proto. Any features defined in the specific edition. WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language. Whether the message is an automatically generated map entry type for the maps field. For maps fields: map<KeyType, ValueType> map_field = 1; The parsed descriptor looks like: message MapFieldEntry { option map_entry = true; optional KeyType key = 1; optional ValueType value = 2; } repeated MapFieldEntry map_field = 1; Implementations may choose not to generate the map_entry=true message, but use a native map in the target language to hold the keys and values. The reflection APIs in such implementations still need to work as if the field is a repeated message field. NOTE: Do not set the option in .proto files. Always use the maps syntax instead. The option should only be implicitly set by the proto compiler parser. 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. 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". The parser stores options it doesn't recognize here. See above. Deprecated: Use MessageOptions.ProtoReflect.Descriptor instead. (*MessageOptions) GetDeprecated() bool Deprecated: Marked as deprecated in google/protobuf/descriptor.proto. (*MessageOptions) GetFeatures() *FeatureSet (*MessageOptions) GetMapEntry() bool (*MessageOptions) GetMessageSetWireFormat() bool (*MessageOptions) GetNoStandardDescriptorAccessor() bool (*MessageOptions) GetUninterpretedOption() []*UninterpretedOption (*MessageOptions) ProtoMessage() (*MessageOptions) ProtoReflect() protoreflect.Message (*MessageOptions) Reset() (*MessageOptions) String() string *MessageOptions : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *MessageOptions : google.golang.org/protobuf/runtime/protoiface.MessageV1 *MessageOptions : expvar.Var *MessageOptions : fmt.Stringer *MessageOptions : github.com/gogo/protobuf/proto.Message func (*DescriptorProto).GetOptions() *MessageOptions
Describes a method of a service. Identifies if client streams multiple client messages Input and output type names. These are resolved in the same way as FieldDescriptorProto.type_name, but must refer to a message type. Name *string Options *MethodOptions OutputType *string Identifies if server streams multiple server messages Deprecated: Use MethodDescriptorProto.ProtoReflect.Descriptor instead. (*MethodDescriptorProto) GetClientStreaming() bool (*MethodDescriptorProto) GetInputType() string (*MethodDescriptorProto) GetName() string (*MethodDescriptorProto) GetOptions() *MethodOptions (*MethodDescriptorProto) GetOutputType() string (*MethodDescriptorProto) GetServerStreaming() bool (*MethodDescriptorProto) ProtoMessage() (*MethodDescriptorProto) ProtoReflect() protoreflect.Message (*MethodDescriptorProto) Reset() (*MethodDescriptorProto) String() string *MethodDescriptorProto : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *MethodDescriptorProto : google.golang.org/protobuf/runtime/protoiface.MessageV1 *MethodDescriptorProto : expvar.Var *MethodDescriptorProto : fmt.Stringer *MethodDescriptorProto : github.com/gogo/protobuf/proto.Message func (*ServiceDescriptorProto).GetMethod() []*MethodDescriptorProto func google.golang.org/protobuf/reflect/protodesc.ToMethodDescriptorProto(method protoreflect.MethodDescriptor) *MethodDescriptorProto
Is this method deprecated? Depending on the target platform, this can emit Deprecated annotations for the method, or it will be completely ignored; in the very least, this is a formalization for deprecating methods. Any features defined in the specific edition. WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language. IdempotencyLevel *MethodOptions_IdempotencyLevel The parser stores options it doesn't recognize here. See above. Deprecated: Use MethodOptions.ProtoReflect.Descriptor instead. (*MethodOptions) GetDeprecated() bool (*MethodOptions) GetFeatures() *FeatureSet (*MethodOptions) GetIdempotencyLevel() MethodOptions_IdempotencyLevel (*MethodOptions) GetUninterpretedOption() []*UninterpretedOption (*MethodOptions) ProtoMessage() (*MethodOptions) ProtoReflect() protoreflect.Message (*MethodOptions) Reset() (*MethodOptions) String() string *MethodOptions : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *MethodOptions : google.golang.org/protobuf/runtime/protoiface.MessageV1 *MethodOptions : expvar.Var *MethodOptions : fmt.Stringer *MethodOptions : github.com/gogo/protobuf/proto.Message func (*MethodDescriptorProto).GetOptions() *MethodOptions
Is this method side-effect-free (or safe in HTTP parlance), or idempotent, or neither? HTTP based RPC implementation may choose GET verb for safe methods, and PUT verb for idempotent methods instead of the default POST. ( MethodOptions_IdempotencyLevel) Descriptor() protoreflect.EnumDescriptor ( MethodOptions_IdempotencyLevel) Enum() *MethodOptions_IdempotencyLevel Deprecated: Use MethodOptions_IdempotencyLevel.Descriptor instead. ( MethodOptions_IdempotencyLevel) Number() protoreflect.EnumNumber ( MethodOptions_IdempotencyLevel) String() string ( MethodOptions_IdempotencyLevel) Type() protoreflect.EnumType Deprecated: Do not use. MethodOptions_IdempotencyLevel : google.golang.org/protobuf/reflect/protoreflect.Enum *MethodOptions_IdempotencyLevel : encoding/json.Unmarshaler MethodOptions_IdempotencyLevel : expvar.Var MethodOptions_IdempotencyLevel : fmt.Stringer *MethodOptions_IdempotencyLevel : github.com/goccy/go-json.Unmarshaler func (*MethodOptions).GetIdempotencyLevel() MethodOptions_IdempotencyLevel func MethodOptions_IdempotencyLevel.Enum() *MethodOptions_IdempotencyLevel const Default_MethodOptions_IdempotencyLevel const MethodOptions_IDEMPOTENCY_UNKNOWN const MethodOptions_IDEMPOTENT const MethodOptions_NO_SIDE_EFFECTS
Describes a oneof. Name *string Options *OneofOptions Deprecated: Use OneofDescriptorProto.ProtoReflect.Descriptor instead. (*OneofDescriptorProto) GetName() string (*OneofDescriptorProto) GetOptions() *OneofOptions (*OneofDescriptorProto) ProtoMessage() (*OneofDescriptorProto) ProtoReflect() protoreflect.Message (*OneofDescriptorProto) Reset() (*OneofDescriptorProto) String() string *OneofDescriptorProto : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *OneofDescriptorProto : google.golang.org/protobuf/runtime/protoiface.MessageV1 *OneofDescriptorProto : expvar.Var *OneofDescriptorProto : fmt.Stringer *OneofDescriptorProto : github.com/gogo/protobuf/proto.Message func (*DescriptorProto).GetOneofDecl() []*OneofDescriptorProto func google.golang.org/protobuf/reflect/protodesc.ToOneofDescriptorProto(oneof protoreflect.OneofDescriptor) *OneofDescriptorProto
Any features defined in the specific edition. WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language. The parser stores options it doesn't recognize here. See above. Deprecated: Use OneofOptions.ProtoReflect.Descriptor instead. (*OneofOptions) GetFeatures() *FeatureSet (*OneofOptions) GetUninterpretedOption() []*UninterpretedOption (*OneofOptions) ProtoMessage() (*OneofOptions) ProtoReflect() protoreflect.Message (*OneofOptions) Reset() (*OneofOptions) String() string *OneofOptions : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *OneofOptions : google.golang.org/protobuf/runtime/protoiface.MessageV1 *OneofOptions : expvar.Var *OneofOptions : fmt.Stringer *OneofOptions : github.com/gogo/protobuf/proto.Message func (*OneofDescriptorProto).GetOptions() *OneofOptions
Describes a service. Method []*MethodDescriptorProto Name *string Options *ServiceOptions Deprecated: Use ServiceDescriptorProto.ProtoReflect.Descriptor instead. (*ServiceDescriptorProto) GetMethod() []*MethodDescriptorProto (*ServiceDescriptorProto) GetName() string (*ServiceDescriptorProto) GetOptions() *ServiceOptions (*ServiceDescriptorProto) ProtoMessage() (*ServiceDescriptorProto) ProtoReflect() protoreflect.Message (*ServiceDescriptorProto) Reset() (*ServiceDescriptorProto) String() string *ServiceDescriptorProto : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *ServiceDescriptorProto : google.golang.org/protobuf/runtime/protoiface.MessageV1 *ServiceDescriptorProto : expvar.Var *ServiceDescriptorProto : fmt.Stringer *ServiceDescriptorProto : github.com/gogo/protobuf/proto.Message func (*FileDescriptorProto).GetService() []*ServiceDescriptorProto func google.golang.org/protobuf/reflect/protodesc.ToServiceDescriptorProto(service protoreflect.ServiceDescriptor) *ServiceDescriptorProto
Is this service deprecated? Depending on the target platform, this can emit Deprecated annotations for the service, or it will be completely ignored; in the very least, this is a formalization for deprecating services. Any features defined in the specific edition. WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language. The parser stores options it doesn't recognize here. See above. Deprecated: Use ServiceOptions.ProtoReflect.Descriptor instead. (*ServiceOptions) GetDeprecated() bool (*ServiceOptions) GetFeatures() *FeatureSet (*ServiceOptions) GetUninterpretedOption() []*UninterpretedOption (*ServiceOptions) ProtoMessage() (*ServiceOptions) ProtoReflect() protoreflect.Message (*ServiceOptions) Reset() (*ServiceOptions) String() string *ServiceOptions : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *ServiceOptions : google.golang.org/protobuf/runtime/protoiface.MessageV1 *ServiceOptions : expvar.Var *ServiceOptions : fmt.Stringer *ServiceOptions : github.com/gogo/protobuf/proto.Message func (*ServiceDescriptorProto).GetOptions() *ServiceOptions
Encapsulates information about the original source file from which a FileDescriptorProto was generated. 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 descendant. 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. Deprecated: Use SourceCodeInfo.ProtoReflect.Descriptor instead. (*SourceCodeInfo) GetLocation() []*SourceCodeInfo_Location (*SourceCodeInfo) ProtoMessage() (*SourceCodeInfo) ProtoReflect() protoreflect.Message (*SourceCodeInfo) Reset() (*SourceCodeInfo) String() string *SourceCodeInfo : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *SourceCodeInfo : google.golang.org/protobuf/runtime/protoiface.MessageV1 *SourceCodeInfo : expvar.Var *SourceCodeInfo : fmt.Stringer *SourceCodeInfo : github.com/gogo/protobuf/proto.Message func (*FileDescriptorProto).GetSourceCodeInfo() *SourceCodeInfo
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. leading_detached_comments will keep paragraphs of comments that appear before (but not connected to) the current element. Each paragraph, separated by empty lines, will be one comment element in the repeated field. 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 moo. // // Another line attached to moo. optional double moo = 4; // Detached comment for corge. This is not leading or trailing comments // to moo or corge because there are blank lines separating it from // both. // Detached comment for corge paragraph 2. optional string corge = 5; /* Block comment attached * to corge. Leading asterisks * will be removed. */ /* Block comment attached to * grault. */ optional int32 grault = 6; // ignored detached comments. LeadingDetachedComments []string 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 appears. 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). 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. TrailingComments *string Deprecated: Use SourceCodeInfo_Location.ProtoReflect.Descriptor instead. (*SourceCodeInfo_Location) GetLeadingComments() string (*SourceCodeInfo_Location) GetLeadingDetachedComments() []string (*SourceCodeInfo_Location) GetPath() []int32 (*SourceCodeInfo_Location) GetSpan() []int32 (*SourceCodeInfo_Location) GetTrailingComments() string (*SourceCodeInfo_Location) ProtoMessage() (*SourceCodeInfo_Location) ProtoReflect() protoreflect.Message (*SourceCodeInfo_Location) Reset() (*SourceCodeInfo_Location) String() string *SourceCodeInfo_Location : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *SourceCodeInfo_Location : google.golang.org/protobuf/runtime/protoiface.MessageV1 *SourceCodeInfo_Location : expvar.Var *SourceCodeInfo_Location : fmt.Stringer *SourceCodeInfo_Location : github.com/gogo/protobuf/proto.Message func (*SourceCodeInfo).GetLocation() []*SourceCodeInfo_Location
Describes the 'visibility' of a symbol with respect to the proto import system. Symbols can only be imported when the visibility rules do not prevent it (ex: local symbols cannot be imported). Visibility modifiers can only set on `message` and `enum` as they are the only types available to be referenced from other files. ( SymbolVisibility) Descriptor() protoreflect.EnumDescriptor ( SymbolVisibility) Enum() *SymbolVisibility Deprecated: Use SymbolVisibility.Descriptor instead. ( SymbolVisibility) Number() protoreflect.EnumNumber ( SymbolVisibility) String() string ( SymbolVisibility) Type() protoreflect.EnumType Deprecated: Do not use. SymbolVisibility : google.golang.org/protobuf/reflect/protoreflect.Enum *SymbolVisibility : encoding/json.Unmarshaler SymbolVisibility : expvar.Var SymbolVisibility : fmt.Stringer *SymbolVisibility : github.com/goccy/go-json.Unmarshaler func (*DescriptorProto).GetVisibility() SymbolVisibility func (*EnumDescriptorProto).GetVisibility() SymbolVisibility func SymbolVisibility.Enum() *SymbolVisibility const SymbolVisibility_VISIBILITY_EXPORT const SymbolVisibility_VISIBILITY_LOCAL const SymbolVisibility_VISIBILITY_UNSET
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. AggregateValue *string DoubleValue *float64 The value of the uninterpreted option, in whatever type the tokenizer identified it as during parsing. Exactly one of these should be set. Name []*UninterpretedOption_NamePart NegativeIntValue *int64 PositiveIntValue *uint64 StringValue []byte Deprecated: Use UninterpretedOption.ProtoReflect.Descriptor instead. (*UninterpretedOption) GetAggregateValue() string (*UninterpretedOption) GetDoubleValue() float64 (*UninterpretedOption) GetIdentifierValue() string (*UninterpretedOption) GetName() []*UninterpretedOption_NamePart (*UninterpretedOption) GetNegativeIntValue() int64 (*UninterpretedOption) GetPositiveIntValue() uint64 (*UninterpretedOption) GetStringValue() []byte (*UninterpretedOption) ProtoMessage() (*UninterpretedOption) ProtoReflect() protoreflect.Message (*UninterpretedOption) Reset() (*UninterpretedOption) String() string *UninterpretedOption : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *UninterpretedOption : google.golang.org/protobuf/runtime/protoiface.MessageV1 *UninterpretedOption : expvar.Var *UninterpretedOption : fmt.Stringer *UninterpretedOption : github.com/gogo/protobuf/proto.Message func (*EnumOptions).GetUninterpretedOption() []*UninterpretedOption func (*EnumValueOptions).GetUninterpretedOption() []*UninterpretedOption func (*ExtensionRangeOptions).GetUninterpretedOption() []*UninterpretedOption func (*FieldOptions).GetUninterpretedOption() []*UninterpretedOption func (*FileOptions).GetUninterpretedOption() []*UninterpretedOption func (*MessageOptions).GetUninterpretedOption() []*UninterpretedOption func (*MethodOptions).GetUninterpretedOption() []*UninterpretedOption func (*OneofOptions).GetUninterpretedOption() []*UninterpretedOption func (*ServiceOptions).GetUninterpretedOption() []*UninterpretedOption
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], ["moo", false] } represents "foo.(bar.baz).moo". IsExtension *bool NamePart *string Deprecated: Use UninterpretedOption_NamePart.ProtoReflect.Descriptor instead. (*UninterpretedOption_NamePart) GetIsExtension() bool (*UninterpretedOption_NamePart) GetNamePart() string (*UninterpretedOption_NamePart) ProtoMessage() (*UninterpretedOption_NamePart) ProtoReflect() protoreflect.Message (*UninterpretedOption_NamePart) Reset() (*UninterpretedOption_NamePart) String() string *UninterpretedOption_NamePart : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *UninterpretedOption_NamePart : google.golang.org/protobuf/runtime/protoiface.MessageV1 *UninterpretedOption_NamePart : expvar.Var *UninterpretedOption_NamePart : fmt.Stringer *UninterpretedOption_NamePart : github.com/gogo/protobuf/proto.Message func (*UninterpretedOption).GetName() []*UninterpretedOption_NamePart
Package-Level Variables (total 41)
Enum value maps for Edition.
Enum value maps for Edition.
Enum value maps for ExtensionRangeOptions_VerificationState.
Enum value maps for ExtensionRangeOptions_VerificationState.
Enum value maps for FeatureSet_EnforceNamingStyle.
Enum value maps for FeatureSet_EnforceNamingStyle.
Enum value maps for FeatureSet_EnumType.
Enum value maps for FeatureSet_EnumType.
Enum value maps for FeatureSet_FieldPresence.
Enum value maps for FeatureSet_FieldPresence.
Enum value maps for FeatureSet_JsonFormat.
Enum value maps for FeatureSet_JsonFormat.
Enum value maps for FeatureSet_MessageEncoding.
Enum value maps for FeatureSet_MessageEncoding.
Enum value maps for FeatureSet_RepeatedFieldEncoding.
Enum value maps for FeatureSet_RepeatedFieldEncoding.
Enum value maps for FeatureSet_Utf8Validation.
Enum value maps for FeatureSet_Utf8Validation.
Enum value maps for FeatureSet_VisibilityFeature_DefaultSymbolVisibility.
Enum value maps for FeatureSet_VisibilityFeature_DefaultSymbolVisibility.
Enum value maps for FieldDescriptorProto_Label.
Enum value maps for FieldDescriptorProto_Label.
Enum value maps for FieldDescriptorProto_Type.
Enum value maps for FieldDescriptorProto_Type.
Enum value maps for FieldOptions_CType.
Enum value maps for FieldOptions_CType.
Enum value maps for FieldOptions_JSType.
Enum value maps for FieldOptions_JSType.
Enum value maps for FieldOptions_OptionRetention.
Enum value maps for FieldOptions_OptionRetention.
Enum value maps for FieldOptions_OptionTargetType.
Enum value maps for FieldOptions_OptionTargetType.
Enum value maps for FileOptions_OptimizeMode.
Enum value maps for FileOptions_OptimizeMode.
Enum value maps for GeneratedCodeInfo_Annotation_Semantic.
Enum value maps for GeneratedCodeInfo_Annotation_Semantic.
Enum value maps for MethodOptions_IdempotencyLevel.
Enum value maps for MethodOptions_IdempotencyLevel.
Enum value maps for SymbolVisibility.
Enum value maps for SymbolVisibility.
Package-Level Constants (total 120)
Default values for EnumOptions fields.
Default values for EnumValueOptions fields.
Default values for EnumValueOptions fields.
Default values for ExtensionRangeOptions fields.
Default values for FieldOptions fields.
Default values for FieldOptions fields.
Default values for FieldOptions fields.
Default values for FieldOptions fields.
Default values for FieldOptions fields.
Default values for FieldOptions fields.
Default values for FieldOptions fields.
Default values for FileOptions fields.
Default values for FileOptions fields.
Default values for FileOptions fields.
Default values for FileOptions fields.
Default values for FileOptions fields.
Default values for FileOptions fields.
Default values for FileOptions fields.
Default values for FileOptions fields.
Default values for MessageOptions fields.
Default values for MessageOptions fields.
Default values for MessageOptions fields.
Default values for MethodDescriptorProto fields.
Default values for MethodDescriptorProto fields.
Default values for MethodOptions fields.
Default values for MethodOptions fields.
Default values for ServiceOptions fields.
Placeholder editions for testing feature resolution. These should not be used or relied on outside of tests.
Editions that have been released. The specific values are arbitrary and should not be depended on, but they will always be time-ordered for easy comparison.
A placeholder edition for specifying default behaviors *before* a feature was first introduced. This is effectively an "infinite past".
Placeholder for specifying unbounded edition support. This should only ever be used by plugins that can expect to never require any changes to support a new edition.
Legacy syntax "editions". These pre-date editions, but behave much like distinct editions. These can't be used to specify the edition of proto files, but feature definitions must supply proto2/proto3 defaults for backwards compatibility.
A placeholder for an unknown edition value.
All the extensions of the range must be declared.
Default pre-EDITION_2024, all UNSET visibility are export.
All top-level symbols default to export, nested default to local.
All symbols local by default. Nested types cannot be exported. With special case caveat for message { enum {} reserved 1 to max; } This is the recommended setting for new protos.
The required label is only allowed in google.protobuf. In proto3 and Editions it's explicitly prohibited. In Editions, the `field_presence` feature can be used to get this behavior.
0 is reserved for errors. Order is weird for historical reasons.
Tag-delimited aggregate. Group type is deprecated and not supported after google.protobuf. However, Proto3 implementations should still be able to parse the group wire format and treat group fields as unknown fields. In Editions, the group wire format can be enabled via the `message_encoding` feature.
Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT32 if negative values are likely.
Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT64 if negative values are likely.
const FieldDescriptorProto_TYPE_MESSAGE FieldDescriptorProto_Type = 11 // Length-delimited aggregate.
const FieldDescriptorProto_TYPE_SINT32 FieldDescriptorProto_Type = 17 // Uses ZigZag encoding.
const FieldDescriptorProto_TYPE_SINT64 FieldDescriptorProto_Type = 18 // Uses ZigZag encoding.
The option [ctype=CORD] may be applied to a non-repeated field of type "bytes". It indicates that in C++, the data should be stored in a Cord instead of a string. For very large strings, this may reduce memory fragmentation. It may also allow better performance when parsing from a Cord, or when parsing with aliasing enabled, as the parsed Cord may then alias the original buffer.
Use the default type.
Use JavaScript numbers.
Use JavaScript strings.
Default mode.
const FieldOptions_TARGET_TYPE_ENUM_ENTRY FieldOptions_OptionTargetType = 7
etc.
const FileOptions_LITE_RUNTIME FileOptions_OptimizeMode = 3 // Generate code using MessageLite and the lite runtime.
const FileOptions_SPEED FileOptions_OptimizeMode = 1 // Generate complete code for parsing, serialization,
An alias to the element is returned.
There is no effect or the effect is indescribable.
The element is set or otherwise mutated.
const MethodOptions_IDEMPOTENT MethodOptions_IdempotencyLevel = 2 // idempotent, but may have side effects