Class: Google::Apis::FirestoreV1::Target

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/firestore_v1/classes.rb,
lib/google/apis/firestore_v1/representations.rb,
lib/google/apis/firestore_v1/representations.rb

Overview

A specification of a set of documents to listen to.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Target

Returns a new instance of Target.



3154
3155
3156
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3154

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

Instance Attribute Details

#documents ⇒ Google::Apis::FirestoreV1::DocumentsTarget

A target specified by a set of documents names. Corresponds to the JSON property documents

Returns:



3114
3115
3116
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3114

def documents
  @documents
end

#expected_count ⇒ Fixnum

The number of documents that last matched the query at the resume token or read time. This value is only relevant when a resume_type is provided. This value being present and greater than zero signals that the client wants ExistenceFilter.unchanged_names to be included in the response. Corresponds to the JSON property expectedCount

Returns:

  • (Fixnum) 


3122
3123
3124
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3122

def expected_count
  @expected_count
end

#once ⇒ Boolean Also known as: once?

If the target should be removed once it is current and consistent. Corresponds to the JSON property once

Returns:

  • (Boolean) 


3127
3128
3129
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3127

def once
  @once
end

#query ⇒ Google::Apis::FirestoreV1::QueryTarget

A target specified by a query. Corresponds to the JSON property query

Returns:



3133
3134
3135
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3133

def query
  @query
end

#read_time ⇒ String

Start listening after a specific read_time. The client must know the state of matching documents at this time. Corresponds to the JSON property readTime

Returns:

  • (String) 


3139
3140
3141
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3139

def read_time
  @read_time
end

#resume_token ⇒ String

A resume token from a prior TargetChange for an identical target. Using a resume token with a different target is unsupported and may fail. Corresponds to the JSON property resumeToken NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


3146
3147
3148
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3146

def resume_token
  @resume_token
end

#target_id ⇒ Fixnum

The target ID that identifies the target on the stream. Must be a positive number and non-zero. Corresponds to the JSON property targetId

Returns:

  • (Fixnum) 


3152
3153
3154
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3152

def target_id
  @target_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3159
3160
3161
3162
3163
3164
3165
3166
3167
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3159

def update!(**args)
  @documents = args[:documents] if args.key?(:documents)
  @expected_count = args[:expected_count] if args.key?(:expected_count)
  @once = args[:once] if args.key?(:once)
  @query = args[:query] if args.key?(:query)
  @read_time = args[:read_time] if args.key?(:read_time)
  @resume_token = args[:resume_token] if args.key?(:resume_token)
  @target_id = args[:target_id] if args.key?(:target_id)
end