Class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BulkDeleteDocumentsRequest

Inherits:

Object

• Object
• Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BulkDeleteDocumentsRequest

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 FirestoreAdmin.BulkDeleteDocuments. When both collection_ids and namespace_ids are set, only documents satisfying both conditions will be deleted. Requests with namespace_ids and collection_ids both empty will be rejected. Please use FirestoreAdmin.DeleteDatabase instead.

Instance Attribute Summary

• #collection_ids ⇒ Array<String>

  Optional.

• #namespace_ids ⇒ Array<String>

  Optional.

Instance Method Summary

• #initialize(**args) ⇒ GoogleFirestoreAdminV1BulkDeleteDocumentsRequest constructor

  A new instance of GoogleFirestoreAdminV1BulkDeleteDocumentsRequest.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1BulkDeleteDocumentsRequest

Returns a new instance of GoogleFirestoreAdminV1BulkDeleteDocumentsRequest.

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

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

Instance Attribute Details

#collection_ids ⇒ Array<String>

Optional. IDs of the collection groups to delete. Unspecified means all collection groups. Each collection group in this list must be unique. Corresponds to the JSON property collectionIds

Returns:

• (Array<String>)

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

def collection_ids
  @collection_ids
end

#namespace_ids ⇒ Array<String>

Optional. Namespaces to delete. An empty list means all namespaces. This is the recommended usage for databases that don't use namespaces. An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to delete from them. Each namespace in this list must be unique. Corresponds to the JSON property namespaceIds

Returns:

• (Array<String>)

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

def namespace_ids
  @namespace_ids
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

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

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