Class: Google::Apis::FirestoreV1::BatchWriteRequest

Inherits:

Object

• Object
• Google::Apis::FirestoreV1::BatchWriteRequest

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 request for Firestore.BatchWrite.

Instance Attribute Summary

• #labels ⇒ Hash<String,String>

  Labels associated with this batch write.

• #writes ⇒ Array<Google::Apis::FirestoreV1::Write>

  The writes to apply.

Instance Method Summary

• #initialize(**args) ⇒ BatchWriteRequest constructor

  A new instance of BatchWriteRequest.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ BatchWriteRequest

Returns a new instance of BatchWriteRequest.

# File 'lib/google/apis/firestore_v1/classes.rb', line 210

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

Instance Attribute Details

#labels ⇒ Hash<String,String>

Labels associated with this batch write. Corresponds to the JSON property labels

Returns:

• (Hash<String,String>)

# File 'lib/google/apis/firestore_v1/classes.rb', line 201

def labels
  @labels
end

#writes ⇒ Array<Google::Apis::FirestoreV1::Write>

The writes to apply. Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request. Corresponds to the JSON property writes

Returns:

• (Array<Google::Apis::FirestoreV1::Write>)

# File 'lib/google/apis/firestore_v1/classes.rb', line 208

def writes
  @writes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/firestore_v1/classes.rb', line 215

def update!(**args)
  @labels = args[:labels] if args.key?(:labels)
  @writes = args[:writes] if args.key?(:writes)
end