Google Cloud Redis Cluster V1 Client - Class BackupClusterRequest (0.4.0)

Reference documentation and code samples for the Google Cloud Redis Cluster V1 Client class BackupClusterRequest.

Request for [BackupCluster].

Generated from protobuf message google.cloud.redis.cluster.v1.BackupClusterRequest

Namespace

Google \ Cloud \ Redis \ Cluster \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP 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 Cluster UID] is used.

getName

Required. Redis cluster resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

Returns
Type	Description
`string`

setName

Required. Redis cluster resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP 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 Cluster 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 Cluster UID] is used.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameter
Name	Description
`name`	`string` Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region. Please see CloudRedisClusterClient::clusterName() for help formatting this field.

Returns
Type	Description
`BackupClusterRequest`