Google Cloud Redis Cluster V1 Client - Class ZoneDistributionConfig (0.13.0)

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

Zone distribution config for allocation of cluster resources.

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

Namespace

Google \ Cloud \ Redis \ Cluster \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ mode int

Optional. The mode of zone distribution. Defaults to MULTI_ZONE, when not specified.

↳ zone string

Optional. When SINGLE ZONE distribution is selected, zone field would be used to allocate all resources in that zone. This is not applicable to MULTI_ZONE, and would be ignored for MULTI_ZONE clusters.

↳ zones string[]

Optional. Specify the zones of a multi-zone cluster where Redis Cluster allocates resources. This flag isn't applicable for single-zone clusters.

↳ active_zones string[]

Output only. The exact list of zones where the cluster currently has active VMs.

getMode

Optional. The mode of zone distribution. Defaults to MULTI_ZONE, when not specified.

Returns
Type Description
int Enum of type ZoneDistributionMode.

setMode

Optional. The mode of zone distribution. Defaults to MULTI_ZONE, when not specified.

Parameter
Name Description
var int

Enum of type ZoneDistributionMode.

Returns
Type Description
$this

getZone

Optional. When SINGLE ZONE distribution is selected, zone field would be used to allocate all resources in that zone. This is not applicable to MULTI_ZONE, and would be ignored for MULTI_ZONE clusters.

Returns
Type Description
string

setZone

Optional. When SINGLE ZONE distribution is selected, zone field would be used to allocate all resources in that zone. This is not applicable to MULTI_ZONE, and would be ignored for MULTI_ZONE clusters.

Parameter
Name Description
var string
Returns
Type Description
$this

getZones

Optional. Specify the zones of a multi-zone cluster where Redis Cluster allocates resources. This flag isn't applicable for single-zone clusters.

Returns
Type Description
Google\Protobuf\RepeatedField<string>

setZones

Optional. Specify the zones of a multi-zone cluster where Redis Cluster allocates resources. This flag isn't applicable for single-zone clusters.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getActiveZones

Output only. The exact list of zones where the cluster currently has active VMs.

Returns
Type Description
Google\Protobuf\RepeatedField<string>

setActiveZones

Output only. The exact list of zones where the cluster currently has active VMs.

Parameter
Name Description
var string[]
Returns
Type Description
$this