firestore  v1
Public Member Functions | Protected Member Functions | Properties | List of all members
Google.Apis.Firestore.v1.ProjectsResource.DatabasesResource.DocumentsResource.PatchRequest Class Reference

Updates or inserts a document. More...

Inheritance diagram for Google.Apis.Firestore.v1.ProjectsResource.DatabasesResource.DocumentsResource.PatchRequest:
Google.Apis.Firestore.v1.FirestoreBaseServiceRequest< Google.Apis.Firestore.v1.Data.Document >

Public Member Functions

 PatchRequest (Google.Apis.Services.IClientService service, Google.Apis.Firestore.v1.Data.Document body, string name)
 Constructs a new Patch request. More...
 

Protected Member Functions

override object GetBody ()
 summary>Gets the method name. More...
 
override void InitParameters ()
 Initializes Patch parameter list. More...
 
- Protected Member Functions inherited from Google.Apis.Firestore.v1.FirestoreBaseServiceRequest< Google.Apis.Firestore.v1.Data.Document >
 FirestoreBaseServiceRequest (Google.Apis.Services.IClientService service)
 Constructs a new FirestoreBaseServiceRequest instance. More...
 
override void InitParameters ()
 Initializes Firestore parameter list. More...
 

Properties

virtual string Name [get]
 The resource name of the document, for example projects/{project_id}/databases/{database_id}/documents/{document_path}. More...
 
virtual Google.Apis.Util.Repeatable< string > UpdateMaskFieldPaths [get, set]
 The list of field paths in the mask. See Document.fields for a field path syntax reference. More...
 
virtual Google.Apis.Util.Repeatable< string > MaskFieldPaths [get, set]
 The list of field paths in the mask. See Document.fields for a field path syntax reference. More...
 
virtual object CurrentDocumentUpdateTime [get, set]
 When set, the target document must exist and have been last updated at that time. More...
 
virtual System.Nullable< bool > CurrentDocumentExists [get, set]
 When set to true, the target document must exist. When set to false, the target document must not exist. More...
 
override string MethodName [get]
 summary>Gets the HTTP method. More...
 
override string HttpMethod [get]
 summary>Gets the REST path. More...
 
override string RestPath [get]
 
- Properties inherited from Google.Apis.Firestore.v1.FirestoreBaseServiceRequest< Google.Apis.Firestore.v1.Data.Document >
virtual System.Nullable< XgafvEnum > Xgafv [get, set]
 V1 error format. More...
 
virtual string AccessToken [get, set]
 OAuth access token. More...
 
virtual System.Nullable< AltEnum > Alt [get, set]
 Data format for response. More...
 
virtual string Callback [get, set]
 JSONP More...
 
virtual string Fields [get, set]
 Selector specifying which fields to include in a partial response. More...
 
virtual string Key [get, set]
 API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. More...
 
virtual string OauthToken [get, set]
 OAuth 2.0 token for the current user. More...
 
virtual System.Nullable< bool > PrettyPrint [get, set]
 Returns response with indentations and line breaks. More...
 
virtual string QuotaUser [get, set]
 Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. More...
 
virtual string UploadType [get, set]
 Legacy upload protocol for media (e.g. "media", "multipart"). More...
 
virtual string UploadProtocol [get, set]
 Upload protocol for media (e.g. "raw", "multipart"). More...
 

Detailed Description

Updates or inserts a document.

Constructor & Destructor Documentation

◆ PatchRequest()

Google.Apis.Firestore.v1.ProjectsResource.DatabasesResource.DocumentsResource.PatchRequest.PatchRequest ( Google.Apis.Services.IClientService  service,
Google.Apis.Firestore.v1.Data.Document  body,
string  name 
)
inline

Constructs a new Patch request.

Member Function Documentation

◆ GetBody()

override object Google.Apis.Firestore.v1.ProjectsResource.DatabasesResource.DocumentsResource.PatchRequest.GetBody ( )
inlineprotected

summary>Gets the method name.

◆ InitParameters()

override void Google.Apis.Firestore.v1.ProjectsResource.DatabasesResource.DocumentsResource.PatchRequest.InitParameters ( )
inlineprotected

Initializes Patch parameter list.

Property Documentation

◆ CurrentDocumentExists

virtual System.Nullable<bool> Google.Apis.Firestore.v1.ProjectsResource.DatabasesResource.DocumentsResource.PatchRequest.CurrentDocumentExists
getset

When set to true, the target document must exist. When set to false, the target document must not exist.

◆ CurrentDocumentUpdateTime

virtual object Google.Apis.Firestore.v1.ProjectsResource.DatabasesResource.DocumentsResource.PatchRequest.CurrentDocumentUpdateTime
getset

When set, the target document must exist and have been last updated at that time.

◆ HttpMethod

override string Google.Apis.Firestore.v1.ProjectsResource.DatabasesResource.DocumentsResource.PatchRequest.HttpMethod
get

summary>Gets the REST path.

◆ MaskFieldPaths

virtual Google.Apis.Util.Repeatable<string> Google.Apis.Firestore.v1.ProjectsResource.DatabasesResource.DocumentsResource.PatchRequest.MaskFieldPaths
getset

The list of field paths in the mask. See Document.fields for a field path syntax reference.

◆ MethodName

override string Google.Apis.Firestore.v1.ProjectsResource.DatabasesResource.DocumentsResource.PatchRequest.MethodName
get

summary>Gets the HTTP method.

◆ Name

virtual string Google.Apis.Firestore.v1.ProjectsResource.DatabasesResource.DocumentsResource.PatchRequest.Name
get

The resource name of the document, for example projects/{project_id}/databases/{database_id}/documents/{document_path}.

◆ UpdateMaskFieldPaths

virtual Google.Apis.Util.Repeatable<string> Google.Apis.Firestore.v1.ProjectsResource.DatabasesResource.DocumentsResource.PatchRequest.UpdateMaskFieldPaths
getset

The list of field paths in the mask. See Document.fields for a field path syntax reference.


The documentation for this class was generated from the following file: