Class: Google::Apis::FirestoreV1beta1::Target
- Inherits:
-
Object
- Object
- Google::Apis::FirestoreV1beta1::Target
- 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 specification of a set of documents to listen to.
Instance Attribute Summary collapse
-
#documents ⇒ Google::Apis::FirestoreV1beta1::DocumentsTarget
A target specified by a set of documents names.
-
#once ⇒ Boolean
(also: #once?)
If the target should be removed once it is current and consistent.
-
#query ⇒ Google::Apis::FirestoreV1beta1::QueryTarget
A target specified by a query.
-
#read_time ⇒ String
Start listening after a specific
read_time
. -
#resume_token ⇒ String
A resume token from a prior TargetChange for an identical target.
-
#target_id ⇒ Fixnum
A client provided target ID.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Target
constructor
A new instance of Target.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Target
Returns a new instance of Target
1884 1885 1886 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1884 def initialize(**args) update!(**args) end |
Instance Attribute Details
#documents ⇒ Google::Apis::FirestoreV1beta1::DocumentsTarget
A target specified by a set of documents names.
Corresponds to the JSON property documents
1848 1849 1850 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1848 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
1853 1854 1855 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1853 def once @once end |
#query ⇒ Google::Apis::FirestoreV1beta1::QueryTarget
A target specified by a query.
Corresponds to the JSON property query
1859 1860 1861 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1859 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
1865 1866 1867 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1865 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.
1872 1873 1874 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1872 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
1882 1883 1884 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1882 def target_id @target_id end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1889 1890 1891 1892 1893 1894 1895 1896 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1889 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 |