Reference documentation and code samples for the Google Cloud Redis Cluster V1 Client class Cluster.
A cluster instance.
Generated from protobuf message google.cloud.redis.cluster.v1.Cluster
Namespace
Google \ Cloud \ Redis \ Cluster \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ gcs_source
Cluster\GcsBackupSource
Optional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. Read permission is required to import from the provided Cloud Storage objects.
↳ managed_backup_source
↳ name
string
Required. Identifier. Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}
↳ create_time
↳ state
int
Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED
↳ uid
string
Output only. System assigned, unique identifier for the cluster.
↳ replica_count
int
Optional. The number of replica nodes per shard.
↳ authorization_mode
int
Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.
↳ transit_encryption_mode
int
Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster.
↳ size_gb
int
Output only. Redis memory size in GB for the entire cluster rounded up to the next integer.
↳ shard_count
int
Optional. Number of shards for the Redis cluster.
↳ psc_configs
array< PscConfig
>
Optional. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.
↳ discovery_endpoints
array< DiscoveryEndpoint
>
Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.
↳ psc_connections
array< PscConnection
>
Output only. The list of PSC connections that are auto-created through service connectivity automation.
↳ state_info
↳ node_type
int
Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node.
↳ persistence_config
↳ redis_configs
array| Google\Protobuf\Internal\MapField
Optional. Key/Value pairs of customer overrides for mutable Redis Configs
↳ precise_size_gb
float
Output only. Precise value of redis memory size in GB for the entire cluster.
↳ zone_distribution_config
ZoneDistributionConfig
Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region.
↳ cross_cluster_replication_config
↳ deletion_protection_enabled
bool
Optional. The delete operation will fail when the value is set to true.
↳ maintenance_policy
ClusterMaintenancePolicy
Optional. ClusterMaintenancePolicy determines when to allow or deny updates.
↳ maintenance_schedule
ClusterMaintenanceSchedule
Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule.
↳ psc_service_attachments
↳ cluster_endpoints
↳ backup_collection
string
Optional. Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}
↳ kms_key
string
Optional. The KMS key used to encrypt the at-rest data of the cluster.
↳ automated_backup_config
↳ encryption_info
getGcsSource
Optional. Backups stored in Cloud Storage buckets.
The Cloud Storage buckets need to be the same region as the clusters. Read permission is required to import from the provided Cloud Storage objects.
hasGcsSource
setGcsSource
Optional. Backups stored in Cloud Storage buckets.
The Cloud Storage buckets need to be the same region as the clusters. Read permission is required to import from the provided Cloud Storage objects.
$this
getManagedBackupSource
Optional. Backups generated and managed by memorystore service.
hasManagedBackupSource
setManagedBackupSource
Optional. Backups generated and managed by memorystore service.
$this
getName
Required. Identifier. Unique name of the resource in this scope including
project and location using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}
string
setName
Required. Identifier. Unique name of the resource in this scope including
project and location using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}
var
string
$this
getCreateTime
Output only. The timestamp associated with the cluster creation request.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The timestamp associated with the cluster creation request.
$this
getState
Output only. The current state of this cluster.
Can be CREATING, READY, UPDATING, DELETING and SUSPENDED
int
setState
Output only. The current state of this cluster.
Can be CREATING, READY, UPDATING, DELETING and SUSPENDED
var
int
$this
getUid
Output only. System assigned, unique identifier for the cluster.
string
setUid
Output only. System assigned, unique identifier for the cluster.
var
string
$this
getReplicaCount
Optional. The number of replica nodes per shard.
int
hasReplicaCount
clearReplicaCount
setReplicaCount
Optional. The number of replica nodes per shard.
var
int
$this
getAuthorizationMode
Optional. The authorization mode of the Redis cluster.
If not provided, auth feature is disabled for the cluster.
int
setAuthorizationMode
Optional. The authorization mode of the Redis cluster.
If not provided, auth feature is disabled for the cluster.
var
int
$this
getTransitEncryptionMode
Optional. The in-transit encryption for the Redis cluster.
If not provided, encryption is disabled for the cluster.
int
setTransitEncryptionMode
Optional. The in-transit encryption for the Redis cluster.
If not provided, encryption is disabled for the cluster.
var
int
$this
getSizeGb
Output only. Redis memory size in GB for the entire cluster rounded up to the next integer.
int
hasSizeGb
clearSizeGb
setSizeGb
Output only. Redis memory size in GB for the entire cluster rounded up to the next integer.
var
int
$this
getShardCount
Optional. Number of shards for the Redis cluster.
int
hasShardCount
clearShardCount
setShardCount
Optional. Number of shards for the Redis cluster.
var
int
$this
getPscConfigs
Optional. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.
setPscConfigs
Optional. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.
$this
getDiscoveryEndpoints
Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.
setDiscoveryEndpoints
Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.
$this
getPscConnections
Output only. The list of PSC connections that are auto-created through service connectivity automation.
setPscConnections
Output only. The list of PSC connections that are auto-created through service connectivity automation.
$this
getStateInfo
Output only. Additional information about the current state of the cluster.
hasStateInfo
clearStateInfo
setStateInfo
Output only. Additional information about the current state of the cluster.
$this
getNodeType
Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node.
int
setNodeType
Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node.
var
int
$this
getPersistenceConfig
Optional. Persistence config (RDB, AOF) for the cluster.
hasPersistenceConfig
clearPersistenceConfig
setPersistenceConfig
Optional. Persistence config (RDB, AOF) for the cluster.
$this
getRedisConfigs
Optional. Key/Value pairs of customer overrides for mutable Redis Configs
setRedisConfigs
Optional. Key/Value pairs of customer overrides for mutable Redis Configs
$this
getPreciseSizeGb
Output only. Precise value of redis memory size in GB for the entire cluster.
float
hasPreciseSizeGb
clearPreciseSizeGb
setPreciseSizeGb
Output only. Precise value of redis memory size in GB for the entire cluster.
var
float
$this
getZoneDistributionConfig
Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region.
hasZoneDistributionConfig
clearZoneDistributionConfig
setZoneDistributionConfig
Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region.
$this
getCrossClusterReplicationConfig
Optional. Cross cluster replication config.
hasCrossClusterReplicationConfig
clearCrossClusterReplicationConfig
setCrossClusterReplicationConfig
Optional. Cross cluster replication config.
$this
getDeletionProtectionEnabled
Optional. The delete operation will fail when the value is set to true.
bool
hasDeletionProtectionEnabled
clearDeletionProtectionEnabled
setDeletionProtectionEnabled
Optional. The delete operation will fail when the value is set to true.
var
bool
$this
getMaintenancePolicy
Optional. ClusterMaintenancePolicy determines when to allow or deny updates.
hasMaintenancePolicy
clearMaintenancePolicy
setMaintenancePolicy
Optional. ClusterMaintenancePolicy determines when to allow or deny updates.
$this
getMaintenanceSchedule
Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule.
hasMaintenanceSchedule
clearMaintenanceSchedule
setMaintenanceSchedule
Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule.
$this
getPscServiceAttachments
Output only. Service attachment details to configure Psc connections
setPscServiceAttachments
Output only. Service attachment details to configure Psc connections
$this
getClusterEndpoints
Optional. A list of cluster enpoints.
setClusterEndpoints
Optional. A list of cluster enpoints.
$this
getBackupCollection
Optional. Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}
string
hasBackupCollection
clearBackupCollection
setBackupCollection
Optional. Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}
var
string
$this
getKmsKey
Optional. The KMS key used to encrypt the at-rest data of the cluster.
string
hasKmsKey
clearKmsKey
setKmsKey
Optional. The KMS key used to encrypt the at-rest data of the cluster.
var
string
$this
getAutomatedBackupConfig
Optional. The automated backup config for the cluster.
hasAutomatedBackupConfig
clearAutomatedBackupConfig
setAutomatedBackupConfig
Optional. The automated backup config for the cluster.
$this
getEncryptionInfo
Output only. Encryption information of the data at rest of the cluster.
hasEncryptionInfo
clearEncryptionInfo
setEncryptionInfo
Output only. Encryption information of the data at rest of the cluster.
$this
getImportSources
string
