Constructor
new CloudRedisCluster(rpcImpl, requestDelimitedopt, responseDelimitedopt)
Constructs a new CloudRedisCluster service.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
rpcImpl |
$protobuf.RPCImpl |
RPC implementation |
||
requestDelimited |
boolean |
<optional> |
false |
Whether requests are length-delimited |
responseDelimited |
boolean |
<optional> |
false |
Whether responses are length-delimited |
Extends
- $protobuf.rpc.Service
Methods
createCluster(request, callback) → {undefined}
Calls CreateCluster.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.cluster.v1.ICreateClusterRequest |
CreateClusterRequest message or plain object |
callback |
google.cloud.redis.cluster.v1.CloudRedisCluster.CreateClusterCallback |
Node-style callback called with the error, if any, and Operation |
Returns:
| Type | Description |
|---|---|
| undefined |
createCluster(request) → {Promise.<google.longrunning.Operation>}
Calls CreateCluster.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.cluster.v1.ICreateClusterRequest |
CreateClusterRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.longrunning.Operation> |
Promise |
deleteCluster(request, callback) → {undefined}
Calls DeleteCluster.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.cluster.v1.IDeleteClusterRequest |
DeleteClusterRequest message or plain object |
callback |
google.cloud.redis.cluster.v1.CloudRedisCluster.DeleteClusterCallback |
Node-style callback called with the error, if any, and Operation |
Returns:
| Type | Description |
|---|---|
| undefined |
deleteCluster(request) → {Promise.<google.longrunning.Operation>}
Calls DeleteCluster.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.cluster.v1.IDeleteClusterRequest |
DeleteClusterRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.longrunning.Operation> |
Promise |
getCluster(request, callback) → {undefined}
Calls GetCluster.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.cluster.v1.IGetClusterRequest |
GetClusterRequest message or plain object |
callback |
google.cloud.redis.cluster.v1.CloudRedisCluster.GetClusterCallback |
Node-style callback called with the error, if any, and Cluster |
Returns:
| Type | Description |
|---|---|
| undefined |
getCluster(request) → {Promise.<google.cloud.redis.cluster.v1.Cluster>}
Calls GetCluster.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.cluster.v1.IGetClusterRequest |
GetClusterRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.redis.cluster.v1.Cluster> |
Promise |
getClusterCertificateAuthority(request, callback) → {undefined}
Calls GetClusterCertificateAuthority.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.cluster.v1.IGetClusterCertificateAuthorityRequest |
GetClusterCertificateAuthorityRequest message or plain object |
callback |
google.cloud.redis.cluster.v1.CloudRedisCluster.GetClusterCertificateAuthorityCallback |
Node-style callback called with the error, if any, and CertificateAuthority |
Returns:
| Type | Description |
|---|---|
| undefined |
getClusterCertificateAuthority(request) → {Promise.<google.cloud.redis.cluster.v1.CertificateAuthority>}
Calls GetClusterCertificateAuthority.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.cluster.v1.IGetClusterCertificateAuthorityRequest |
GetClusterCertificateAuthorityRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.redis.cluster.v1.CertificateAuthority> |
Promise |
listClusters(request, callback) → {undefined}
Calls ListClusters.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.cluster.v1.IListClustersRequest |
ListClustersRequest message or plain object |
callback |
google.cloud.redis.cluster.v1.CloudRedisCluster.ListClustersCallback |
Node-style callback called with the error, if any, and ListClustersResponse |
Returns:
| Type | Description |
|---|---|
| undefined |
listClusters(request) → {Promise.<google.cloud.redis.cluster.v1.ListClustersResponse>}
Calls ListClusters.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.cluster.v1.IListClustersRequest |
ListClustersRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.redis.cluster.v1.ListClustersResponse> |
Promise |
updateCluster(request, callback) → {undefined}
Calls UpdateCluster.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.cluster.v1.IUpdateClusterRequest |
UpdateClusterRequest message or plain object |
callback |
google.cloud.redis.cluster.v1.CloudRedisCluster.UpdateClusterCallback |
Node-style callback called with the error, if any, and Operation |
Returns:
| Type | Description |
|---|---|
| undefined |
updateCluster(request) → {Promise.<google.longrunning.Operation>}
Calls UpdateCluster.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.cluster.v1.IUpdateClusterRequest |
UpdateClusterRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.longrunning.Operation> |
Promise |
(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {CloudRedisCluster}
Creates new CloudRedisCluster service using the specified rpc implementation.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
rpcImpl |
$protobuf.RPCImpl |
RPC implementation |
||
requestDelimited |
boolean |
<optional> |
false |
Whether requests are length-delimited |
responseDelimited |
boolean |
<optional> |
false |
Whether responses are length-delimited |
Returns:
| Type | Description |
|---|---|
| CloudRedisCluster |
RPC service. Useful where requests and/or responses are streamed. |
Type Definitions
CreateClusterCallback(error, responseopt)
Callback as used by createCluster.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.longrunning.Operation |
<optional> |
Operation |
DeleteClusterCallback(error, responseopt)
Callback as used by deleteCluster.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.longrunning.Operation |
<optional> |
Operation |
GetClusterCallback(error, responseopt)
Callback as used by getCluster.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.redis.cluster.v1.Cluster |
<optional> |
Cluster |
GetClusterCertificateAuthorityCallback(error, responseopt)
Callback as used by getClusterCertificateAuthority.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.redis.cluster.v1.CertificateAuthority |
<optional> |
CertificateAuthority |
ListClustersCallback(error, responseopt)
Callback as used by listClusters.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.redis.cluster.v1.ListClustersResponse |
<optional> |
ListClustersResponse |
UpdateClusterCallback(error, responseopt)
Callback as used by updateCluster.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.longrunning.Operation |
<optional> |
Operation |