1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Firestore
  7. \
  8. Resource
  9. \
  10. ProjectsDatabasesCollectionGroupsFields

ProjectsDatabasesCollectionGroupsFields

class ProjectsDatabasesCollectionGroupsFields extends Resource (View source)

The "fields" collection of methods.

Typical usage is:

 $firestoreService = new Google\Service\Firestore(...);
 $fields = $firestoreService->projects_databases_collectionGroups_fields;

Methods

GoogleFirestoreAdminV1Field
get(string $name, array $optParams = [])

Gets the metadata and configuration for a Field. (fields.get)

GoogleFirestoreAdminV1ListFieldsResponse
listProjectsDatabasesCollectionGroupsFields(string $parent, array $optParams = [])

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 or ttlConfig:*. (fields.listProjectsDatabasesCollectionGroupsFields)

GoogleLongrunningOperation
patch(string $name, GoogleFirestoreAdminV1Field $postBody, array $optParams = [])

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__/f ields. (fields.patch)

Details

at line 43
GoogleFirestoreAdminV1Field get(string $name, array $optParams = [])

Gets the metadata and configuration for a Field. (fields.get)

Parameters

string $name

Required. A name of the form projects/{project_id}/datab ases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}
array $optParams

Optional parameters.

Return Value

GoogleFirestoreAdminV1Field

Exceptions

Exception

at line 71
GoogleFirestoreAdminV1ListFieldsResponse listProjectsDatabasesCollectionGroupsFields(string $parent, array $optParams = [])

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 or ttlConfig:*. (fields.listProjectsDatabasesCollectionGroupsFields)

Parameters

string $parent

Required. A parent name of the form projects/{project_ id}/databases/{database_id}/collectionGroups/{collection_id}
array $optParams

Optional parameters.

Return Value

GoogleFirestoreAdminV1ListFieldsResponse

Exceptions

Exception

at line 113
GoogleLongrunningOperation patch(string $name, GoogleFirestoreAdminV1Field $postBody, array $optParams = [])

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__/f ields. (fields.patch)

Parameters

string $name

Required. A field name of the form: projects/{project_id }/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path } A field path can be a simple field name, e.g. address or a path to fields within map_value , e.g. address.city, or a special field path. The only valid special field is *, which represents any field. Field paths can be quoted using ` (backtick). The only character that must be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: *, ., ` (backtick), [, ], as well as any ascii symbolic characters. Examples: `address.city` represents a field named address.city, not the map key city in the field address. `*` represents a field named *, not any field. A special Field contains the default indexing settings for all fields. This field's resource name is: pro jects/{project_id}/databases/{database_id}/collectionGroups/__default__/field s Indexes defined on this Field will be applied to all fields which do not have their own Field index configuration.
GoogleFirestoreAdminV1Field $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception