Class ProjectsResource.DatabasesResource.DocumentsResource.BatchWriteRequest

Applies a batch of write operations. The BatchWrite method does not apply the write operations atomically and can apply them out of order. Method does not allow more than one write per document. Each write succeeds or fails independently. See the BatchWriteResponse for the success status of each write. If you require an atomically applied set of writes, use Commit instead.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<BatchWriteResponse>
FirestoreBaseServiceRequest<BatchWriteResponse>
ProjectsResource.DatabasesResource.DocumentsResource.BatchWriteRequest
Implements
Inherited Members
Namespace: Google.Apis.Firestore.v1
Assembly: Google.Apis.Firestore.v1.dll
Syntax
public class ProjectsResource.DatabasesResource.DocumentsResource.BatchWriteRequest : FirestoreBaseServiceRequest<BatchWriteResponse>, IClientServiceRequest<BatchWriteResponse>, IClientServiceRequest

Constructors

BatchWriteRequest(IClientService, BatchWriteRequest, string)

Constructs a new BatchWrite request.

Declaration
public BatchWriteRequest(IClientService service, BatchWriteRequest body, string database)
Parameters
Type Name Description
IClientService service
BatchWriteRequest body
string database

Properties

Database

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

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

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
object
Overrides

InitParameters()

Initializes BatchWrite parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements