IMPORTANT: In July 2025, we stopped releasing new versions of KTX modules, and we removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the previously released KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

CollectionGroupSource

@Beta
public final class CollectionGroupSource extends Stage

java.lang.Object
↳	com.google.firebase.firestore.pipeline.Stage
	↳	com.google.firebase.firestore.pipeline.CollectionGroupSource

Summary

Public fields
`final @NonNull String`	`collectionId`

Public methods
`boolean`	`equals(Object other)`
`int`	`hashCode()`

Inherited methods

From com.google.firebase.firestore.pipeline.Stage

`final @NonNull CollectionGroupSource`	`withOption( @NonNull String key, @NonNull <Error class: unknown class> value )`
`final @NonNull CollectionGroupSource`	`withOption(@NonNull String key, boolean value)` Specify named `Boolean` parameter
`final @NonNull CollectionGroupSource`	`withOption(@NonNull String key, double value)` Specify named `Double` parameter
`final @NonNull CollectionGroupSource`	`withOption(@NonNull String key, @NonNull Field value)` Specify named `Field` parameter
`final @NonNull CollectionGroupSource`	`withOption(@NonNull String key, long value)` Specify named `Long` parameter
`final @NonNull CollectionGroupSource`	`withOption(@NonNull String key, @NonNull String value)` Specify named `String` parameter

Public fields

collectionId

public final @NonNull String collectionId

Public methods

equals

public boolean equals(Object other)

hashCode

public int hashCode()