Class ProjectsResource.DatabasesResource.CollectionGroupsResource.FieldsResource.PatchRequest
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/*.
Inheritance
Inherited Members
Namespace: Google.Apis.Firestore.v1
Assembly: Google.Apis.Firestore.v1.dll
Syntax
public class PatchRequest : FirestoreBaseServiceRequest<GoogleLongrunningOperation>, IClientServiceRequest<GoogleLongrunningOperation>, IClientServiceRequestConstructors
PatchRequest(IClientService, GoogleFirestoreAdminV1Field, String)
Constructs a new Patch request.
Declaration
public PatchRequest(IClientService service, GoogleFirestoreAdminV1Field body, string name)Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service | |
| GoogleFirestoreAdminV1Field | body | |
| System.String | name |
Properties
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
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.
Declaration
[RequestParameter("name", RequestParameterType.Path)]
public virtual string Name { get; }Property Value
| Type | Description |
|---|---|
| System.String |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
UpdateMask
A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field.
Declaration
[RequestParameter("updateMask", RequestParameterType.Query)]
public virtual object UpdateMask { get; set; }Property Value
| Type | Description |
|---|---|
| System.Object |
Methods
GetBody()
Returns the body of the request.
Declaration
protected override object GetBody()Returns
| Type | Description |
|---|---|
| System.Object |
Overrides
InitParameters()
Initializes Patch parameter list.
Declaration
protected override void InitParameters()