ProjectsDatabasesCollectionGroupsFieldsResourceApi class

Constructors

ProjectsDatabasesCollectionGroupsFieldsResourceApi(ApiRequester client)

Properties

hashCode → int
The hash code for this object. [...]
read-only, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

Methods

get(String name, {String $fields}) → Future<GoogleFirestoreAdminV1Field>
Gets the metadata and configuration for a Field. [...]
list(String parent, {String filter, int pageSize, String pageToken, String $fields}) → Future<GoogleFirestoreAdminV1ListFieldsResponse>
Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to indexConfig.usesAncestorConfig:false. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
patch(GoogleFirestoreAdminV1Field request, String name, {String updateMask, String $fields}) → Future<GoogleLongrunningOperation>
Updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to FirestoreAdmin.UpdateField should provide a field mask to avoid changing any configuration that the caller isn't aware of. The field mask should be specified as: { paths: "index_config" }. This call returns a google.longrunning.Operation which may be used to track the status of the field update. The metadata for the operation will be the type FieldOperationMetadata. To configure the default field settings for the database, use the special Field with resource name: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields / *. [...]
toString() → String
Returns a string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator. [...]
inherited