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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/firestore_v1/classes.rb,
generated/google/apis/firestore_v1/representations.rb,
generated/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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Target

Returns a new instance of Target



2231
2232
2233
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 2231

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:



2195
2196
2197
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 2195

def documents
  @documents
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) 


2200
2201
2202
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 2200

def once
  @once
end

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

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

Returns:



2206
2207
2208
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 2206

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) 


2212
2213
2214
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 2212

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) 


2219
2220
2221
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 2219

def resume_token
  @resume_token
end

#target_id ⇒ Fixnum

A client provided target ID. If not set, the server will assign an ID for the target. Used for resuming a target without changing IDs. The IDs can either be client-assigned or be server-assigned in a previous stream. All targets with client provided IDs must be added before adding a target that needs a server-assigned id. Corresponds to the JSON property targetId

Returns:

  • (Fixnum) 


2229
2230
2231
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 2229

def target_id
  @target_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2236
2237
2238
2239
2240
2241
2242
2243
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 2236

def update!(**args)
  @documents = args[:documents] if args.key?(:documents)
  @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