Google Cloud Memorystore V1 Client - Class BackupInstanceRequest (0.4.2)

Reference documentation and code samples for the Google Cloud Memorystore V1 Client class BackupInstanceRequest.

Request for [BackupInstance].

Generated from protobuf message google.cloud.memorystore.v1.BackupInstanceRequest

Namespace

Google \ Cloud \ Memorystore \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. Instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a Google Cloud region.

↳ ttl Google\Protobuf\Duration

Optional. TTL for the backup to expire. Value range is 1 day to 100 years. If not specified, the default value is 100 years.

↳ backup_id string

Optional. The id of the backup to be created. If not specified, the default value ([YYYYMMDDHHMMSS]_[Shortened Instance UID] is used.

getName

Required. Instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a Google Cloud region.

Returns
Type Description
string

setName

Required. Instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a Google Cloud region.

Parameter
Name Description
var string
Returns
Type Description
$this

getTtl

Optional. TTL for the backup to expire. Value range is 1 day to 100 years.

If not specified, the default value is 100 years.

Returns
Type Description
Google\Protobuf\Duration|null

hasTtl

clearTtl

setTtl

Optional. TTL for the backup to expire. Value range is 1 day to 100 years.

If not specified, the default value is 100 years.

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

getBackupId

Optional. The id of the backup to be created. If not specified, the default value ([YYYYMMDDHHMMSS]_[Shortened Instance UID] is used.

Returns
Type Description
string

hasBackupId

clearBackupId

setBackupId

Optional. The id of the backup to be created. If not specified, the default value ([YYYYMMDDHHMMSS]_[Shortened Instance UID] is used.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. Instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a Google Cloud region. Please see MemorystoreClient::instanceName() for help formatting this field.

Returns
Type Description
BackupInstanceRequest