Cloud Firestore V1 Client - Class ListBackupsRequest (1.45.0)

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

The request for FirestoreAdmin.ListBackups.

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

Namespace

Google \ Cloud \ Firestore \ Admin \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The location to list backups from. Format is projects/{project}/locations/{location}. Use {location} = '-' to list backups from all locations for the given project. This allows listing backups from a single location or from all locations.

getParent

Required. The location to list backups from.

Format is projects/{project}/locations/{location}. Use {location} = '-' to list backups from all locations for the given project. This allows listing backups from a single location or from all locations.

Returns
Type Description
string

setParent

Required. The location to list backups from.

Format is projects/{project}/locations/{location}. Use {location} = '-' to list backups from all locations for the given project. This allows listing backups from a single location or from all locations.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The location to list backups from.

Format is projects/{project}/locations/{location}. Use {location} = '-' to list backups from all locations for the given project. This allows listing backups from a single location or from all locations. Please see Google\Cloud\Firestore\Admin\V1\FirestoreAdminClient::locationName() for help formatting this field.
Returns
Type Description
Google\Cloud\Firestore\Admin\V1\ListBackupsRequest