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

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

Targets being watched have changed.

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

Returns a new instance of TargetChange



2328
2329
2330
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 2328

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. The error model is designed to be:

  • Simple to use and understand for most users
  • Flexible enough to meet unexpected needs # Overview The Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions. # Language mapping The Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include:
  • Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.
  • Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.
  • Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.
  • Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.
  • Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. Corresponds to the JSON property cause

Returns:



2291
2292
2293
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 2291

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) 


2303
2304
2305
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 2303

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) 


2311
2312
2313
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 2311

def resume_token
  @resume_token
end

#target_change_type ⇒ String

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

Returns:

  • (String) 


2316
2317
2318
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 2316

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. For target_change_type=ADD, the order of the target IDs matches the order of the requests to add the targets. This allows clients to unambiguously associate server-assigned target IDs with added targets. For other states, the order of the target IDs is not defined. Corresponds to the JSON property targetIds

Returns:

  • (Array<Fixnum>) 


2326
2327
2328
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 2326

def target_ids
  @target_ids
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2333
2334
2335
2336
2337
2338
2339
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 2333

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