Reference documentation and code samples for the Google Cloud Redis Cluster V1 Client class Backup.
Backup of a cluster.
Generated from protobuf message google.cloud.redis.cluster.v1.Backup
Namespace
Google \ Cloud \ Redis \ Cluster \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. Full resource path of the backup. the last part of the name is the backup id with the following format: [YYYYMMDDHHMMSS]_[Shorted Cluster UID] OR customer specified while backup cluster. Example: 20240515123000_1234 |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time when the backup was created. |
↳ cluster |
string
Output only. Cluster resource path of this backup. |
↳ cluster_uid |
string
Output only. Cluster uid of this backup. |
↳ total_size_bytes |
int|string
Output only. Total size of the backup in bytes. |
↳ expire_time |
Google\Protobuf\Timestamp
Output only. The time when the backup will expire. |
↳ engine_version |
string
Output only. redis-7.2, valkey-7.5 |
↳ backup_files |
array<BackupFile>
Output only. List of backup files of the backup. |
↳ node_type |
int
Output only. Node type of the cluster. |
↳ replica_count |
int
Output only. Number of replicas for the cluster. |
↳ shard_count |
int
Output only. Number of shards for the cluster. |
↳ backup_type |
int
Output only. Type of the backup. |
↳ state |
int
Output only. State of the backup. |
↳ encryption_info |
EncryptionInfo
Output only. Encryption information of the backup. |
↳ uid |
string
Output only. System assigned unique identifier of the backup. |
getName
Identifier. Full resource path of the backup. the last part of the name is the backup id with the following format: [YYYYMMDDHHMMSS]_[Shorted Cluster UID] OR customer specified while backup cluster. Example: 20240515123000_1234
Returns | |
---|---|
Type | Description |
string |
setName
Identifier. Full resource path of the backup. the last part of the name is the backup id with the following format: [YYYYMMDDHHMMSS]_[Shorted Cluster UID] OR customer specified while backup cluster. Example: 20240515123000_1234
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getCreateTime
Output only. The time when the backup was created.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time when the backup was created.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getCluster
Output only. Cluster resource path of this backup.
Returns | |
---|---|
Type | Description |
string |
setCluster
Output only. Cluster resource path of this backup.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getClusterUid
Output only. Cluster uid of this backup.
Returns | |
---|---|
Type | Description |
string |
setClusterUid
Output only. Cluster uid of this backup.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getTotalSizeBytes
Output only. Total size of the backup in bytes.
Returns | |
---|---|
Type | Description |
int|string |
setTotalSizeBytes
Output only. Total size of the backup in bytes.
Parameter | |
---|---|
Name | Description |
var |
int|string
|
Returns | |
---|---|
Type | Description |
$this |
getExpireTime
Output only. The time when the backup will expire.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasExpireTime
clearExpireTime
setExpireTime
Output only. The time when the backup will expire.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getEngineVersion
Output only. redis-7.2, valkey-7.5
Returns | |
---|---|
Type | Description |
string |
setEngineVersion
Output only. redis-7.2, valkey-7.5
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getBackupFiles
Output only. List of backup files of the backup.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setBackupFiles
Output only. List of backup files of the backup.
Parameter | |
---|---|
Name | Description |
var |
array<BackupFile>
|
Returns | |
---|---|
Type | Description |
$this |
getNodeType
Output only. Node type of the cluster.
Returns | |
---|---|
Type | Description |
int |
setNodeType
Output only. Node type of the cluster.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getReplicaCount
Output only. Number of replicas for the cluster.
Returns | |
---|---|
Type | Description |
int |
setReplicaCount
Output only. Number of replicas for the cluster.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getShardCount
Output only. Number of shards for the cluster.
Returns | |
---|---|
Type | Description |
int |
setShardCount
Output only. Number of shards for the cluster.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getBackupType
Output only. Type of the backup.
Returns | |
---|---|
Type | Description |
int |
setBackupType
Output only. Type of the backup.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getState
Output only. State of the backup.
Returns | |
---|---|
Type | Description |
int |
setState
Output only. State of the backup.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getEncryptionInfo
Output only. Encryption information of the backup.
Returns | |
---|---|
Type | Description |
EncryptionInfo|null |
hasEncryptionInfo
clearEncryptionInfo
setEncryptionInfo
Output only. Encryption information of the backup.
Parameter | |
---|---|
Name | Description |
var |
EncryptionInfo
|
Returns | |
---|---|
Type | Description |
$this |
getUid
Output only. System assigned unique identifier of the backup.
Returns | |
---|---|
Type | Description |
string |
setUid
Output only. System assigned unique identifier of the backup.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |