package google.protobuf

Mouse Melon logoGet desktop application:
View/edit binary Protocol Buffers messages

message Any

any.proto:122

`Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... } Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := ptypes.MarshalAny(foo) ... foo := &pb.Foo{} if err := ptypes.UnmarshalAny(any, foo); err != nil { ... } The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example: package google.profile; message Person { string first_name = 1; string last_name = 2; } { "@type": "type.googleapis.com/google.profile.Person", "firstName": <string>, "lastName": <string> } If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]): { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

Used in: rpc.Status

message BoolValue

wrappers.proto:99

Wrapper message for `bool`. The JSON representation for `BoolValue` is JSON `true` and `false`.

message BytesValue

wrappers.proto:115

Wrapper message for `bytes`. The JSON representation for `BytesValue` is JSON string.

message DescriptorProto

descriptor.proto:154

Describes a message type.

Used in: FileDescriptorProto

message DescriptorProto.ExtensionRange

descriptor.proto:163

Used in: DescriptorProto

message DescriptorProto.ReservedRange

descriptor.proto:178

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.

Used in: DescriptorProto

message DoubleValue

wrappers.proto:51

Wrapper message for `double`. The JSON representation for `DoubleValue` is JSON number.

message Duration

duration.proto:102

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. # Examples Example 1: Compute Duration from two Timestamps in pseudo code. Timestamp start = ...; Timestamp end = ...; Duration duration = ...; duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos; if (duration.seconds < 0 && duration.nanos > 0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (duration.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; } Example 2: Compute Timestamp from Timestamp + Duration in pseudo code. Timestamp start = ...; Duration duration = ...; Timestamp end = ...; end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos; if (end.nanos < 0) { end.seconds -= 1; end.nanos += 1000000000; } else if (end.nanos >= 1000000000) { end.seconds += 1; end.nanos -= 1000000000; } Example 3: Compute Duration from datetime.timedelta in Python. td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td) # JSON Mapping In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".

Used in: firebase.dataconnect.v1.DataConnectProperties

enum Edition

descriptor.proto:68

The full set of known editions.

Used in: FeatureSetDefaults, FeatureSetDefaults.FeatureSetEditionDefault, FieldOptions.EditionDefault, FieldOptions.FeatureSupport, FileDescriptorProto

message Empty

empty.proto:52

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); } The JSON representation for `Empty` is empty JSON object `{}`.

Used in: firebase.dataconnect.v1.StreamRequest

(message has no fields)

message EnumDescriptorProto

descriptor.proto:359

Describes an enum type.

Used in: DescriptorProto, FileDescriptorProto

message EnumDescriptorProto.EnumReservedRange

descriptor.proto:372

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.

Used in: EnumDescriptorProto

message EnumOptions

descriptor.proto:869

Used in: EnumDescriptorProto

message EnumValueDescriptorProto

descriptor.proto:391

Describes a value within an enum.

Used in: EnumDescriptorProto

message EnumValueOptions

descriptor.proto:904

Used in: EnumValueDescriptorProto

message ExtensionRangeOptions

descriptor.proto:191

Used in: DescriptorProto.ExtensionRange

message ExtensionRangeOptions.Declaration

descriptor.proto:195

Used in: ExtensionRangeOptions

enum ExtensionRangeOptions.VerificationState

descriptor.proto:229

The verification state of the extension range.

Used in: ExtensionRangeOptions

message FeatureSet

descriptor.proto:1032

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.

Used in: EnumOptions, EnumValueOptions, ExtensionRangeOptions, FeatureSetDefaults.FeatureSetEditionDefault, FieldOptions, FileOptions, MessageOptions, MethodOptions, OneofOptions, ServiceOptions

enum FeatureSet.EnforceNamingStyle

descriptor.proto:1132

Used in: FeatureSet

enum FeatureSet.EnumType

descriptor.proto:1051

Used in: FeatureSet

enum FeatureSet.FieldPresence

descriptor.proto:1033

Used in: FeatureSet

enum FeatureSet.JsonFormat

descriptor.proto:1115

Used in: FeatureSet

enum FeatureSet.MessageEncoding

descriptor.proto:1100

Used in: FeatureSet

enum FeatureSet.RepeatedFieldEncoding

descriptor.proto:1067

Used in: FeatureSet

enum FeatureSet.Utf8Validation

descriptor.proto:1083

Used in: FeatureSet

message FeatureSet.VisibilityFeature

descriptor.proto:1155

(message has no fields)

enum FeatureSet.VisibilityFeature.DefaultSymbolVisibility

descriptor.proto:1156

Used in: FeatureSet

message FeatureSetDefaults

descriptor.proto:1230

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.

message FeatureSetDefaults.FeatureSetEditionDefault

descriptor.proto:1235

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.

Used in: FeatureSetDefaults

message FieldDescriptorProto

descriptor.proto:246

Describes a field within a message.

Used in: DescriptorProto, FileDescriptorProto

enum FieldDescriptorProto.Label

descriptor.proto:281

Used in: FieldDescriptorProto

enum FieldDescriptorProto.Type

descriptor.proto:247

Used in: FieldDescriptorProto

message FieldOptions

descriptor.proto:682

Used in: FieldDescriptorProto

enum FieldOptions.CType

descriptor.proto:691

Used in: FieldOptions

message FieldOptions.EditionDefault

descriptor.proto:807

Used in: FieldOptions

message FieldOptions.FeatureSupport

descriptor.proto:820

Information about the support window of a feature.

Used in: EnumValueOptions, FieldOptions

enum FieldOptions.JSType

descriptor.proto:726

Used in: FieldOptions

enum FieldOptions.OptionRetention

descriptor.proto:781

If set to RETENTION_SOURCE, the option will be omitted from the binary.

Used in: FieldOptions

enum FieldOptions.OptionTargetType

descriptor.proto:792

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.

Used in: FieldOptions

message FileDescriptorProto

descriptor.proto:107

Describes a complete .proto file.

Used in: FileDescriptorSet

message FileDescriptorSet

descriptor.proto:56

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

message FileOptions

descriptor.proto:458

Used in: FileDescriptorProto

enum FileOptions.OptimizeMode

descriptor.proto:507

Generated classes can be optimized for speed or code size.

Used in: FileOptions

message FloatValue

wrappers.proto:59

Wrapper message for `float`. The JSON representation for `FloatValue` is JSON number.

message GeneratedCodeInfo

descriptor.proto:1404

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.

message GeneratedCodeInfo.Annotation

descriptor.proto:1408

Used in: GeneratedCodeInfo

enum GeneratedCodeInfo.Annotation.Semantic

descriptor.proto:1427

Represents the identified object's effect on the element in the original .proto file.

Used in: Annotation

message Int32Value

wrappers.proto:83

Wrapper message for `int32`. The JSON representation for `Int32Value` is JSON number.

message Int64Value

wrappers.proto:67

Wrapper message for `int64`. The JSON representation for `Int64Value` is JSON string.

message ListValue

struct.proto:93

`ListValue` is a wrapper around a repeated field of values. The JSON representation for `ListValue` is JSON array.

Used in: firebase.dataconnect.v1.DataConnectProperties, firebase.dataconnect.v1.GraphqlError, Value

message MessageOptions

descriptor.proto:597

Used in: DescriptorProto

message MethodDescriptorProto

descriptor.proto:410

Describes a method of a service.

Used in: ServiceDescriptorProto

message MethodOptions

descriptor.proto:958

Used in: MethodDescriptorProto

enum MethodOptions.IdempotencyLevel

descriptor.proto:974

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.

Used in: MethodOptions

enum NullValue

struct.proto:85

`NullValue` is a singleton enumeration to represent the null value for the `Value` type union. The JSON representation for `NullValue` is JSON `null`.

Used in: Value

message OneofDescriptorProto

descriptor.proto:353

Describes a oneof.

Used in: DescriptorProto

message OneofOptions

descriptor.proto:855

Used in: OneofDescriptorProto

message ServiceDescriptorProto

descriptor.proto:399

Describes a service.

Used in: FileDescriptorProto

message ServiceOptions

descriptor.proto:932

Used in: ServiceDescriptorProto

message SourceCodeInfo

descriptor.proto:1263

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

Used in: FileDescriptorProto

message SourceCodeInfo.Location

descriptor.proto:1308

Used in: SourceCodeInfo

message StringValue

wrappers.proto:107

Wrapper message for `string`. The JSON representation for `StringValue` is JSON string.

message Struct

struct.proto:52

`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 JSON representation for `Struct` is JSON object.

Used in: firebase.dataconnect.v1.ExecuteMutationRequest, firebase.dataconnect.v1.ExecuteMutationResponse, firebase.dataconnect.v1.ExecuteQueryRequest, firebase.dataconnect.v1.ExecuteQueryResponse, firebase.dataconnect.v1.ExecuteRequest, firebase.dataconnect.v1.StreamResponse, Value

enum SymbolVisibility

descriptor.proto:1444

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.

Used in: DescriptorProto, EnumDescriptorProto

message Timestamp

timestamp.proto:123

A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString] method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime-- ) to obtain a formatter capable of generating timestamps in this format.

message UInt32Value

wrappers.proto:91

Wrapper message for `uint32`. The JSON representation for `UInt32Value` is JSON number.

message UInt64Value

wrappers.proto:75

Wrapper message for `uint64`. The JSON representation for `UInt64Value` is JSON string.

message UninterpretedOption

descriptor.proto:1001

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.

Used in: EnumOptions, EnumValueOptions, ExtensionRangeOptions, FieldOptions, FileOptions, MessageOptions, MethodOptions, OneofOptions, ServiceOptions

message UninterpretedOption.NamePart

descriptor.proto:1007

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

Used in: UninterpretedOption

message Value

struct.proto:63

`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 that variants, absence of any variant indicates an error. The JSON representation for `Value` is JSON value.

Used in: ListValue, Struct