Show / Hide Table of Contents

Class ProjectsResource.DatabasesResource.DocumentsResource.BatchGetRequest

Gets multiple documents. Documents returned by this method are not guaranteed to be returned in the same order that they were requested.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<BatchGetDocumentsResponse>
FirestoreBaseServiceRequest<BatchGetDocumentsResponse>
ProjectsResource.DatabasesResource.DocumentsResource.BatchGetRequest
Implements
IClientServiceRequest<BatchGetDocumentsResponse>
IClientServiceRequest
Inherited Members
FirestoreBaseServiceRequest<BatchGetDocumentsResponse>.Xgafv
FirestoreBaseServiceRequest<BatchGetDocumentsResponse>.AccessToken
FirestoreBaseServiceRequest<BatchGetDocumentsResponse>.Alt
FirestoreBaseServiceRequest<BatchGetDocumentsResponse>.Callback
FirestoreBaseServiceRequest<BatchGetDocumentsResponse>.Fields
FirestoreBaseServiceRequest<BatchGetDocumentsResponse>.Key
FirestoreBaseServiceRequest<BatchGetDocumentsResponse>.OauthToken
FirestoreBaseServiceRequest<BatchGetDocumentsResponse>.PrettyPrint
FirestoreBaseServiceRequest<BatchGetDocumentsResponse>.QuotaUser
FirestoreBaseServiceRequest<BatchGetDocumentsResponse>.UploadType
FirestoreBaseServiceRequest<BatchGetDocumentsResponse>.UploadProtocol
ClientServiceRequest<BatchGetDocumentsResponse>.Execute()
ClientServiceRequest<BatchGetDocumentsResponse>.ExecuteAsStream()
ClientServiceRequest<BatchGetDocumentsResponse>.ExecuteAsync()
ClientServiceRequest<BatchGetDocumentsResponse>.ExecuteAsync(CancellationToken)
ClientServiceRequest<BatchGetDocumentsResponse>.ExecuteAsStreamAsync()
ClientServiceRequest<BatchGetDocumentsResponse>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<BatchGetDocumentsResponse>.CreateRequest(bool?)
ClientServiceRequest<BatchGetDocumentsResponse>.GenerateRequestUri()
ClientServiceRequest<BatchGetDocumentsResponse>.GetDefaultETagAction(string)
ClientServiceRequest<BatchGetDocumentsResponse>.ETagAction
ClientServiceRequest<BatchGetDocumentsResponse>.ModifyRequest
ClientServiceRequest<BatchGetDocumentsResponse>.ValidateParameters
ClientServiceRequest<BatchGetDocumentsResponse>.ApiVersion
ClientServiceRequest<BatchGetDocumentsResponse>.RequestParameters
ClientServiceRequest<BatchGetDocumentsResponse>.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.DocumentsResource.BatchGetRequest : FirestoreBaseServiceRequest<BatchGetDocumentsResponse>, IClientServiceRequest<BatchGetDocumentsResponse>, IClientServiceRequest

Constructors

BatchGetRequest(IClientService, BatchGetDocumentsRequest, string)

Constructs a new BatchGet request.

Declaration
public BatchGetRequest(IClientService service, BatchGetDocumentsRequest body, string database)
Parameters
Type Name Description
IClientService service
BatchGetDocumentsRequest 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<BatchGetDocumentsResponse>.HttpMethod

MethodName

Gets the method name.

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

RestPath

Gets the REST path.

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

Methods

GetBody()

Returns the body of the request.

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

InitParameters()

Initializes BatchGet parameter list.

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

Implements

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