Show / Hide Table of Contents

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
IClientServiceRequest<BatchWriteResponse>
IClientServiceRequest
Inherited Members
FirestoreBaseServiceRequest<BatchWriteResponse>.Xgafv
FirestoreBaseServiceRequest<BatchWriteResponse>.AccessToken
FirestoreBaseServiceRequest<BatchWriteResponse>.Alt
FirestoreBaseServiceRequest<BatchWriteResponse>.Callback
FirestoreBaseServiceRequest<BatchWriteResponse>.Fields
FirestoreBaseServiceRequest<BatchWriteResponse>.Key
FirestoreBaseServiceRequest<BatchWriteResponse>.OauthToken
FirestoreBaseServiceRequest<BatchWriteResponse>.PrettyPrint
FirestoreBaseServiceRequest<BatchWriteResponse>.QuotaUser
FirestoreBaseServiceRequest<BatchWriteResponse>.UploadType
FirestoreBaseServiceRequest<BatchWriteResponse>.UploadProtocol
ClientServiceRequest<BatchWriteResponse>.Execute()
ClientServiceRequest<BatchWriteResponse>.ExecuteAsStream()
ClientServiceRequest<BatchWriteResponse>.ExecuteAsync()
ClientServiceRequest<BatchWriteResponse>.ExecuteAsync(CancellationToken)
ClientServiceRequest<BatchWriteResponse>.ExecuteAsStreamAsync()
ClientServiceRequest<BatchWriteResponse>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<BatchWriteResponse>.CreateRequest(bool?)
ClientServiceRequest<BatchWriteResponse>.GenerateRequestUri()
ClientServiceRequest<BatchWriteResponse>.GetDefaultETagAction(string)
ClientServiceRequest<BatchWriteResponse>.ETagAction
ClientServiceRequest<BatchWriteResponse>.ModifyRequest
ClientServiceRequest<BatchWriteResponse>.ValidateParameters
ClientServiceRequest<BatchWriteResponse>.ApiVersion
ClientServiceRequest<BatchWriteResponse>.RequestParameters
ClientServiceRequest<BatchWriteResponse>.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.v1beta1
Assembly: Google.Apis.Firestore.v1beta1.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
ClientServiceRequest<BatchWriteResponse>.HttpMethod

MethodName

Gets the method name.

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

RestPath

Gets the REST path.

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

Methods

GetBody()

Returns the body of the request.

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

InitParameters()

Initializes BatchWrite parameter list.

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

Implements

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