Firestore Admin v1 API - Class ImportDocumentsRequest (3.6.0)

public sealed class ImportDocumentsRequest : IMessage<ImportDocumentsRequest>, IEquatable<ImportDocumentsRequest>, IDeepCloneable<ImportDocumentsRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Firestore Admin v1 API class ImportDocumentsRequest.

The request for [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1.FirestoreAdmin.ImportDocuments].

Inheritance

object > ImportDocumentsRequest

Implements

IMessage ImportDocumentsRequest, IEquatable ImportDocumentsRequest, IDeepCloneable ImportDocumentsRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Constructors

ImportDocumentsRequest()

public ImportDocumentsRequest()

ImportDocumentsRequest(ImportDocumentsRequest)

public ImportDocumentsRequest(ImportDocumentsRequest other)

Parameter
Name	Description
`other`	`ImportDocumentsRequest`

Properties

CollectionIds

public RepeatedField<string> CollectionIds { get; }

Which collection ids to import. Unspecified means all collections included in the import.

Property Value
Type	Description
`RepeatedFieldstring`

DatabaseName

public DatabaseName DatabaseName { get; set; }

DatabaseName-typed view over the Name resource name property.

Property Value
Type	Description
`DatabaseName`

InputUriPrefix

public string InputUriPrefix { get; set; }

Location of the exported files. This must match the output_uri_prefix of an ExportDocumentsResponse from an export that has completed successfully. See: [google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix][google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix].

Property Value
Type	Description
`string`

Name

public string Name { get; set; }

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

Property Value
Type	Description
`string`

NamespaceIds

public RepeatedField<string> NamespaceIds { get; }

An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces.

An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.

Property Value
Type	Description
`RepeatedFieldstring`