Class: Google::Apis::FirestoreV1beta1::ExistenceFilter

Inherits:

Object

• Object
• Google::Apis::FirestoreV1beta1::ExistenceFilter

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

generated/google/apis/firestore_v1beta1/classes.rb,
generated/google/apis/firestore_v1beta1/representations.rb,
generated/google/apis/firestore_v1beta1/representations.rb

Overview

A digest of all the documents that match a given target.

Instance Attribute Summary

• #count ⇒ Fixnum

  The total count of documents that match target_id.

• #target_id ⇒ Fixnum

  The target ID to which this filter applies.

Instance Method Summary

• #initialize(**args) ⇒ ExistenceFilter constructor

  A new instance of ExistenceFilter.

• #update!(**args) ⇒ Object

  Update properties of this object.

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ExistenceFilter

Returns a new instance of ExistenceFilter

# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 597

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#count ⇒ Fixnum

The total count of documents that match target_id. If different from the count of documents in the client that match, the client must manually determine which documents no longer match the target. Corresponds to the JSON property count

Returns:

• (Fixnum)

# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 590

def count
  @count
end

#target_id ⇒ Fixnum

The target ID to which this filter applies. Corresponds to the JSON property targetId

Returns:

• (Fixnum)

# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 595

def target_id
  @target_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 602

def update!(**args)
  @count = args[:count] if args.key?(:count)
  @target_id = args[:target_id] if args.key?(:target_id)
end