// Copyright 2018 Google LLC.

//

// Redistribution and use in source and binary forms, with or without

// modification, are permitted provided that the following conditions

// are met:

//

// 1. Redistributions of source code must retain the above copyright notice,

//    this list of conditions and the following disclaimer.

//

// 2. Redistributions in binary form must reproduce the above copyright

//    notice, this list of conditions and the following disclaimer in the

//    documentation and/or other materials provided with the distribution.

//

// 3. Neither the name of the copyright holder nor the names of its

//    contributors may be used to endorse or promote products derived from this

//    software without specific prior written permission.

//

// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"

// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE

// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR

// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN

// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

// POSSIBILITY OF SUCH DAMAGE.

syntax = "proto3";

package nucleus.genomics.v1;

// `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.

message Struct {

  // Unordered map of dynamically typed values.

  map<string, Value> fields = 1;

}

// `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.

message Value {

  // The kind of value.

  oneof kind {

    // Represents a null value.

    NullValue null_value = 1;

    // Represents a double value.

    double number_value = 2;

    // Represents an integer value.

    int32 int_value = 7;

    // Represents a string value.

    string string_value = 3;

    // Represents a boolean value.

    bool bool_value = 4;

    // Represents a structured value.

    Struct struct_value = 5;

    // Represents a repeated `Value`.

    ListValue list_value = 6;

  }

}

// `NullValue` is a singleton enumeration to represent the null value for the

// `Value` type union.

//

//  The JSON representation for `NullValue` is JSON `null`.

enum NullValue {

  // Null value.

  NULL_VALUE = 0;

}

// `ListValue` is a wrapper around a repeated field of values.

//

// The JSON representation for `ListValue` is JSON array.

message ListValue {

  // Repeated field of dynamically typed values.

  repeated Value values = 1;

}