Class: Google::Protobuf::Value

Inherits:
Object
  • Object
show all
Extended by:
MessageExts::ClassMethods
Includes:
MessageExts
Defined in:
proto_docs/google/protobuf/struct.rb

Overview

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.

Instance Attribute Summary collapse

Instance Attribute Details

#bool_value ⇒ ::Boolean

Returns Represents a boolean value.

Note: The following fields are mutually exclusive: bool_value, null_value, number_value, string_value, struct_value, list_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Boolean) —

    Represents a boolean value.

    Note: The following fields are mutually exclusive: bool_value, null_value, number_value, string_value, struct_value, list_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



83
84
85
86
 
# File 'proto_docs/google/protobuf/struct.rb', line 83

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#list_value ⇒ ::Google::Protobuf::ListValue

Returns Represents a repeated Value.

Note: The following fields are mutually exclusive: list_value, null_value, number_value, string_value, bool_value, struct_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Protobuf::ListValue) —

    Represents a repeated Value.

    Note: The following fields are mutually exclusive: list_value, null_value, number_value, string_value, bool_value, struct_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



83
84
85
86
 
# File 'proto_docs/google/protobuf/struct.rb', line 83

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#null_value ⇒ ::Google::Protobuf::NullValue

Returns Represents a null value.

Note: The following fields are mutually exclusive: null_value, number_value, string_value, bool_value, struct_value, list_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Protobuf::NullValue) —

    Represents a null value.

    Note: The following fields are mutually exclusive: null_value, number_value, string_value, bool_value, struct_value, list_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



83
84
85
86
 
# File 'proto_docs/google/protobuf/struct.rb', line 83

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#number_value ⇒ ::Float

Returns Represents a double value.

Note: The following fields are mutually exclusive: number_value, null_value, string_value, bool_value, struct_value, list_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Float) —

    Represents a double value.

    Note: The following fields are mutually exclusive: number_value, null_value, string_value, bool_value, struct_value, list_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



83
84
85
86
 
# File 'proto_docs/google/protobuf/struct.rb', line 83

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#string_value ⇒ ::String

Returns Represents a string value.

Note: The following fields are mutually exclusive: string_value, null_value, number_value, bool_value, struct_value, list_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    Represents a string value.

    Note: The following fields are mutually exclusive: string_value, null_value, number_value, bool_value, struct_value, list_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



83
84
85
86
 
# File 'proto_docs/google/protobuf/struct.rb', line 83

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#struct_value ⇒ ::Google::Protobuf::Struct

Returns Represents a structured value.

Note: The following fields are mutually exclusive: struct_value, null_value, number_value, string_value, bool_value, list_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Protobuf::Struct) —

    Represents a structured value.

    Note: The following fields are mutually exclusive: struct_value, null_value, number_value, string_value, bool_value, list_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



83
84
85
86
 
# File 'proto_docs/google/protobuf/struct.rb', line 83

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end