Class ProjectsResource.DatabasesResource.DocumentsResource.PatchRequest
Updates or inserts a document.
Inheritance
ProjectsResource.DatabasesResource.DocumentsResource.PatchRequest
Inherited Members
Namespace: Google.Apis.Firestore.v1beta1
Assembly: Google.Apis.Firestore.v1beta1.dll
Syntax
public class ProjectsResource.DatabasesResource.DocumentsResource.PatchRequest : FirestoreBaseServiceRequest<Document>, IClientServiceRequest<Document>, IClientServiceRequest
Constructors
PatchRequest(IClientService, Document, string)
Constructs a new Patch request.
Declaration
public PatchRequest(IClientService service, Document body, string name)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
Document | body | |
string | name |
Properties
CurrentDocumentExists
When set to true
, the target document must exist. When set to false
, the target document
must not exist.
Declaration
[RequestParameter("currentDocument.exists", RequestParameterType.Query)]
public virtual bool? CurrentDocumentExists { get; set; }
Property Value
Type | Description |
---|---|
bool? |
CurrentDocumentUpdateTime
When set, the target document must exist and have been last updated at that time. Timestamp must be microsecond aligned.
Declaration
[RequestParameter("currentDocument.updateTime", RequestParameterType.Query)]
public virtual object CurrentDocumentUpdateTime { get; set; }
Property Value
Type | Description |
---|---|
object |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Firestore.v1beta1.Data.Document>.HttpMethod
MaskFieldPaths
The list of field paths in the mask. See Document.fields for a field path syntax reference.
Declaration
[RequestParameter("mask.fieldPaths", RequestParameterType.Query)]
public virtual Repeatable<string> MaskFieldPaths { get; set; }
Property Value
Type | Description |
---|---|
Repeatable<string> |
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Firestore.v1beta1.Data.Document>.MethodName
Name
The resource name of the document, for example
projects/{project_id}/databases/{database_id}/documents/{document_path}
.
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
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Firestore.v1beta1.Data.Document>.RestPath
UpdateMaskFieldPaths
The list of field paths in the mask. See Document.fields for a field path syntax reference.
Declaration
[RequestParameter("updateMask.fieldPaths", RequestParameterType.Query)]
public virtual Repeatable<string> UpdateMaskFieldPaths { get; set; }
Property Value
Type | Description |
---|---|
Repeatable<string> |
Methods
GetBody()
Returns the body of the request.
Declaration
protected override object GetBody()
Returns
Type | Description |
---|---|
object |
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Firestore.v1beta1.Data.Document>.GetBody()
InitParameters()
Initializes Patch parameter list.
Declaration
protected override void InitParameters()