Classes

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Api is a light-weight descriptor for an API Interface.

Wrapper message for bool.

Wrapper message for bytes.

Wrapper message for double.

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.

Enum type definition.

Enum value definition.

A single field of a message type.

FieldMask represents a set of symbolic field paths, for example: paths: "f.a" paths: "f.b.d" Here f represents a field in some root message, a and b fields in the message found in f, and d a field found in the message in f.b.

Whether a field is optional, required, or repeated.

Basic field types.

This class is deprecated. Use Google\Protobuf\Field\Cardinality instead.

This class is deprecated. Use Google\Protobuf\Field\Kind instead.

Wrapper message for float.

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: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

Wrapper message for int32.

Wrapper message for int64.

Base class for Google\Protobuf\Any, this contains hand-written convenience methods like pack() and unpack().

Describes a message type.

Generated from protobuf message google.protobuf.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.

This class is deprecated. Use Google\Protobuf\Internal\DescriptorProto\ExtensionRange instead.

This class is deprecated. Use Google\Protobuf\Internal\DescriptorProto\ReservedRange instead.

Describes an enum type.

Range of reserved numeric values. Reserved values may not be used by entries in the same enum. Reserved ranges may not overlap.

This class is deprecated. Use Google\Protobuf\Internal\EnumDescriptorProto\EnumReservedRange instead.

Generated from protobuf message google.protobuf.EnumOptions

Describes a value within an enum.

Generated from protobuf message google.protobuf.EnumValueOptions

Generated from protobuf message google.protobuf.ExtensionRangeOptions

Describes a field within a message.

Protobuf type google.protobuf.FieldDescriptorProto.Label

Protobuf type google.protobuf.FieldDescriptorProto.Type

This class is deprecated. Use Google\Protobuf\Internal\FieldDescriptorProto\Label instead.

This class is deprecated. Use Google\Protobuf\Internal\FieldDescriptorProto\Type instead.

Generated from protobuf message google.protobuf.FieldOptions

Protobuf type google.protobuf.FieldOptions.CType

Protobuf type google.protobuf.FieldOptions.JSType

This class is deprecated. Use Google\Protobuf\Internal\FieldOptions\CType instead.

This class is deprecated. Use Google\Protobuf\Internal\FieldOptions\JSType instead.

Describes a complete .proto file.

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

Generated from protobuf message google.protobuf.FileOptions

Generated classes can be optimized for speed or code size.

This class is deprecated. Use Google\Protobuf\Internal\FileOptions\OptimizeMode instead.

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.

Generated from protobuf message google.protobuf.GeneratedCodeInfo.Annotation

This class is deprecated. Use Google\Protobuf\Internal\GeneratedCodeInfo\Annotation instead.

MapField is used by generated protocol message classes to manipulate map fields. It can be used like native PHP array.

MapFieldIter is used to iterate MapField. It is also need for the foreach syntax.

Parent class of all proto messages. Users should not instantiate this class or extend this class or its child classes by their own. See the comment of specific functions for more details.

Generated from protobuf message google.protobuf.MessageOptions

Describes a method of a service.

Generated from protobuf message google.protobuf.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.

This class is deprecated. Use Google\Protobuf\Internal\MethodOptions\IdempotencyLevel instead.

Describes a oneof.

Generated from protobuf message google.protobuf.OneofOptions

RepeatedField is used by generated protocol message classes to manipulate repeated fields. It can be used like native PHP array.

RepeatedFieldIter is used to iterate RepeatedField. It is also need for the foreach syntax.

Describes a service.

Generated from protobuf message google.protobuf.ServiceOptions

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

Generated from protobuf message google.protobuf.SourceCodeInfo.Location

This class is deprecated. Use Google\Protobuf\Internal\SourceCodeInfo\Location instead.

Base class for Google\Protobuf\Timestamp, this contains hand-written convenience methods.

A message representing a option the parser does not recognize. This only appears in options protos created by the compiler::Parser class.

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).

This class is deprecated. Use Google\Protobuf\Internal\UninterpretedOption\NamePart instead.

ListValue is a wrapper around a repeated field of values.

Method represents a method of an API interface.

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:

• If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method.

NullValue is a singleton enumeration to represent the null value for the Value type union.

A protocol buffer option, which can be attached to a message, field, enumeration, etc.

SourceContext represents information about the source of a protobuf element, like the file in which it is defined.

Wrapper message for string.

Struct represents a structured data value, consisting of fields which map to dynamically typed values. In some languages, Struct might 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.

The syntax in which a protocol buffer element is defined.

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.

A protocol buffer message type.

Wrapper message for uint32.

Wrapper message for uint64.

Value represents 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.