Class ProjectsResource.DatabasesResource.ExportDocumentsRequest

Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<GoogleLongrunningOperation>
FirestoreBaseServiceRequest<GoogleLongrunningOperation>
ProjectsResource.DatabasesResource.ExportDocumentsRequest
Implements
Inherited Members
Namespace: Google.Apis.Firestore.v1beta2
Assembly: Google.Apis.Firestore.v1beta2.dll
Syntax
public class ProjectsResource.DatabasesResource.ExportDocumentsRequest : FirestoreBaseServiceRequest<GoogleLongrunningOperation>, IClientServiceRequest<GoogleLongrunningOperation>, IClientServiceRequest

Constructors

ExportDocumentsRequest(IClientService, GoogleFirestoreAdminV1beta2ExportDocumentsRequest, string)

Constructs a new ExportDocuments request.

Declaration
public ExportDocumentsRequest(IClientService service, GoogleFirestoreAdminV1beta2ExportDocumentsRequest body, string name)
Parameters
Type Name Description
IClientService service
GoogleFirestoreAdminV1beta2ExportDocumentsRequest body
string name

Properties

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

Name

Database to export. Should be of the form: projects/{project_id}/databases/{database_id}.

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

Methods

GetBody()

Returns the body of the request.

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

InitParameters()

Initializes ExportDocuments parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements