Constructor
new Cluster(propertiesopt)
Constructs a new Cluster.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.redis.cluster.v1beta1.ICluster |
<optional> |
Properties to set |
- Implements:
-
- ICluster
Classes
Members
_deletionProtectionEnabled
Cluster _deletionProtectionEnabled.
_preciseSizeGb
Cluster _preciseSizeGb.
_replicaCount
Cluster _replicaCount.
_shardCount
Cluster _shardCount.
_sizeGb
Cluster _sizeGb.
authorizationMode
Cluster authorizationMode.
createTime
Cluster createTime.
deletionProtectionEnabled
Cluster deletionProtectionEnabled.
discoveryEndpoints
Cluster discoveryEndpoints.
name
Cluster name.
nodeType
Cluster nodeType.
persistenceConfig
Cluster persistenceConfig.
preciseSizeGb
Cluster preciseSizeGb.
pscConfigs
Cluster pscConfigs.
pscConnections
Cluster pscConnections.
redisConfigs
Cluster redisConfigs.
replicaCount
Cluster replicaCount.
shardCount
Cluster shardCount.
sizeGb
Cluster sizeGb.
state
Cluster state.
stateInfo
Cluster stateInfo.
transitEncryptionMode
Cluster transitEncryptionMode.
uid
Cluster uid.
zoneDistributionConfig
Cluster zoneDistributionConfig.
State
State enum.
Properties:
| Name | Type | Description |
|---|---|---|
STATE_UNSPECIFIED |
number |
STATE_UNSPECIFIED value |
CREATING |
number |
CREATING value |
ACTIVE |
number |
ACTIVE value |
UPDATING |
number |
UPDATING value |
DELETING |
number |
DELETING value |
Methods
toJSON() → {Object.<string, *>}
Converts this Cluster to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.redis.cluster.v1beta1.Cluster}
Creates a new Cluster instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.redis.cluster.v1beta1.ICluster |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.redis.cluster.v1beta1.Cluster |
Cluster instance |
(static) decode(reader, lengthopt) → {google.cloud.redis.cluster.v1beta1.Cluster}
Decodes a Cluster message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.cloud.redis.cluster.v1beta1.Cluster |
Cluster |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.cloud.redis.cluster.v1beta1.Cluster}
Decodes a Cluster message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.cloud.redis.cluster.v1beta1.Cluster |
Cluster |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified Cluster message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.redis.cluster.v1beta1.ICluster |
Cluster message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified Cluster message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.redis.cluster.v1beta1.ICluster |
Cluster message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.cloud.redis.cluster.v1beta1.Cluster}
Creates a Cluster message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.cloud.redis.cluster.v1beta1.Cluster |
Cluster |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for Cluster
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a Cluster message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.redis.cluster.v1beta1.Cluster |
Cluster |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a Cluster message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|