package google.protobuf

Get desktop application:
View/edit binary Protocol Buffers messages

`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); } // or ... if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); } 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 := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(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 as request type in: test.proto.v1.test_proto.Any

Used as response type in: test.proto.v1.test_proto.Any

Used as field type in: Option, test.proto.v1.M1

• string type_url = 1

  A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

• bytes value = 2

  Must be a valid serialized protocol buffer of the above specified type.

Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.

Used as request type in: test.proto.v1.test_proto.Api

Used as response type in: test.proto.v1.test_proto.Api

• string name = 1

  The fully qualified name of this interface, including package name followed by the interface's simple name.

• repeated Method methods = 2

  The methods of this interface, in unspecified order.

• repeated Option options = 3

  Any metadata attached to the interface.

• string version = 4

  A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v<major-version>`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.

• optional SourceContext source_context = 5

  Source context for the protocol buffer service represented by this message.

• repeated Mixin mixins = 6

  Included interfaces. See [Mixin][].

• Syntax syntax = 7

  The source syntax of the service.

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

Used as request type in: test.proto.v1.test_proto.BoolValue

Used as response type in: test.proto.v1.test_proto.BoolValue

Used as field type in: test.proto.v1.Types

• bool value = 1

  The bool value.

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

Used as request type in: test.proto.v1.test_proto.BytesValue

Used as response type in: test.proto.v1.test_proto.BytesValue

Used as field type in: test.proto.v1.Types

• bytes value = 1

  The bytes value.

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

Used as request type in: test.proto.v1.test_proto.DoubleValue

Used as response type in: test.proto.v1.test_proto.DoubleValue

Used as field type in: test.proto.v1.Types

• double value = 1

  The double value.

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 as request type in: test.proto.v1.test_proto.Duration

Used as response type in: test.proto.v1.test_proto.Duration

Used as field type in: test.proto.v1.Types

• int64 seconds = 1

  Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

• int32 nanos = 2

  Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.

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); }

Used as request type in: test.proto.v1.test_proto.Empty

Used as response type in: test.proto.v1.test_proto.Empty

(message has no fields)

Enum type definition.

Used as request type in: test.proto.v1.test_proto.Enum

Used as response type in: test.proto.v1.test_proto.Enum

• string name = 1

  Enum type name.

• repeated EnumValue enumvalue = 2

  Enum value definitions.

• repeated Option options = 3

  Protocol buffer options.

• optional SourceContext source_context = 4

  The source context.

• Syntax syntax = 5

  The source syntax.

• string edition = 6

  The source edition string, only valid when syntax is SYNTAX_EDITIONS.

Enum value definition.

Used as request type in: test.proto.v1.test_proto.EnumValue

Used as response type in: test.proto.v1.test_proto.EnumValue

Used as field type in: Enum

• string name = 1

  Enum value name.

• int32 number = 2

  Enum value number.

• repeated Option options = 3

  Protocol buffer options.

A single field of a message type.

Used as request type in: test.proto.v1.test_proto.Field

Used as response type in: test.proto.v1.test_proto.Field

Used as field type in: Type

• Field.Kind kind = 1

  The field type.

• Field.Cardinality cardinality = 2

  The field cardinality.

• int32 number = 3

  The field number.

• string name = 4

  The field name.

• string type_url = 6

  The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.

• int32 oneof_index = 7

  The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list.

• bool packed = 8

  Whether to use alternative packed wire representation.

• repeated Option options = 9

  The protocol buffer options.

• string json_name = 10

  The field JSON name.

• string default_value = 11

  The string value of the default value of this field. Proto2 syntax only.

Whether a field is optional, required, or repeated.

Used in: Field

• CARDINALITY_UNKNOWN = 0

  For fields with unknown cardinality.

• CARDINALITY_OPTIONAL = 1

  For optional fields.

• CARDINALITY_REQUIRED = 2

  For required fields. Proto2 syntax only.

• CARDINALITY_REPEATED = 3

  For repeated fields.

Basic field types.

Used in: Field

• TYPE_UNKNOWN = 0

  Field type unknown.

• TYPE_DOUBLE = 1

  Field type double.

• TYPE_FLOAT = 2

  Field type float.

• TYPE_INT64 = 3

  Field type int64.

• TYPE_UINT64 = 4

  Field type uint64.

• TYPE_INT32 = 5

  Field type int32.

• TYPE_FIXED64 = 6

  Field type fixed64.

• TYPE_FIXED32 = 7

  Field type fixed32.

• TYPE_BOOL = 8

  Field type bool.

• TYPE_STRING = 9

  Field type string.

• TYPE_GROUP = 10

  Field type group. Proto2 syntax only, and deprecated.

• TYPE_MESSAGE = 11

  Field type message.

• TYPE_BYTES = 12

  Field type bytes.

