Class: Google::Apis::FirestoreV1beta1::TargetChange

Inherits:
Object
  • Object
show all
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

Targets being watched have changed.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ TargetChange

Returns a new instance of TargetChange.



1968
1969
1970
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1968

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

Instance Attribute Details

#cause ⇒ Google::Apis::FirestoreV1beta1::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:



1937
1938
1939
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1937

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) 


1948
1949
1950
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1948

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) 


1955
1956
1957
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1955

def resume_token
  @resume_token
end

#target_change_type ⇒ String

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

Returns:

  • (String) 


1960
1961
1962
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1960

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>) 


1966
1967
1968
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1966

def target_ids
  @target_ids
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1973
1974
1975
1976
1977
1978
1979
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1973

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