Class: Google::Apis::FirestoreV1::TargetChange

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

Targets being watched have changed.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ TargetChange

Returns a new instance of TargetChange.



3724
3725
3726
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3724

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

Instance Attribute Details

#cause ⇒ Google::Apis::FirestoreV1::Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. Corresponds to the JSON property cause

Returns:



3693
3694
3695
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3693

def cause
  @cause
end

#read_time ⇒ String

The consistent read_time for the given target_ids (omitted when the target_ids are not at a consistent snapshot). The stream is guaranteed to send a read_time with target_ids empty whenever the entire stream reaches a new consistent snapshot. ADD, CURRENT, and RESET messages are guaranteed to ( eventually) result in a new consistent snapshot (while NO_CHANGE and REMOVE messages are not). For a given stream, read_time is guaranteed to be monotonically increasing. Corresponds to the JSON property readTime

Returns:

  • (String) 


3704
3705
3706
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3704

def read_time
  @read_time
end

#resume_token ⇒ String

A token that can be used to resume the stream for the given target_ids, or all targets if target_ids is empty. Not set on every target change. Corresponds to the JSON property resumeToken NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


3711
3712
3713
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3711

def resume_token
  @resume_token
end

#target_change_type ⇒ String

The type of change that occurred. Corresponds to the JSON property targetChangeType

Returns:

  • (String) 


3716
3717
3718
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3716

def target_change_type
  @target_change_type
end

#target_ids ⇒ Array<Fixnum>

The target IDs of targets that have changed. If empty, the change applies to all targets. The order of the target IDs is not defined. Corresponds to the JSON property targetIds

Returns:

  • (Array<Fixnum>) 


3722
3723
3724
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3722

def target_ids
  @target_ids
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3729
3730
3731
3732
3733
3734
3735
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3729

def update!(**args)
  @cause = args[:cause] if args.key?(:cause)
  @read_time = args[:read_time] if args.key?(:read_time)
  @resume_token = args[:resume_token] if args.key?(:resume_token)
  @target_change_type = args[:target_change_type] if args.key?(:target_change_type)
  @target_ids = args[:target_ids] if args.key?(:target_ids)
end