google/protobuf/struct.proto

0001 // Protocol Buffers - Google's data interchange format
0002 // Copyright 2008 Google Inc.  All rights reserved.
0003 // https://developers.google.com/protocol-buffers/
0004 //
0005 // Redistribution and use in source and binary forms, with or without
0006 // modification, are permitted provided that the following conditions are
0007 // met:
0008 //
0009 //     * Redistributions of source code must retain the above copyright
0010 // notice, this list of conditions and the following disclaimer.
0011 //     * Redistributions in binary form must reproduce the above
0012 // copyright notice, this list of conditions and the following disclaimer
0013 // in the documentation and/or other materials provided with the
0014 // distribution.
0015 //     * Neither the name of Google Inc. nor the names of its
0016 // contributors may be used to endorse or promote products derived from
0017 // this software without specific prior written permission.
0018 //
0019 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0020 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0021 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0022 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0023 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0024 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0025 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0026 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0027 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0028 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0029 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0030
0031 syntax = "proto3";
0032
0033 package google.protobuf;
0034
0035 option cc_enable_arenas = true;
0036 option go_package = "google.golang.org/protobuf/types/known/structpb";
0037 option java_package = "com.google.protobuf";
0038 option java_outer_classname = "StructProto";
0039 option java_multiple_files = true;
0040 option objc_class_prefix = "GPB";
0041 option csharp_namespace = "Google.Protobuf.WellKnownTypes";
0042
0043 // `Struct` represents a structured data value, consisting of fields
0044 // which map to dynamically typed values. In some languages, `Struct`
0045 // might be supported by a native representation. For example, in
0046 // scripting languages like JS a struct is represented as an
0047 // object. The details of that representation are described together
0048 // with the proto support for the language.
0049 //
0050 // The JSON representation for `Struct` is JSON object.
0051 message Struct {
0052   // Unordered map of dynamically typed values.
0053   map<string, Value> fields = 1;
0054 }
0055
0056 // `Value` represents a dynamically typed value which can be either
0057 // null, a number, a string, a boolean, a recursive struct value, or a
0058 // list of values. A producer of value is expected to set one of these
0059 // variants. Absence of any variant indicates an error.
0060 //
0061 // The JSON representation for `Value` is JSON value.
0062 message Value {
0063   // The kind of value.
0064   oneof kind {
0065     // Represents a null value.
0066     NullValue null_value = 1;
0067     // Represents a double value.
0068     double number_value = 2;
0069     // Represents a string value.
0070     string string_value = 3;
0071     // Represents a boolean value.
0072     bool bool_value = 4;
0073     // Represents a structured value.
0074     Struct struct_value = 5;
0075     // Represents a repeated `Value`.
0076     ListValue list_value = 6;
0077   }
0078 }
0079
0080 // `NullValue` is a singleton enumeration to represent the null value for the
0081 // `Value` type union.
0082 //
0083 // The JSON representation for `NullValue` is JSON `null`.
0084 enum NullValue {
0085   // Null value.
0086   NULL_VALUE = 0;
0087 }
0088
0089 // `ListValue` is a wrapper around a repeated field of values.
0090 //
0091 // The JSON representation for `ListValue` is JSON array.
0092 message ListValue {
0093   // Repeated field of dynamically typed values.
0094   repeated Value values = 1;
0095 }