protobuf_wellknown library
Well-Known Types from Protocol Buffers.
These types are distributed with the Protocol Buffers compiler, and are imported by the files generated by the compiler plugins.
This library is for using in curated Dart code, while the individual type libraries are useful for the generated sources.
Classes
- Any
-
Anycontains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. - Api
- Api is a light-weight descriptor for an API Interface.
- BoolValue
-
Wrapper message for
bool. - BytesValue
-
Wrapper message for
bytes. - DescriptorProto
- Describes a message type.
- DescriptorProto_ExtensionRange
- DescriptorProto_ReservedRange
- 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.
- DoubleValue
-
Wrapper message for
double. - Duration
- A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years.
- Empty
- A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
- Enum
- Enum type definition.
- EnumDescriptorProto
- Describes an enum type.
- EnumDescriptorProto_EnumReservedRange
- Range of reserved numeric values. Reserved values may not be used by entries in the same enum. Reserved ranges may not overlap.
- EnumOptions
- EnumValue
- Enum value definition.
- EnumValueDescriptorProto
- Describes a value within an enum.
- EnumValueOptions
- ExtensionRangeOptions
- Field
- A single field of a message type.
- Field_Cardinality
- Whether a field is optional, required, or repeated.
- Field_Kind
- Basic field types.
- FieldDescriptorProto
- Describes a field within a message.
- FieldDescriptorProto_Label
- FieldDescriptorProto_Type
- FieldMask
-
FieldMaskrepresents a set of symbolic field paths, for example: - FieldOptions
- FieldOptions_CType
- FieldOptions_JSType
- FileDescriptorProto
- Describes a complete .proto file.
- FileDescriptorSet
- The protocol compiler can output a FileDescriptorSet containing the .proto files it parses.
- FileOptions
- FileOptions_OptimizeMode
- Generated classes can be optimized for speed or code size.
- FloatValue
-
Wrapper message for
float. - GeneratedCodeInfo
- 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.
- GeneratedCodeInfo_Annotation
- Int32Value
-
Wrapper message for
int32. - Int64Value
-
Wrapper message for
int64. - ListValue
-
ListValueis a wrapper around a repeated field of values. - MessageOptions
- Method
- Method represents a method of an API interface.
- MethodDescriptorProto
- Describes a method of a service.
- MethodOptions
- MethodOptions_IdempotencyLevel
- 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.
- Mixin
- Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows:
- NullValue
-
NullValueis a singleton enumeration to represent the null value for theValuetype union. - OneofDescriptorProto
- Describes a oneof.
- OneofOptions
- Option
- A protocol buffer option, which can be attached to a message, field, enumeration, etc.
- ServiceDescriptorProto
- Describes a service.
- ServiceOptions
- SourceCodeInfo
- Encapsulates information about the original source file from which a FileDescriptorProto was generated.
- SourceCodeInfo_Location
- SourceContext
-
SourceContextrepresents information about the source of a protobuf element, like the file in which it is defined. - StringValue
-
Wrapper message for
string. - Struct
-
Structrepresents a structured data value, consisting of fields which map to dynamically typed values. In some languages,Structmight be supported by a native representation. For example, in scripting languages like JS a struct is represented as an object. The details of that representation are described together with the proto support for the language. - Syntax
- The syntax in which a protocol buffer element is defined.
- Timestamp
- A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.
- Type
- A protocol buffer message type.
- UInt32Value
-
Wrapper message for
uint32. - UInt64Value
-
Wrapper message for
uint64. - UninterpretedOption
- 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.
- UninterpretedOption_NamePart
-
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". - Value
-
Valuerepresents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.