Cloud Firestore V1 Client - Class ExportDocumentsRequest (1.39.0)

Reference documentation and code samples for the Cloud Firestore V1 Client class ExportDocumentsRequest.

The request for FirestoreAdmin.ExportDocuments.

Generated from protobuf message google.firestore.admin.v1.ExportDocumentsRequest

Namespace

Google \ Cloud \ Firestore \ Admin \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Required. Database to export. Should be of the form: `projects/{project_id}/databases/{database_id}`.
`↳ collection_ids`	`array` Which collection ids to export. Unspecified means all collections.
`↳ output_uri_prefix`	`string` 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.
`↳ namespace_ids`	`array` Unspecified means 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.
`↳ snapshot_time`	`Google\Protobuf\Timestamp` 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.

getName

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

Returns
Type	Description
`string`

setName

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCollectionIds

Which collection ids to export. Unspecified means all collections.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setCollectionIds

Which collection ids to export. Unspecified means all collections.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getOutputUriPrefix

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.

Returns
Type	Description
`string`

setOutputUriPrefix

If the URI is a bucket (without a namespace path), a prefix will be generated based on the start time.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getNamespaceIds

Unspecified means 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.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setNamespaceIds

Unspecified means all namespaces. This is the preferred usage for databases that don't use namespaces.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getSnapshotTime

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.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasSnapshotTime

clearSnapshotTime

setSnapshotTime

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.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

static::build

Parameter
Name	Description
`name`	`string` Required. Database to export. Should be of the form: `projects/{project_id}/databases/{database_id}`. Please see Google\Cloud\Firestore\Admin\V1\FirestoreAdminClient::databaseName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\Firestore\Admin\V1\ExportDocumentsRequest`