Cloud Spanner V1 Client - Class UpdateBackupRequest (1.79.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class UpdateBackupRequest.

The request for UpdateBackup.

Generated from protobuf message google.spanner.admin.database.v1.UpdateBackupRequest

Namespace

Google \ Cloud \ Spanner \ Admin \ Database \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ backup Google\Cloud\Spanner\Admin\Database\V1\Backup

Required. The backup to update. backup.name, and the fields to be updated as specified by update_mask are required. Other fields are ignored. Update is only supported for the following fields: * backup.expire_time.

↳ update_mask Google\Protobuf\FieldMask

Required. A mask specifying which fields (e.g. expire_time) in the Backup resource should be updated. This mask is relative to the Backup resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally by clients that do not know about them.

getBackup

Required. The backup to update. backup.name, and the fields to be updated as specified by update_mask are required. Other fields are ignored.

Update is only supported for the following fields:

  • backup.expire_time.
Returns
Type Description
Google\Cloud\Spanner\Admin\Database\V1\Backup|null

hasBackup

clearBackup

setBackup

Required. The backup to update. backup.name, and the fields to be updated as specified by update_mask are required. Other fields are ignored.

Update is only supported for the following fields:

  • backup.expire_time.
Parameter
Name Description
var Google\Cloud\Spanner\Admin\Database\V1\Backup
Returns
Type Description
$this

getUpdateMask

Required. A mask specifying which fields (e.g. expire_time) in the Backup resource should be updated. This mask is relative to the Backup resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally by clients that do not know about them.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. A mask specifying which fields (e.g. expire_time) in the Backup resource should be updated. This mask is relative to the Backup resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally by clients that do not know about them.

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

static::build

Parameters
Name Description
backup Google\Cloud\Spanner\Admin\Database\V1\Backup

Required. The backup to update. backup.name, and the fields to be updated as specified by update_mask are required. Other fields are ignored. Update is only supported for the following fields:

  • backup.expire_time.
updateMask Google\Protobuf\FieldMask

Required. A mask specifying which fields (e.g. expire_time) in the Backup resource should be updated. This mask is relative to the Backup resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally by clients that do not know about them.

Returns
Type Description
Google\Cloud\Spanner\Admin\Database\V1\UpdateBackupRequest