Class: Google::Apis::FirestoreV1::WriteResponse

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

The response for Firestore.Write.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ WriteResponse

Returns a new instance of WriteResponse.



3713
3714
3715
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3713

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

Instance Attribute Details

#commit_time ⇒ String

The time at which the commit occurred. Any read with an equal or greater read_time is guaranteed to see the effects of the write. Corresponds to the JSON property commitTime

Returns:

  • (String) 


3691
3692
3693
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3691

def commit_time
  @commit_time
end

#stream_id ⇒ String

The ID of the stream. Only set on the first message, when a new stream was created. Corresponds to the JSON property streamId

Returns:

  • (String) 


3697
3698
3699
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3697

def stream_id
  @stream_id
end

#stream_token ⇒ String

A token that represents the position of this response in the stream. This can be used by a client to resume the stream at this point. This field is always set. Corresponds to the JSON property streamToken NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


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

def stream_token
  @stream_token
end

#write_results ⇒ Array<Google::Apis::FirestoreV1::WriteResult>

The result of applying the writes. This i-th write result corresponds to the i- th write in the request. Corresponds to the JSON property writeResults

Returns:



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

def write_results
  @write_results
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3718
3719
3720
3721
3722
3723
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3718

def update!(**args)
  @commit_time = args[:commit_time] if args.key?(:commit_time)
  @stream_id = args[:stream_id] if args.key?(:stream_id)
  @stream_token = args[:stream_token] if args.key?(:stream_token)
  @write_results = args[:write_results] if args.key?(:write_results)
end