Reference documentation and code samples for the Google Cloud Redis Cluster V1 Client class BackupClusterRequest.
Request for [BackupCluster].
Generated from protobuf messagegoogle.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}wherelocation_idrefers to a GCP region.
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}wherelocation_idrefers 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}wherelocation_idrefers 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.
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}wherelocation_idrefers to a GCP region. Please seeCloudRedisClusterClient::clusterName()for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Redis Cluster V1 Client - Class BackupClusterRequest (0.5.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.5.1 (latest)](/php/docs/reference/cloud-redis-cluster/latest/V1.BackupClusterRequest)\n- [0.5.0](/php/docs/reference/cloud-redis-cluster/0.5.0/V1.BackupClusterRequest)\n- [0.4.1](/php/docs/reference/cloud-redis-cluster/0.4.1/V1.BackupClusterRequest)\n- [0.3.2](/php/docs/reference/cloud-redis-cluster/0.3.2/V1.BackupClusterRequest)\n- [0.2.5](/php/docs/reference/cloud-redis-cluster/0.2.5/V1.BackupClusterRequest)\n- [0.1.0](/php/docs/reference/cloud-redis-cluster/0.1.0/V1.BackupClusterRequest) \nReference documentation and code samples for the Google Cloud Redis Cluster V1 Client class BackupClusterRequest.\n\nRequest for \\[BackupCluster\\].\n\nGenerated from protobuf message `google.cloud.redis.cluster.v1.BackupClusterRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Redis \\\\ Cluster \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. Redis cluster resource name using the form:\n`projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`\nwhere `location_id` refers to a GCP region.\n\n### setName\n\nRequired. Redis cluster resource name using the form:\n`projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`\nwhere `location_id` refers to a GCP region.\n\n### getTtl\n\nOptional. TTL for the backup to expire. Value range is 1 day to 100 years.\n\nIf not specified, the default value is 100 years.\n\n### hasTtl\n\n### clearTtl\n\n### setTtl\n\nOptional. TTL for the backup to expire. Value range is 1 day to 100 years.\n\nIf not specified, the default value is 100 years.\n\n### getBackupId\n\nOptional. The id of the backup to be created. If not specified, the\ndefault value (\\[YYYYMMDDHHMMSS\\]_\\[Shortened Cluster UID\\] is used.\n\n### hasBackupId\n\n### clearBackupId\n\n### setBackupId\n\nOptional. The id of the backup to be created. If not specified, the\ndefault value (\\[YYYYMMDDHHMMSS\\]_\\[Shortened Cluster UID\\] is used.\n\n### static::build"]]
