1// Protocol Buffers - Google's data interchange format  2// Copyright 2008 Google Inc.  All rights reserved.  3// https://developers.google.com/protocol-buffers/  4//  5// Redistribution and use in source and binary forms, with or without  6// modification, are permitted provided that the following conditions are  7// met:  8//  9//     * Redistributions of source code must retain the above copyright 10// notice, this list of conditions and the following disclaimer. 11//     * Redistributions in binary form must reproduce the above 12// copyright notice, this list of conditions and the following disclaimer 13// in the documentation and/or other materials provided with the 14// distribution. 15//     * Neither the name of Google Inc. nor the names of its 16// contributors may be used to endorse or promote products derived from 17// this software without specific prior written permission. 18// 19// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 22// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 31syntax = "proto3"; 32 33package google.protobuf; 34 35option cc_enable_arenas = true; 36option go_package = "google.golang.org/protobuf/types/known/structpb"; 37option java_package = "com.google.protobuf"; 38option java_outer_classname = "StructProto"; 39option java_multiple_files = true; 40option objc_class_prefix = "GPB"; 41option csharp_namespace = "Google.Protobuf.WellKnownTypes"; 42 43// Represents a JSON object. 44// 45// An unordered key-value map, intending to perfectly capture the semantics of a 46// JSON object. This enables parsing any arbitrary JSON payload as a message 47// field in ProtoJSON format. 48// 49// This follows RFC 8259 guidelines for interoperable JSON: notably this type 50// cannot represent large Int64 values or `NaN`/`Infinity` numbers, 51// since the JSON format generally does not support those values in its number 52// type. 53// 54// If you do not intend to parse arbitrary JSON into your message, a custom 55// typed message should be preferred instead of using this type. 56message Struct { 57  // Unordered map of dynamically typed values. 58  map<string, Value> fields = 1; 59} 60 61// Represents a JSON value. 62// 63// `Value` represents a dynamically typed value which can be either 64// null, a number, a string, a boolean, a recursive struct value, or a 65// list of values. A producer of value is expected to set one of these 66// variants. Absence of any variant is an invalid state. 67message Value { 68  // The kind of value. 69  oneof kind { 70    // Represents a JSON `null`. 71    NullValue null_value = 1; 72 73    // Represents a JSON number. Must not be `NaN`, `Infinity` or 74    // `-Infinity`, since those are not supported in JSON. This also cannot 75    // represent large Int64 values, since JSON format generally does not 76    // support them in its number type. 77    double number_value = 2; 78 79    // Represents a JSON string. 80    string string_value = 3; 81 82    // Represents a JSON boolean (`true` or `false` literal in JSON). 83    bool bool_value = 4; 84 85    // Represents a JSON object. 86    Struct struct_value = 5; 87 88    // Represents a JSON array. 89    ListValue list_value = 6; 90  } 91} 92 93// Represents a JSON `null`. 94// 95// `NullValue` is a sentinel, using an enum with only one value to represent 96// the null value for the `Value` type union. 97// 98// A field of type `NullValue` with any value other than `0` is considered 99// invalid. Most ProtoJSON serializers will emit a Value with a `null_value` set100// as a JSON `null` regardless of the integer value, and so will round trip to101// a `0` value.102enum NullValue {103  // Null value.104  NULL_VALUE = 0;105}106107// Represents a JSON array.108message ListValue {109  // Repeated field of dynamically typed values.110  repeated Value values = 1;111}