Cloud Firestore V1 Client - Class GetBackupRequest (1.44.1)

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

The request for FirestoreAdmin.GetBackup.

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

Namespace

Google \ Cloud \ Firestore \ Admin \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. Name of the backup to fetch. Format is projects/{project}/locations/{location}/backups/{backup}.

getName

Required. Name of the backup to fetch.

Format is projects/{project}/locations/{location}/backups/{backup}.

Returns
Type Description
string

setName

Required. Name of the backup to fetch.

Format is projects/{project}/locations/{location}/backups/{backup}.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. Name of the backup to fetch.

Format is projects/{project}/locations/{location}/backups/{backup}. Please see Google\Cloud\Firestore\Admin\V1\FirestoreAdminClient::backupName() for help formatting this field.

Returns
Type Description
Google\Cloud\Firestore\Admin\V1\GetBackupRequest