Google Cloud Redis Cluster V1 Client - Class Cluster (0.3.0)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Required. 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`	`Google\Protobuf\Timestamp` Output only. The timestamp associated with the cluster creation request.
`↳ 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` Required. Number of shards for the Redis cluster.
`↳ psc_configs`	`array<Google\Cloud\Redis\Cluster\V1\PscConfig>` Required. 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<Google\Cloud\Redis\Cluster\V1\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<Google\Cloud\Redis\Cluster\V1\PscConnection>` Output only. PSC connections for discovery of the cluster topology and accessing the cluster.
`↳ state_info`	`Google\Cloud\Redis\Cluster\V1\Cluster\StateInfo` Output only. Additional information about the current state of the cluster.
`↳ 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`	`Google\Cloud\Redis\Cluster\V1\ClusterPersistenceConfig` Optional. Persistence config (RDB, AOF) for the cluster.
`↳ 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`	`Google\Cloud\Redis\Cluster\V1\ZoneDistributionConfig` Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region.
`↳ deletion_protection_enabled`	`bool` Optional. The delete operation will fail when the value is set to true.

getName

Required. Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}

Returns
Type	Description
`string`

setName

Required. Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. The timestamp associated with the cluster creation request.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. The timestamp associated with the cluster creation request.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getState

Output only. The current state of this cluster.

Can be CREATING, READY, UPDATING, DELETING and SUSPENDED

Returns
Type	Description
`int`

setState

Output only. The current state of this cluster.

Can be CREATING, READY, UPDATING, DELETING and SUSPENDED

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getUid

Output only. System assigned, unique identifier for the cluster.

Returns
Type	Description
`string`

setUid

Output only. System assigned, unique identifier for the cluster.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getReplicaCount

Optional. The number of replica nodes per shard.

Returns
Type	Description
`int`

hasReplicaCount

clearReplicaCount

setReplicaCount

Optional. The number of replica nodes per shard.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getAuthorizationMode

Optional. The authorization mode of the Redis cluster.

If not provided, auth feature is disabled for the cluster.

Returns
Type	Description
`int`

setAuthorizationMode

Optional. The authorization mode of the Redis cluster.

If not provided, auth feature is disabled for the cluster.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getTransitEncryptionMode

Optional. The in-transit encryption for the Redis cluster.

If not provided, encryption is disabled for the cluster.

Returns
Type	Description
`int`

setTransitEncryptionMode

Optional. The in-transit encryption for the Redis cluster.

If not provided, encryption is disabled for the cluster.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getSizeGb

Output only. Redis memory size in GB for the entire cluster rounded up to the next integer.

Returns
Type	Description
`int`

hasSizeGb

clearSizeGb

setSizeGb

Output only. Redis memory size in GB for the entire cluster rounded up to the next integer.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getShardCount

Required. Number of shards for the Redis cluster.

Returns
Type	Description
`int`

hasShardCount

clearShardCount

setShardCount

Required. Number of shards for the Redis cluster.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPscConfigs

Required. 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.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setPscConfigs

Parameter
Name	Description
`var`	`array<Google\Cloud\Redis\Cluster\V1\PscConfig>`

Returns
Type	Description
`$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.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setDiscoveryEndpoints

Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.

Parameter
Name	Description
`var`	`array<Google\Cloud\Redis\Cluster\V1\DiscoveryEndpoint>`

Returns
Type	Description
`$this`

getPscConnections

Output only. PSC connections for discovery of the cluster topology and accessing the cluster.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setPscConnections

Output only. PSC connections for discovery of the cluster topology and accessing the cluster.

Parameter
Name	Description
`var`	`array<Google\Cloud\Redis\Cluster\V1\PscConnection>`

Returns
Type	Description
`$this`

getStateInfo

Output only. Additional information about the current state of the cluster.

Returns
Type	Description
`Google\Cloud\Redis\Cluster\V1\Cluster\StateInfo\|null`

hasStateInfo

clearStateInfo

setStateInfo

Output only. Additional information about the current state of the cluster.

Parameter
Name	Description
`var`	`Google\Cloud\Redis\Cluster\V1\Cluster\StateInfo`

Returns
Type	Description
`$this`

getNodeType

Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node.

Returns
Type	Description
`int`

setNodeType

Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPersistenceConfig

Optional. Persistence config (RDB, AOF) for the cluster.

Returns
Type	Description
`Google\Cloud\Redis\Cluster\V1\ClusterPersistenceConfig\|null`

hasPersistenceConfig

clearPersistenceConfig

setPersistenceConfig

Optional. Persistence config (RDB, AOF) for the cluster.

Parameter
Name	Description
`var`	`Google\Cloud\Redis\Cluster\V1\ClusterPersistenceConfig`

Returns
Type	Description
`$this`

getRedisConfigs

Optional. Key/Value pairs of customer overrides for mutable Redis Configs

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setRedisConfigs

Optional. Key/Value pairs of customer overrides for mutable Redis Configs

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getPreciseSizeGb

Output only. Precise value of redis memory size in GB for the entire cluster.

Returns
Type	Description
`float`

hasPreciseSizeGb

clearPreciseSizeGb

setPreciseSizeGb

Output only. Precise value of redis memory size in GB for the entire cluster.

Parameter
Name	Description
`var`	`float`

Returns
Type	Description
`$this`

getZoneDistributionConfig

Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region.

Returns
Type	Description
`Google\Cloud\Redis\Cluster\V1\ZoneDistributionConfig\|null`

hasZoneDistributionConfig

clearZoneDistributionConfig

setZoneDistributionConfig

Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region.

Parameter
Name	Description
`var`	`Google\Cloud\Redis\Cluster\V1\ZoneDistributionConfig`

Returns
Type	Description
`$this`

getDeletionProtectionEnabled

Optional. The delete operation will fail when the value is set to true.

Returns
Type	Description
`bool`

hasDeletionProtectionEnabled

clearDeletionProtectionEnabled

setDeletionProtectionEnabled

Optional. The delete operation will fail when the value is set to true.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`