struct.proto 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  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. syntax = "proto3";
  31. package google.protobuf;
  32. option csharp_namespace = "Google.Protobuf.WellKnownTypes";
  33. option cc_enable_arenas = true;
  34. option go_package = "github.com/golang/protobuf/ptypes/struct;structpb";
  35. option java_package = "com.google.protobuf";
  36. option java_outer_classname = "StructProto";
  37. option java_multiple_files = true;
  38. option objc_class_prefix = "GPB";
  39. // `Struct` represents a structured data value, consisting of fields
  40. // which map to dynamically typed values. In some languages, `Struct`
  41. // might be supported by a native representation. For example, in
  42. // scripting languages like JS a struct is represented as an
  43. // object. The details of that representation are described together
  44. // with the proto support for the language.
  45. //
  46. // The JSON representation for `Struct` is JSON object.
  47. message Struct {
  48. // Unordered map of dynamically typed values.
  49. map<string, Value> fields = 1;
  50. }
  51. // `Value` represents a dynamically typed value which can be either
  52. // null, a number, a string, a boolean, a recursive struct value, or a
  53. // list of values. A producer of value is expected to set one of that
  54. // variants, absence of any variant indicates an error.
  55. //
  56. // The JSON representation for `Value` is JSON value.
  57. message Value {
  58. // The kind of value.
  59. oneof kind {
  60. // Represents a null value.
  61. NullValue null_value = 1;
  62. // Represents a double value.
  63. double number_value = 2;
  64. // Represents a string value.
  65. string string_value = 3;
  66. // Represents a boolean value.
  67. bool bool_value = 4;
  68. // Represents a structured value.
  69. Struct struct_value = 5;
  70. // Represents a repeated `Value`.
  71. ListValue list_value = 6;
  72. }
  73. }
  74. // `NullValue` is a singleton enumeration to represent the null value for the
  75. // `Value` type union.
  76. //
  77. // The JSON representation for `NullValue` is JSON `null`.
  78. enum NullValue {
  79. // Null value.
  80. NULL_VALUE = 0;
  81. }
  82. // `ListValue` is a wrapper around a repeated field of values.
  83. //
  84. // The JSON representation for `ListValue` is JSON array.
  85. message ListValue {
  86. // Repeated field of dynamically typed values.
  87. repeated Value values = 1;
  88. }