Show / Hide Table of Contents

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
object
ClientServiceRequest
ClientServiceRequest<GoogleLongrunningOperation>
FirestoreBaseServiceRequest<GoogleLongrunningOperation>
ProjectsResource.DatabasesResource.CollectionGroupsResource.FieldsResource.PatchRequest
Implements
IClientServiceRequest<GoogleLongrunningOperation>
IClientServiceRequest
Inherited Members
FirestoreBaseServiceRequest<GoogleLongrunningOperation>.Xgafv
FirestoreBaseServiceRequest<GoogleLongrunningOperation>.AccessToken
FirestoreBaseServiceRequest<GoogleLongrunningOperation>.Alt
FirestoreBaseServiceRequest<GoogleLongrunningOperation>.Callback
FirestoreBaseServiceRequest<GoogleLongrunningOperation>.Fields
FirestoreBaseServiceRequest<GoogleLongrunningOperation>.Key
FirestoreBaseServiceRequest<GoogleLongrunningOperation>.OauthToken
FirestoreBaseServiceRequest<GoogleLongrunningOperation>.PrettyPrint
FirestoreBaseServiceRequest<GoogleLongrunningOperation>.QuotaUser
FirestoreBaseServiceRequest<GoogleLongrunningOperation>.UploadType
FirestoreBaseServiceRequest<GoogleLongrunningOperation>.UploadProtocol
ClientServiceRequest<GoogleLongrunningOperation>.Execute()
ClientServiceRequest<GoogleLongrunningOperation>.ExecuteAsStream()
ClientServiceRequest<GoogleLongrunningOperation>.ExecuteAsync()
ClientServiceRequest<GoogleLongrunningOperation>.ExecuteAsync(CancellationToken)
ClientServiceRequest<GoogleLongrunningOperation>.ExecuteAsStreamAsync()
ClientServiceRequest<GoogleLongrunningOperation>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<GoogleLongrunningOperation>.CreateRequest(bool?)
ClientServiceRequest<GoogleLongrunningOperation>.GenerateRequestUri()
ClientServiceRequest<GoogleLongrunningOperation>.GetDefaultETagAction(string)
ClientServiceRequest<GoogleLongrunningOperation>.ETagAction
ClientServiceRequest<GoogleLongrunningOperation>.ModifyRequest
ClientServiceRequest<GoogleLongrunningOperation>.ValidateParameters
ClientServiceRequest<GoogleLongrunningOperation>.ApiVersion
ClientServiceRequest<GoogleLongrunningOperation>.RequestParameters
ClientServiceRequest<GoogleLongrunningOperation>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Firestore.v1
Assembly: Google.Apis.Firestore.v1.dll
Syntax
public class ProjectsResource.DatabasesResource.CollectionGroupsResource.FieldsResource.PatchRequest : FirestoreBaseServiceRequest<GoogleLongrunningOperation>, IClientServiceRequest<GoogleLongrunningOperation>, IClientServiceRequest

Constructors

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
string name

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<GoogleLongrunningOperation>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<GoogleLongrunningOperation>.MethodName

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: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* Indexes defined on this Field will be applied to all fields which do not have their own Field index configuration.

Declaration
[RequestParameter("name", RequestParameterType.Path)]
public virtual string Name { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<GoogleLongrunningOperation>.RestPath

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
object

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
object
Overrides
ClientServiceRequest<GoogleLongrunningOperation>.GetBody()

InitParameters()

Initializes Patch parameter list.

Declaration
protected override void InitParameters()
Overrides
FirestoreBaseServiceRequest<GoogleLongrunningOperation>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In this article
Back to top Generated by DocFX