Class: Google::Cloud::Firestore::V1::Function

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/firestore/v1/document.rb

Overview

Represents an unevaluated scalar expression.

For example, the expression like(user_name, "%alice%") is represented as:

name: "like"
args { field_reference: "user_name" }
args { string_value: "%alice%" }

Defined Under Namespace

Classes: OptionsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#args ⇒ ::Array<::Google::Cloud::Firestore::V1::Value>

Returns Optional. Ordered list of arguments the given function expects.

Returns:



255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'proto_docs/google/firestore/v1/document.rb', line 255

class Function
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Firestore::V1::Value]
  class OptionsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns Required. The name of the function to evaluate.

Requires:

  • must be in snake case (lower case with underscore separator).

Returns:

  • (::String) —

    Required. The name of the function to evaluate.

    Requires:

    • must be in snake case (lower case with underscore separator).


255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'proto_docs/google/firestore/v1/document.rb', line 255

class Function
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Firestore::V1::Value]
  class OptionsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#options ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::Firestore::V1::Value}

Returns Optional. Optional named arguments that certain functions may support.

Returns:



255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'proto_docs/google/firestore/v1/document.rb', line 255

class Function
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Firestore::V1::Value]
  class OptionsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end