• TYPE_UINT32 = 13

  Field type uint32.

• TYPE_ENUM = 14

  Field type enum.

• TYPE_SFIXED32 = 15

  Field type sfixed32.

• TYPE_SFIXED64 = 16

  Field type sfixed64.

• TYPE_SINT32 = 17

  Field type sint32.

• TYPE_SINT64 = 18

  Field type sint64.

`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`. Field masks are used to specify a subset of fields that should be returned by a get operation or modified by an update operation. Field masks also have a custom JSON encoding (see below). # Field Masks in Projections When used in the context of a projection, a response message or sub-message is filtered by the API to only contain those fields as specified in the mask. For example, if the mask in the previous example is applied to a response message as follows: f { a : 22 b { d : 1 x : 2 } y : 13 } z: 8 The result will not contain specific values for fields x,y and z (their value will be set to the default, and omitted in proto text output): f { a : 22 b { d : 1 } } A repeated field is not allowed except at the last position of a paths string. If a FieldMask object is not present in a get operation, the operation applies to all fields (as if a FieldMask of all fields had been specified). Note that a field mask does not necessarily apply to the top-level response message. In case of a REST get operation, the field mask applies directly to the response, but in case of a REST list operation, the mask instead applies to each individual message in the returned resource list. In case of a REST custom method, other definitions may be used. Where the mask applies will be clearly documented together with its declaration in the API. In any case, the effect on the returned resource/resources is required behavior for APIs. # Field Masks in Update Operations A field mask in update operations specifies which fields of the targeted resource are going to be updated. The API is required to only change the values of the fields as specified in the mask and leave the others untouched. If a resource is passed in to describe the updated values, the API ignores the values of all fields not covered by the mask. If a repeated field is specified for an update operation, new values will be appended to the existing repeated field in the target resource. Note that a repeated field is only allowed in the last position of a `paths` string. If a sub-message is specified in the last position of the field mask for an update operation, then new value will be merged into the existing sub-message in the target resource. For example, given the target message: f { b { d: 1 x: 2 } c: [1] } And an update message: f { b { d: 10 } c: [2] } then if the field mask is: paths: ["f.b", "f.c"] then the result will be: f { b { d: 10 x: 2 } c: [1, 2] } An implementation may provide options to override this default behavior for repeated and message fields. In order to reset a field's value to the default, the field must be in the mask and set to the default value in the provided resource. Hence, in order to reset all fields of a resource, provide a default instance of the resource and set all fields in the mask, or do not provide a mask as described below. If a field mask is not present on update, the operation applies to all fields (as if a field mask of all fields has been specified). Note that in the presence of schema evolution, this may mean that fields the client does not know and has therefore not filled into the request will be reset to their default. If this is unwanted behavior, a specific service may require a client to always specify a field mask, producing an error if not. As with get operations, the location of the resource which describes the updated values in the request message depends on the operation kind. In any case, the effect of the field mask is required to be honored by the API. ## Considerations for HTTP REST The HTTP kind of an update operation which uses a field mask must be set to PATCH instead of PUT in order to satisfy HTTP semantics (PUT must only be used for full updates). # JSON Encoding of Field Masks In JSON, a field mask is encoded as a single string where paths are separated by a comma. Fields name in each path are converted to/from lower-camel naming conventions. As an example, consider the following message declarations: message Profile { User user = 1; Photo photo = 2; } message User { string display_name = 1; string address = 2; } In proto a field mask for `Profile` may look as such: mask { paths: "user.display_name" paths: "photo" } In JSON, the same mask is represented as below: { mask: "user.displayName,photo" } # Field Masks and Oneof Fields Field masks treat fields in oneofs just as regular fields. Consider the following message: message SampleMessage { oneof test_oneof { string name = 4; SubMessage sub_message = 9; } } The field mask can be: mask { paths: "name" } Or: mask { paths: "sub_message" } Note that oneof type names ("test_oneof" in this case) cannot be used in paths. ## Field Mask Verification The implementation of any API method which has a FieldMask type field in the request should verify the included field paths, and return an `INVALID_ARGUMENT` error if any path is unmappable.

Used as request type in: test.proto.v1.test_proto.FieldMask

Used as response type in: test.proto.v1.test_proto.FieldMask

• repeated string paths = 1

  The set of field mask paths.

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

Used as request type in: test.proto.v1.test_proto.FloatValue

Used as response type in: test.proto.v1.test_proto.FloatValue

Used as field type in: test.proto.v1.Types

• float value = 1

  The float value.

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

Used as request type in: test.proto.v1.test_proto.Int32Value

Used as response type in: test.proto.v1.test_proto.Int32Value

Used as field type in: test.proto.v1.Types

• int32 value = 1

  The int32 value.

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

Used as request type in: test.proto.v1.test_proto.Int64Value

