Class GoogleFirestoreAdminV1ExportDocumentsRequest

The request for FirestoreAdmin.ExportDocuments.

Inheritance

object

GoogleFirestoreAdminV1ExportDocumentsRequest

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Firestore.v1.Data

Assembly: Google.Apis.Firestore.v1.dll

Syntax

public class GoogleFirestoreAdminV1ExportDocumentsRequest : IDirectResponseSchema

Properties

CollectionIds

Which collection IDs to export. Unspecified means all collections. Each collection ID in this list must be unique.

Declaration

[JsonProperty("collectionIds")]
public virtual IList<string> CollectionIds { get; set; }

Property Value

Type	Description
IList<string>

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

NamespaceIds

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.

Declaration

[JsonProperty("namespaceIds")]
public virtual IList<string> NamespaceIds { get; set; }

Property Value

Type	Description
IList<string>

OutputUriPrefix

The output URI. Currently only supports Google Cloud Storage URIs of the form: gs://BUCKET_NAME[/NAMESPACE_PATH], where BUCKET_NAME is the name of the Google Cloud Storage bucket and NAMESPACE_PATH is an optional Google Cloud Storage namespace path. When choosing a name, be sure to consider Google Cloud Storage naming guidelines: https://cloud.google.com/storage/docs/naming. If the URI is a bucket (without a namespace path), a prefix will be generated based on the start time.

Declaration

[JsonProperty("outputUriPrefix")]
public virtual string OutputUriPrefix { get; set; }

Property Value

Type	Description
string

SnapshotTime

object representation of SnapshotTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use SnapshotTimeDateTimeOffset instead.")]
public virtual object SnapshotTime { get; set; }

Property Value

Type	Description
object

SnapshotTimeDateTimeOffset

DateTimeOffset representation of SnapshotTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? SnapshotTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

SnapshotTimeRaw

The timestamp that corresponds to the version of the database to be exported. The timestamp must be in the past, rounded to the minute and not older than earliestVersionTime. If specified, then the exported documents will represent a consistent view of the database at the provided time. Otherwise, there are no guarantees about the consistency of the exported documents.

Declaration

[JsonProperty("snapshotTime")]
public virtual string SnapshotTimeRaw { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema