Class ProjectsResource.DatabasesResource.CollectionGroupsResource.FieldsResource

The "fields" collection of methods.

Inheritance

System.Object

ProjectsResource.DatabasesResource.CollectionGroupsResource.FieldsResource

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Google.Apis.Firestore.v1

Assembly: Google.Apis.Firestore.v1.dll

Syntax

public class FieldsResource

Constructors

FieldsResource(IClientService)

Constructs a new resource.

Declaration

public FieldsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Get(String)

Gets the metadata and configuration for a Field.

Declaration

public virtual ProjectsResource.DatabasesResource.CollectionGroupsResource.FieldsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
System.String	name	Required. A name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

Returns

Type	Description
ProjectsResource.DatabasesResource.CollectionGroupsResource.FieldsResource.GetRequest

List(String)

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 .

Declaration

public virtual ProjectsResource.DatabasesResource.CollectionGroupsResource.FieldsResource.ListRequest List(string parent)

Parameters

Type	Name	Description
System.String	parent	Required. A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

Returns

Type	Description
ProjectsResource.DatabasesResource.CollectionGroupsResource.FieldsResource.ListRequest

Patch(GoogleFirestoreAdminV1Field, String)

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/*.

Declaration

public virtual ProjectsResource.DatabasesResource.CollectionGroupsResource.FieldsResource.PatchRequest Patch(GoogleFirestoreAdminV1Field body, string name)

Parameters

Type	Name	Description
GoogleFirestoreAdminV1Field	body	The body of the request.
System.String	name	Required. A field name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path} A field path may 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 may be quoted using (backtick). The only character that needs to 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: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block)`address.city`represents a field namedaddress.city, not the map keycityin the fieldaddress.``represents a field named, not any field. A specialFieldcontains the default indexing settings for all fields. This field's resource name is:projects/{project_id}/databases/{database_id}/collectionGroups/default/fields/Indexes defined on thisFieldwill be applied to all fields which do not have their ownField` index configuration.

Returns

Type	Description
ProjectsResource.DatabasesResource.CollectionGroupsResource.FieldsResource.PatchRequest