Google Cloud Filestore V1 Client - Class CreateBackupRequest (2.0.0-RC1)

Reference documentation and code samples for the Google Cloud Filestore V1 Client class CreateBackupRequest.

CreateBackupRequest creates a backup.

Generated from protobuf message google.cloud.filestore.v1.CreateBackupRequest

Namespace

Google \ Cloud \ Filestore \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. The backup's project and location, in the format projects/{project_number}/locations/{location}. In Filestore, backup locations map to Google Cloud regions, for example us-west1.
↳ backup Google\Cloud\Filestore\V1\Backup

Required. A backup resource
↳ backup_id string

Required. The ID to use for the backup. The ID must be unique within the specified project and location. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.

getParent

Required. The backup's project and location, in the format projects/{project_number}/locations/{location}. In Filestore, backup locations map to Google Cloud regions, for example us-west1.

Returns
Type Description
string

setParent

Required. The backup's project and location, in the format projects/{project_number}/locations/{location}. In Filestore, backup locations map to Google Cloud regions, for example us-west1.

Parameter
Name Description
var string
Returns
Type Description
$this

getBackup

Required. A backup resource

Returns
Type Description
Google\Cloud\Filestore\V1\Backup|null

hasBackup

clearBackup

setBackup

Required. A backup resource

Parameter
Name Description
var Google\Cloud\Filestore\V1\Backup
Returns
Type Description
$this

getBackupId

Required. The ID to use for the backup.

The ID must be unique within the specified project and location. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.

Returns
Type Description
string

setBackupId

Required. The ID to use for the backup.

The ID must be unique within the specified project and location. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The backup's project and location, in the format projects/{project_number}/locations/{location}. In Filestore, backup locations map to Google Cloud regions, for example us-west1. Please see Google\Cloud\Filestore\V1\CloudFilestoreManagerClient::locationName() for help formatting this field.
backup Google\Cloud\Filestore\V1\Backup

Required. A backup resource
backupId string

Required. The ID to use for the backup. The ID must be unique within the specified project and location.

This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.
Returns
Type Description
Google\Cloud\Filestore\V1\CreateBackupRequest