Show / Hide Table of Contents

Class ProjectsResource.DatabasesResource.ImportDocumentsRequest

Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.

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

Constructors

ImportDocumentsRequest(IClientService, GoogleFirestoreAdminV1ImportDocumentsRequest, string)

Constructs a new ImportDocuments request.

Declaration
public ImportDocumentsRequest(IClientService service, GoogleFirestoreAdminV1ImportDocumentsRequest body, string name)
Parameters
Type Name Description
IClientService service
GoogleFirestoreAdminV1ImportDocumentsRequest body
string name

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Firestore.v1.Data.GoogleLongrunningOperation>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Firestore.v1.Data.GoogleLongrunningOperation>.MethodName

Name

Required. Database to import into. 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
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Firestore.v1.Data.GoogleLongrunningOperation>.RestPath

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.v1.Data.GoogleLongrunningOperation>.GetBody()

InitParameters()

Initializes ImportDocuments parameter list.

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

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In This Article
Back to top Generated by DocFX