Used as response type in: test.proto.v1.test_proto.Int64Value

Used as field type in: test.proto.v1.Types

• int64 value = 1

  The int64 value.

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

Used as request type in: test.proto.v1.test_proto.ListValue

Used as response type in: test.proto.v1.test_proto.ListValue

Used as field type in: Value, test.proto.v1.Types

• repeated Value values = 1

  Repeated field of dynamically typed values.

Method represents a method of an API interface.

Used as request type in: test.proto.v1.test_proto.Method

Used as response type in: test.proto.v1.test_proto.Method

Used as field type in: Api

• string name = 1

  The simple name of this method.

• string request_type_url = 2

  A URL of the input message type.

• bool request_streaming = 3

  If true, the request is streamed.

• string response_type_url = 4

  The URL of the output message type.

• bool response_streaming = 5

  If true, the response is streamed.

• repeated Option options = 6

  Any metadata attached to the method.

• Syntax syntax = 7

  The source syntax of this method.

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. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the [root][] path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package google.storage.v2; service Storage { rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inheriting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... }

Used as request type in: test.proto.v1.test_proto.Mixin

Used as response type in: test.proto.v1.test_proto.Mixin

Used as field type in: Api

• string name = 1

  The fully qualified name of the interface which is included.

• string root = 2

  If non-empty specifies a path under which inherited HTTP paths are rooted.

`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

• NULL_VALUE = 0

  Null value.

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

Used as request type in: test.proto.v1.test_proto.Option

Used as response type in: test.proto.v1.test_proto.Option

Used as field type in: Api, Enum, EnumValue, Field, Method, Type

• string name = 1

  The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`.

• optional Any value = 2

  The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.

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

Used as request type in: test.proto.v1.test_proto.SourceContext

Used as response type in: test.proto.v1.test_proto.SourceContext

Used as field type in: Api, Enum, Type

• string file_name = 1

  The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`.

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

Used as request type in: test.proto.v1.test_proto.StringValue

Used as response type in: test.proto.v1.test_proto.StringValue

Used as field type in: test.proto.v1.Types

• string value = 1

  The string value.

`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 as request type in: test.proto.v1.test_proto.Struct

Used as response type in: test.proto.v1.test_proto.Struct

Used as field type in: Value, test.proto.v1.Types

• map<string, Value> fields = 1

  Unordered map of dynamically typed values.

The syntax in which a protocol buffer element is defined.

Used in: Api, Enum, Method, Type

• SYNTAX_PROTO2 = 0

  Syntax `proto2`.

• SYNTAX_PROTO3 = 1

  Syntax `proto3`.

• SYNTAX_EDITIONS = 2

  Syntax `editions`.

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. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The 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](https://www.ietf.org/rfc/rfc3339.txt) date strings. # 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 Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: 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://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime() ) to obtain a formatter capable of generating timestamps in this format.

Used as request type in: test.proto.v1.test_proto.Timestamp

Used as response type in: test.proto.v1.test_proto.Timestamp

Used as field type in: test.proto.v1.Types

• int64 seconds = 1

  Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

• int32 nanos = 2

  Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.

A protocol buffer message type.

Used as request type in: test.proto.v1.test_proto.Type

Used as response type in: test.proto.v1.test_proto.Type

• string name = 1

  The fully qualified message name.

• repeated Field fields = 2

  The list of fields.

• repeated string oneofs = 3

  The list of types appearing in `oneof` definitions in this type.

• repeated Option options = 4

  The protocol buffer options.

• optional SourceContext source_context = 5

  The source context.

• Syntax syntax = 6

  The source syntax.

• string edition = 7

  The source edition string, only valid when syntax is SYNTAX_EDITIONS.

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

Used as request type in: test.proto.v1.test_proto.UInt32Value

Used as response type in: test.proto.v1.test_proto.UInt32Value

Used as field type in: test.proto.v1.Types

• uint32 value = 1

  The uint32 value.

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

Used as request type in: test.proto.v1.test_proto.UInt64Value

Used as response type in: test.proto.v1.test_proto.UInt64Value

Used as field type in: test.proto.v1.Types

• uint64 value = 1

  The uint64 value.

`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. The JSON representation for `Value` is JSON value.

Used as request type in: test.proto.v1.test_proto.Value

Used as response type in: test.proto.v1.test_proto.Value

Used as field type in: ListValue, Struct, test.proto.v1.Types

• oneof kind

  The kind of value.

  • NullValue null_value = 1

    Represents a null value.

  • double number_value = 2

    Represents a double value.

  • string string_value = 3

    Represents a string value.

  • bool bool_value = 4

    Represents a boolean value.

  • Struct struct_value = 5

    Represents a structured value.

  • ListValue list_value = 6

    Represents a repeated `Value`.